Class InstrumentComponentList

Namespace

ChartTools.IO.Components

Assembly

ChartTools.dll

Set of instruments and tracks to include in a read/write operation

public record InstrumentComponentList : IEquatable<InstrumentComponentList>

Inheritance

object

InstrumentComponentList

Implements

IEquatable<InstrumentComponentList>

Inherited Members

object.GetType()

object.MemberwiseClone()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Extension Methods

TempoRescaler.Rescale<TChord, TNote, TLane>(TChord, float)

Constructors

InstrumentComponentList()

Set of instruments and tracks to include in a read/write operation

public InstrumentComponentList()

InstrumentComponentList(GHLInstrumentIdentity, DifficultySet)

Creates a new InstrumentComponentList for a single Guitar Hero Live instrument with the specified difficulties.

public InstrumentComponentList(GHLInstrumentIdentity identity, DifficultySet difficulties = DifficultySet.All)

Parameters

identity GHLInstrumentIdentity

Instrument to include

difficulties DifficultySet

Tracks to include for the instrument

Exceptions

UndefinedEnumException

InstrumentComponentList(InstrumentComponentList)

protected InstrumentComponentList(InstrumentComponentList original)

Parameters

original InstrumentComponentList

InstrumentComponentList(InstrumentIdentity, DifficultySet)

Creates a new InstrumentComponentList for a single instrument with the specified difficulties.

public InstrumentComponentList(InstrumentIdentity identity, DifficultySet difficulties = DifficultySet.All)

Parameters

identity InstrumentIdentity

Instrument to include

difficulties DifficultySet

Tracks to include for the instrument

Exceptions

UndefinedEnumException

InstrumentComponentList(StandardInstrumentIdentity, DifficultySet)

Creates a new InstrumentComponentList for a single standard instrument with the specified difficulties.

public InstrumentComponentList(StandardInstrumentIdentity identity, DifficultySet difficulties = DifficultySet.All)

Parameters

identity StandardInstrumentIdentity

Instrument to include

difficulties DifficultySet

Tracks to include for the instrument

Exceptions

UndefinedEnumException

Properties

Drums

Tracks to include for Drums

public DifficultySet Drums { get; set; }

Property Value

DifficultySet

EqualityContract

protected virtual Type EqualityContract { get; }

Property Value

Type

GHLBass

Tracks to include for GHLBass

public DifficultySet GHLBass { get; set; }

Property Value

DifficultySet

GHLCoopGuitar

Tracks to include for GHLCoopGuitar

public DifficultySet GHLCoopGuitar { get; set; }

Property Value

DifficultySet

GHLLeadGuitar

Tracks to include for GHLLeadGuitar

public DifficultySet GHLLeadGuitar { get; set; }

Property Value

DifficultySet

GHLRhythmGuitar

Tracks to include for GHLRhythmGuitar

public DifficultySet GHLRhythmGuitar { get; set; }

Property Value

DifficultySet

StandardBass

Tracks to include for StandardBass

public DifficultySet StandardBass { get; set; }

Property Value

DifficultySet

StandardCoopGuitar

Tracks to include for StandardCoopGuitar

public DifficultySet StandardCoopGuitar { get; set; }

Property Value

DifficultySet

StandardKeys

Tracks to include for StandardKeys

public DifficultySet StandardKeys { get; set; }

Property Value

DifficultySet

StandardLeadGuitar

Tracks to include for StandardLeadGuitar

public DifficultySet StandardLeadGuitar { get; set; }

Property Value

DifficultySet

StandardRhythmGuitar

Tracks to include for StandardRhythmGuitar

public DifficultySet StandardRhythmGuitar { get; set; }

Property Value

DifficultySet

Methods

Equals(InstrumentComponentList?)

public virtual bool Equals(InstrumentComponentList? other)

Parameters

other InstrumentComponentList

Returns

bool

Equals(object?)

public override bool Equals(object? obj)

Parameters

obj object

Returns

bool

Full()

Creates a new InstrumentComponentList with all instruments and tracks included.

public static InstrumentComponentList Full()

Returns

InstrumentComponentList

GetHashCode()

public override int GetHashCode()

Returns

int

Map(GHLInstrumentIdentity)

Maps a Guitar Hero Live instrument to its included tracks by reference.

public ref DifficultySet Map(GHLInstrumentIdentity instrument)

Parameters

instrument GHLInstrumentIdentity

Returns

DifficultySet

Exceptions

UndefinedEnumException

Map(InstrumentIdentity)

Maps a instrument to its included tracks by reference.

public ref DifficultySet Map(InstrumentIdentity instrument)

Parameters

instrument InstrumentIdentity

Returns

DifficultySet

Exceptions

UndefinedEnumException

Map(StandardInstrumentIdentity)

Maps a standard instrument to its included tracks by reference.

public ref DifficultySet Map(StandardInstrumentIdentity instrument)

Parameters

instrument StandardInstrumentIdentity

Returns

DifficultySet

Exceptions

UndefinedEnumException

PrintMembers(StringBuilder)

protected virtual bool PrintMembers(StringBuilder builder)

Parameters

builder StringBuilder

Returns

bool

ToString()

public override string ToString()

Returns

string

Operators

operator ==(InstrumentComponentList?, InstrumentComponentList?)

public static bool operator ==(InstrumentComponentList? left, InstrumentComponentList? right)

Parameters

left InstrumentComponentList

right InstrumentComponentList

Returns

bool

operator !=(InstrumentComponentList?, InstrumentComponentList?)

public static bool operator !=(InstrumentComponentList? left, InstrumentComponentList? right)

Parameters

left InstrumentComponentList

right InstrumentComponentList

Returns

bool