Codename LogoCodename Logo

funkin.backend.scripting.events.PlayAnimEvent

APIWiki
View source

final class PlayAnimEvent

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

Name of the animation that's going to be played.

context:PlayAnimContext

Context of the animation

force:Null<Bool>

Whenever the animation will be forced or not (if it's null it will be forced based on the sprite's data xml, if it has one).

reverse:Bool

Whenever the animation will play in reverse or not

@:value(0)startingFrame:Int = 0

The frame at which the animation will start playing

Methods

View in GitHub

@:value({ startingFrame : 0 })recycle(animName:String, force:Null<Bool>, reverse:Bool, startingFrame:Int = 0, context:PlayAnimContext):PlayAnimEvent

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