class NoteCreationEvent

package funkin.scripting.events

extends CancellableEvent

@:directlyUsed@:build(hscript.UsingHandler.build())

Constructor

new(note:Note, strumID:Int, noteType:String, noteTypeID:Int, mustHit:Bool, noteSprite:String, noteScale:Float, animSuffix:String)

[Description] Creates a new NoteCreationEvent

Parameters:

note
strumID
noteType
noteTypeID
null

mustHit

Variables

animSuffix:String

Sing animation suffix. "-alt" for alt anim or "" for normal notes.

mustHit:Bool

Whenever the note will need to be hit by the player

note:Note

Note that is being created

noteScale:Float

Note scale, if you only want to replace the scale.

noteSprite:String

Note sprite, if you only want to replace the sprite.

noteType:String

Note Type (ex: "My Super Cool Note", or "Mine")

noteTypeID:Int

ID of the note type.

strumID:Int

ID of the strum (from 0 to 3)

Inherited Variables

Defined by CancellableEvent

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

Additional data if used in scripts

Inherited Methods

Defined by CancellableEvent

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

Prevents default action from occuring.

Parameters:

c

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

toString():String

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

Returns:

String