View source

class SongEvent

package funkin.play.event

extended by FocusCameraSongEvent, PlayAnimationSongEvent, ScriptedSongEvent, ScrollSpeedEvent, SetCameraBopSongEvent, SetHealthIconSongEvent, ZoomCameraSongEvent

@:directlyUsed

Available on all platforms

This class provides a handler for a type of song event. It is used by the ScriptedSongEvent class to handle user-defined events, and also used by other classes in this package to provide default behavior for built-in events.

Static variables

@:value("linear")staticfinalread onlyDEFAULT_EASE:String = "linear"

These variables are used in two different events (and may be in more), and in order not to create unnecessary variables, we store them here

@:value("In")staticfinalread onlyDEFAULT_EASE_DIR:String = "In"

The default ease direction for events which use FlxEase.

@:value(~/(In|Out|InOut)$/)staticfinalread onlyEASE_TYPE_DIR_REGEX:EReg = ~/(In|Out|InOut)$/

A regular expression to detect the current ease direction for ease function names from FlxEase.

Constructor

new(id:String)

Variables

id:String

The internal song event ID that this handler is responsible for.

Methods

getEventSchema():SongEventSchema

Retrieves the chart editor schema for this song event type.

Returns:

The schema, or null if this event type does not have a schema.

getIconPath():String

Retrieves the asset path to the icon this event type should use in the chart editor. To customize this, override getIconPath().

Returns:

The path to the icon to display.

getTitle():String

Retrieves the human readable title of this song event type. Used for the chart editor.

Returns:

The title.

handleEvent(data:SongEventData):Void

Handles a song event that matches this handler's ID.

Parameters:

data

The data associated with the event.

toString():String