Class Song

Namespace

ChartTools

Assembly

ChartTools.dll

Song playable in Clone Hero

public class Song

Inheritance

object

Song

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

TempoRescaler.Rescale(Song, float)

Properties

Formatting

Rules defined in song.ini that affect how the song data file is read and written

public FormattingRules Formatting { get; set; }

Property Value

FormattingRules

Remarks

Property summaries provided by Nathan Hurst.

GlobalEvents

List of events common to all instruments

public List<GlobalEvent>? GlobalEvents { get; set; }

Property Value

List<GlobalEvent>

Instruments

Set of all instruments

public InstrumentSet Instruments { get; set; }

Property Value

InstrumentSet

Metadata

Set of information about the song not unrelated to instruments, syncing or events

public Metadata? Metadata { get; set; }

Property Value

Metadata

SyncTrack

Set of markers that define the time signature and tempo

public SyncTrack? SyncTrack { get; set; }

Property Value

SyncTrack

UnknownChartSections

public ChartSection? UnknownChartSections { get; set; }

Property Value

ChartSection

Vocals

public Vocals? Vocals { get; set; }

Property Value

Vocals

Methods

FromDirectory(string, ReadingConfiguration?)

Reads a Song from a directory.

public static Song FromDirectory(string directory, ReadingConfiguration? config = null)

Parameters

directory string

Path of the directory to read from

config ReadingConfiguration

Optional read config

Returns

Song

FromDirectoryAsync(string, ReadingConfiguration?, CancellationToken)

Reads a Song from a directory asynchronously.

public static Task<Song> FromDirectoryAsync(string directory, ReadingConfiguration? config = null, CancellationToken cancellationToken = default)

Parameters

directory string

Path of the directory to read from

config ReadingConfiguration

Optional read config

cancellationToken CancellationToken

Token used for cancellation

Returns

Task<Song>

Remarks

Uses multi-threading to parse song components.

FromFile(string, ReadingConfiguration?, FormattingRules?)

Reads of a Song from a file.

public static Song FromFile(string path, ReadingConfiguration? config = null, FormattingRules? formatting = null)

Parameters

path string

Path of the file to write to

config ReadingConfiguration

Optional write config

formatting FormattingRules

Expected formatting

Returns

Song

FromFileAsync(string, ChartReadingConfiguration?, FormattingRules?, CancellationToken)

Reads of a Song from a file asynchronously.

public static Task<Song> FromFileAsync(string path, ChartReadingConfiguration? config = null, FormattingRules? formatting = null, CancellationToken cancellationToken = default)

Parameters

path string

Path of the file to write to

config ChartReadingConfiguration

Optional write config

formatting FormattingRules

Expected formatting

cancellationToken CancellationToken

Token used for cancellation

Returns

Task<Song>

Remarks

Uses multi-threading to parse song components.

ToFile(string, WritingConfiguration?, FormattingRules?)

Writes the Song to a file.

public void ToFile(string path, WritingConfiguration? config = null, FormattingRules? formatting = null)

Parameters

path string

Path of the file to write to

config WritingConfiguration

Optional write config

formatting FormattingRules

Formatting to apply

ToFileAsync(string, WritingConfiguration?, FormattingRules?, CancellationToken)

Writes the Song to a file asynchronously.

public Task ToFileAsync(string path, WritingConfiguration? config = null, FormattingRules? formatting = null, CancellationToken cancellationToken = default)

Parameters

path string

Path of the file to write to

config WritingConfiguration

Optional write config

formatting FormattingRules

Formatting to apply

cancellationToken CancellationToken

Token used for cancellation

Returns

Task

Remarks

Uses multi-threading to serialize song components.