Callback Events
Callback events, or simply just events, are containers of data for callbacks. They are typically the only parameter of any callback.
A callback event is different from a chart event in that
callback events are used exclusively for scripting, while chart events are
instantiated through charts and operate only on PlayState
.
Common Events
Some events that are typically used, but are not limited to, include:
CancellableEvent
: Perhaps the most used and inherited,CancellableEvent
is good for cancelling some sort of action. For example, it can cancel the gameplay countdown.NoteHitEvent
: A type ofCancellableEvent
that handles the state of note hits, as well as things thatPlayState
should take into account, like the health gain.NoteMissEvent
: Ditto, but for note misses.EventGameEvent
: Used for handling chart events. This extendsCancellableEvent
, but there is typically no need to cancel.
A full list of events and their API documentation can be seen here.
Custom Events
Custom events can be defined through DynamicEvent
,
but there is typically no need to do this. The option is available, though.