Codename LogoCodename Logo

funkin.backend.scripting.events.StrumCreationEvent

APIWiki
View source

final class StrumCreationEvent

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

animPrefix:String

Animation prefix (left = arrowLEFT, left press, left confirm).

player:Int

s Player ID

@:value("game/notes/default")sprite:String = "game/notes/default"

Sprite path, in case you only want to change the sprite.

strum:Strum

The strum that is being created

strumID:Int

Strum ID, for the sprite.

Methods

View in GitHub

cancelAnimation():Void

Cancels the animation that makes the strum "land" in the strumline.

View in GitHub

@:value({ sprite : "game/notes/default" })recycle(strum:Strum, player:Int, strumID:Int, animPrefix:String, sprite:String = "game/notes/default"):StrumCreationEvent

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