Codename LogoCodename Logo

funkin.backend.scripting.events.NoteUpdateEvent

APIWiki
View source

final class NoteUpdateEvent

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

elapsed:Null<Float>

Time elapsed since last frame

note:Note

Note that is being updated

strum:Strum

Note's strum (can be changed)

Methods

View in GitHub

cancelAutoCPUHit():Void

Cancels the automatic CPU hit.

View in GitHub

cancelPositionUpdate():Void

Cancels the note position update (note will freeze).

View in GitHub

cancelWindowUpdate():Void

Cancels the hit window update.

View in GitHub

recycle(note:Note, elapsed:Null<Float>, strum:Strum):NoteUpdateEvent

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