Struct DrumsNote

Namespace

ChartTools

Assembly

ChartTools.dll

Note played by drums

public readonly struct DrumsNote : IDefinedLaneNote<DrumsLane>, ILaneNote<DrumsLane>, ILaneNote, INote, IReadOnlyLongObject, IEquatable<DrumsNote>

Implements

IDefinedLaneNote<DrumsLane>

ILaneNote<DrumsLane>

ILaneNote

INote

IReadOnlyLongObject

IEquatable<DrumsNote>

Inherited Members

object.GetType()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Extension Methods

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

Constructors

DrumsNote(DrumsLane)

public DrumsNote(DrumsLane lane)

Parameters

lane DrumsLane

Properties

Index

Numerical value of the note identity

public byte Index { get; }

Property Value

byte

IsCymbal

true if the cymbal must be hit instead of the pad on supported drum sets

public bool IsCymbal { get; init; }

Property Value

bool

Remarks

Green5Lane notes cannot be cymbal.

IsKick

Determines if the note is played by kicking

public bool IsKick { get; }

Property Value

bool

Lane

public DrumsLane Lane { get; init; }

Property Value

DrumsLane

Sustain

Maximum length the note can be held for extra points

public uint Sustain { get; init; }

Property Value

uint

Methods

Equals(DrumsNote)

public bool Equals(DrumsNote other)

Parameters

other DrumsNote

Returns

bool

Equals(object)

public override bool Equals(object obj)

Parameters

obj object

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

ToString()

public override string ToString()

Returns

string

Operators

operator ==(DrumsNote, DrumsNote)

public static bool operator ==(DrumsNote left, DrumsNote right)

Parameters

left DrumsNote

right DrumsNote

Returns

bool

operator !=(DrumsNote, DrumsNote)

public static bool operator !=(DrumsNote left, DrumsNote right)

Parameters

left DrumsNote

right DrumsNote

Returns

bool

Explicit Interface Implementations

MaxLanes

static byte MaxLanes { get; }

Returns

byte

OpenExclusivity

static bool OpenExclusivity { get; }

Returns

bool