Class Instrument

Namespace

ChartTools

Assembly

ChartTools.dll

Base class for instruments

public abstract record Instrument : IEmptyVerifiable, IEquatable<Instrument>

Inheritance

object

Instrument

Implements

IEmptyVerifiable

IEquatable<Instrument>

Derived

Instrument<TChord>

Inherited Members

object.GetType()

object.MemberwiseClone()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Extension Methods

TempoRescaler.Rescale(Instrument, float)

Constructors

Instrument()

protected Instrument()

Instrument(Instrument)

protected Instrument(Instrument original)

Parameters

original Instrument

Properties

Easy

Easy track

public Track? Easy { get; }

Property Value

Track

EqualityContract

protected virtual Type EqualityContract { get; }

Property Value

Type

Expert

Expert track

public Track? Expert { get; }

Property Value

Track

Hard

Hard track

public Track? Hard { get; }

Property Value

Track

InstrumentIdentity

Identity of the instrument the object belongs to

public InstrumentIdentity InstrumentIdentity { get; }

Property Value

InstrumentIdentity

InstrumentType

Type of instrument

public InstrumentType InstrumentType { get; }

Property Value

InstrumentType

IsEmpty

true if containing no data

public bool IsEmpty { get; }

Property Value

bool

Medium

Medium track

public Track? Medium { get; }

Property Value

Track

SharedSpecialPhrases

Set of special phrases applied to all difficulties

public List<InstrumentSpecialPhrase> SharedSpecialPhrases { get; set; }

Property Value

List<InstrumentSpecialPhrase>

Methods

CreateTrack(SafeEnum<Difficulty>)

Creates a track

public abstract Track CreateTrack(SafeEnum<Difficulty> difficulty)

Parameters

difficulty SafeEnum<Difficulty>

Difficulty of the track

Returns

Track

Equals(Instrument?)

public virtual bool Equals(Instrument? other)

Parameters

other Instrument

Returns

bool

Equals(object?)

public override bool Equals(object? obj)

Parameters

obj object

Returns

bool

GetDifficulty(InstrumentDifficultySet)

public ref sbyte? GetDifficulty(InstrumentDifficultySet difficulties)

Parameters

difficulties InstrumentDifficultySet

Returns

sbyte?

GetEasy()

protected abstract Track? GetEasy()

Returns

Track

GetExistingTracks()

Creates an array containing all tracks with data.

public virtual IEnumerable<Track> GetExistingTracks()

Returns

IEnumerable<Track>

GetExpert()

protected abstract Track? GetExpert()

Returns

Track

GetHard()

protected abstract Track? GetHard()

Returns

Track

GetHashCode()

public override int GetHashCode()

Returns

int

GetIdentity()

protected abstract InstrumentIdentity GetIdentity()

Returns

InstrumentIdentity

GetMedium()

protected abstract Track? GetMedium()

Returns

Track

GetTrack(SafeEnum<Difficulty>)

Gets the track matching a difficulty.

public abstract Track? GetTrack(SafeEnum<Difficulty> difficulty)

Parameters

difficulty SafeEnum<Difficulty>

Returns

Track

GetTracks()

Creates an array containing all tracks.

public abstract Track?[] GetTracks()

Returns

Track[]

PrintMembers(StringBuilder)

protected virtual bool PrintMembers(StringBuilder builder)

Parameters

builder StringBuilder

Returns

bool

RemoveTrack(SafeEnum<Difficulty>)

Removes a track.

public abstract bool RemoveTrack(SafeEnum<Difficulty> difficulty)

Parameters

difficulty SafeEnum<Difficulty>

Difficulty of the target track

Returns

bool

ShareLocalEvents(TrackObjectSource)

Gives all tracks the same local events.

public LocalEvent[] ShareLocalEvents(TrackObjectSource source)

Parameters

source TrackObjectSource

Returns

LocalEvent[]

ShareSpecial(TrackObjectSource)

Gives all tracks the same special phrases.

public SpecialPhrase[] ShareSpecial(TrackObjectSource source)

Parameters

source TrackObjectSource

Returns

SpecialPhrase[]

ToString()

public override string ToString()

Returns

string

Operators

operator ==(Instrument?, Instrument?)

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

Parameters

left Instrument

right Instrument

Returns

bool

operator !=(Instrument?, Instrument?)

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

Parameters

left Instrument

right Instrument

Returns

bool