Codename LogoCodename Logo

funkin.backend.scripting.events.DirectionAnimEvent

APIWiki
View source

final class DirectionAnimEvent

package funkin.backend.scripting.events

extends CancellableEvent

@:directlyUsed@:build(funkin.backend.system.macros.EventMacro.build())@:autoBuild(funkin.backend.system.macros.EventMacro.build())

Constructor

View in GitHub

new()

Variables

animName:String

Default animation that will be played

context:PlayAnimContext

Context of the animation. Is either equal to SING or MISS.

direction:Int

In which direction the animation will be played

force:Null<Bool>

Force the animation to replay even if it's already playing (if it's null it will be forced based on the sprite's data xml, if it has one).

frame:Int

At what frame the animation will start playing

reversed:Bool

Whenever the animation will play reversed or not.

suffix:String

The suffix of the animation (ex: "-alt") - Defaults to ""

Methods

View in GitHub

recycle(animName:String, direction:Int, suffix:String, context:PlayAnimContext, reversed:Bool, frame:Int, force:Null<Bool>):DirectionAnimEvent

Inherited Variables

Defined by CancellableEvent

@:value({ })data:Dynamic = { }

Additional data if used in scripts

Inherited Methods

Defined by CancellableEvent

View in GitHub

destroy():Void

View in GitHub

@:value({ c : false })preventDefault(c:Bool = false):Void

Prevents default action from occurring.

Parameters:

c

Whenever the scripts following this one should be called or not. (Defaults to true)

View in GitHub

recycleBase():Void

View in GitHub

toString():String

Returns a string representation of the event, in this format: [CancellableEvent] [CancellableEvent (Cancelled)]

Returns:

String