funkin.backend.scripting.events.NoteCreationEvent

Constructor

View in GitHub

`new()`

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)

`strumLineID:Int`

ID of the player.

Methods

View in GitHub

`recycle(note:Note, strumID:Int, noteType:String, noteTypeID:Int, strumLineID:Int, mustHit:Bool, noteSprite:String, noteScale:Float, animSuffix:String):NoteCreationEvent`

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