From 2cfc418b24fc63183b6f20eb51b4492253e61159 Mon Sep 17 00:00:00 2001 From: TheBoxyBear <15822255+TheBoxyBear@users.noreply.github.com> Date: Thu, 18 Jan 2024 13:01:27 -0500 Subject: [PATCH] Fix api links in articles --- Docs/articles/dynamic-syntax.md | 4 ++-- Docs/articles/events.md | 2 +- Docs/articles/lyrics.md | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/Docs/articles/dynamic-syntax.md b/Docs/articles/dynamic-syntax.md index 87850d4a..ae0f3f9e 100644 --- a/Docs/articles/dynamic-syntax.md +++ b/Docs/articles/dynamic-syntax.md @@ -47,6 +47,6 @@ Track easyCoop = Track.FromFile(path, StandardInstrumentIdentity. Track easyKeys = Track.FromFile(path, InsturmentIdentity.Keys, Difficulty.Easy, , metadata.Formatting); ``` -When setting an instrument, the target is determined by the [InstrumentIdentity](~/api/ChartTools.Instrument.yml#ChartTools_Instrument_InstrumentIdentity) property of the new instrument, which can be overridden using a `with` statement. Similarly, the target difficulty when setting a track is determined by the track's [Difficulty](~/api/ChartTools.Track.html#ChartTools_Track_Difficulty) property, also overridable through `with`. +When setting an instrument, the target is determined by the [InstrumentIdentity](~/api/ChartTools.Instrument.yml#ChartTools_Instrument_InstrumentIdentity) property of the new instrument, which can be overridden using a `with` statement. Similarly, the target difficulty when setting a track is determined by the track's [Difficulty](~/api/ChartTools.Track.yml#ChartTools_Track_Difficulty) property, also overridable through `with`. -> **NOTE**: Unlike when setting an instrument explicitely, the existing identity is used when setting dynamically. This makes it safe to reuse the previous reference after the assignement unless a `with` statement is used. Tracks still need to be re-obtained when using the dynamic syntax as a copy is created to assign its [ParentInstrument](~/api/ChartTools.Track.ymll#ChartTools_Track_ParentInstrument). In cases where a reference to an instrument or track needs to be re-obtained, this reference is passed through as the return of [InstrumentSet.Set](~/api/ChartTools.InstrumentSet.yml#ChartTools_InstrumentSet_Set_ChartTools_StandardInstrument_) and `Instrument.SetTrack`. +> **NOTE**: Unlike when setting an instrument explicitely, the existing identity is used when setting dynamically. This makes it safe to reuse the previous reference after the assignement unless a `with` statement is used. Tracks still need to be re-obtained when using the dynamic syntax as a copy is created to assign its [ParentInstrument](~/api/ChartTools.Track.yml#ChartTools_Track_ParentInstrument). In cases where a reference to an instrument or track needs to be re-obtained, this reference is passed through as the return of [InstrumentSet.Set](~/api/ChartTools.InstrumentSet.yml#ChartTools_InstrumentSet_Set_ChartTools_StandardInstrument_) and `Instrument.SetTrack`. diff --git a/Docs/articles/events.md b/Docs/articles/events.md index 2e8429a2..f77187b2 100644 --- a/Docs/articles/events.md +++ b/Docs/articles/events.md @@ -22,7 +22,7 @@ bool isCrowd = globalEvent.EventType.StartsWith(EventTypeHeaderHelper.Global.Cro bool isCrowd2 = globalEvent.IsCrowdEvent; ``` -Some event types can be modified using predefined arguments. For such values, helpers are provided under the static [EventArgumentHelper](~/api/ChartTools.Events.EventArgumentHelper.html) class. +Some event types can be modified using predefined arguments. For such values, helpers are provided under the static [EventArgumentHelper](~/api/ChartTools.Events.EventArgumentHelper.yml) class. ```c# var globalEvent = new GlobalEvent(0, EventTypeHelper.Global.Lighting, EventArgumentHelper.Global.Lighting.Strobe); diff --git a/Docs/articles/lyrics.md b/Docs/articles/lyrics.md index b645a9d1..ce99ac36 100644 --- a/Docs/articles/lyrics.md +++ b/Docs/articles/lyrics.md @@ -21,7 +21,7 @@ phrase.Syllables.Add(new Syllable(0, new VocalsPitch(3 << 4 | VocalsPitch.D)); > **NOTE**: Clone Hero also supports color data in the text. This is currently not supported in ChartTools and special characters related to color data will appear as part of [DisplayedText](~/api/ChartTools.Lyrics.Syllable.yml#ChartTools_Lyrics_Syllable_DisplayedText). ## Phrases -Unlike other chords, [phrases](~/api/ChartTools.Lyrics.Phrase.yml) define a length and end position in addition to a start position. The end position is driven by the end of the last syllable but can be replaced by setting the `LengthOverride` property. Phrases also define [RawText](~/api/ChartTools.Lyrics.Syllable.yml#ChartTools_Lyrics_Phrase_RawText) and [DisplayedText](~/api/ChartTools.Lyrics.Syllable.yml#ChartTools_Lyrics_Phrase_DisplayedText) properties which combine the text from their syllables. +Unlike other chords, [phrases](~/api/ChartTools.Lyrics.Phrase.yml) define a length and end position in addition to a start position. The end position is driven by the end of the last syllable but can be replaced by setting the [LengthOverride](~/api/ChartTools.Lyrics.Phrase.yml#ChartTools_Lyrics_Phrase_LengthOverride) property. Phrases also define [RawText](~/api/ChartTools.Lyrics.Syllable.yml#ChartTools_Lyrics_Phrase_RawText) and [DisplayedText](~/api/ChartTools.Lyrics.Syllable.yml#ChartTools_Lyrics_Phrase_DisplayedText) properties which combine the text from their syllables. ## Reading and writing vocals Chart files define lyrics through global events that can be converted to a set of phrases. When reading a full song from a chart file, the vocals instrument will be null. To benefit of the more advanced lyrics API, a dummy set of phrases instrument can be generated using the [GetLyrics](~/api/ChartTools.Events.EventExtensions.yml#ChartTools_Events_EventExtensions_GetLyrics_System_Collections_Generic_IEnumerable_ChartTools_Events_GlobalEvent__) extension method.