Class GlobalEvent

Namespace

ChartTools.Events

Assembly

ChartTools.dll

Event common to all instruments

public class GlobalEvent : Event, ITrackObject, IReadOnlyTrackObject

Inheritance

object

Event

GlobalEvent

Implements

ITrackObject

IReadOnlyTrackObject

Inherited Members

Event.Position

Event.EventType

Event.Argument

Event.EventData

Event.ToggleState

Event.ToString()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Extension Methods

TempoRescaler.Rescale(ITrackObject, float)

Constructors

GlobalEvent(uint)

Marker that defines an occurrence at a given point in a song.

public GlobalEvent(uint position)

Parameters

position uint

GlobalEvent(uint, string)

public GlobalEvent(uint position, string data)

Parameters

position uint

data string

GlobalEvent(uint, string, string)

public GlobalEvent(uint position, string type, string argument = "")

Parameters

position uint

type string

argument string

Properties

IsBassistMovementEvent

The event controls movement of the bassist character on stage

public bool IsBassistMovementEvent { get; }

Property Value

bool

IsCrowdEvent

The event controls movement of the crowd

public bool IsCrowdEvent { get; }

Property Value

bool

IsDrummerMovementEvent

The event controls movement of the drummer character on stage

public bool IsDrummerMovementEvent { get; }

Property Value

bool

IsGuitaristMovementEvent

The event controls movement of the guitarist character on stage

public bool IsGuitaristMovementEvent { get; }

Property Value

bool

IsGuitaristSoloEvent

public bool IsGuitaristSoloEvent { get; }

Property Value

bool

IsKeyboardMovementEvent

The event controls movement of the keyboard player character on stage

public bool IsKeyboardMovementEvent { get; }

Property Value

bool

IsLyricEvent

The event stores text for a syllable of lyrics for karaoke when no vocal track is present

public bool IsLyricEvent { get; }

Property Value

bool

IsPhraseEvent

The event represents the start or end of a lyric phrase when no vocal track is present

public bool IsPhraseEvent { get; }

Property Value

bool

IsSectionEvent

The event represents a section of a song used for post-game summary and practice mode

public bool IsSectionEvent { get; }

Property Value

bool

IsSyncEvent

public bool IsSyncEvent { get; }

Property Value

bool

IsWailEvent

public bool IsWailEvent { get; }

Property Value

bool

Methods

FromFile(string)

Reads the set of GlobalEvent from a file.

public static IEnumerable<GlobalEvent> FromFile(string path)

Parameters

path string

Path of the file to read from

Returns

IEnumerable<GlobalEvent>

FromFileAsync(string, CancellationToken)

Reads the set of GlobalEvent from a file asynchronously.

public static Task<List<GlobalEvent>> FromFileAsync(string path, CancellationToken cancellationToken = default)

Parameters

path string

Path of the file to read from

cancellationToken CancellationToken

Token used for cancellation

Returns

Task<List<GlobalEvent>>