View source

class PlayAnimationSongEvent

package funkin.play.event

extends SongEvent

Available on all platforms

This class handles song events which force a specific character or stage prop to play an animation.

Constructor

new()

Methods

getEventSchema():SongEventSchema

{
  "target": STRING, // Name of character or prop to point to.
  "anim": STRING, // Name of animation to play.
  "force": BOOL, // Whether to force the animation to play.
}

Returns:

SongEventSchema

Inherited Variables

Defined by SongEvent

id:String

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

Inherited Methods

Defined by SongEvent

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.

toString():String