Codename LogoCodename Logo

funkin.backend.scripting.events.NoteMissEvent

APIWiki
View source

final class NoteMissEvent

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

accuracy:Null<Float>

Accuracy gained from pressing this note. From 0 to 1. null means no accuracy is gained.

animSuffix:String

Suffix of the animation. "miss" for miss notes, "-alt" for alt notes, "" for normal ones.

character:Character

Character that pressed the note.

characters:Array<Character>

Characters that pressed the note.

direction:Int

Direction of the press (0 = Left, 1 = Down, 2 = Up, 3 = Right)

forceAnim:Null<Bool>

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

forceGfAnim:Bool

gfSad:Bool

gfSadAnim:String

ghostMiss:Bool

healthGain:Float

The amount of health that'll be gained from missing that note. If called from onPlayerMiss, the value will be negative.

missSound:String

missVolume:Float

misses:Int

muteVocals:Bool

note:Note

Note that has been missed

noteType:String

Note Type name (null if default note)

playerID:Int

Whenever the Character is a player

score:Int

Methods

View in GitHub

preventAnim():Void

Prevents the default sing animation from being played.

View in GitHub

preventDeletion():Void

Prevents the note from being deleted.

View in GitHub

preventMissSound():Void

Prevents the miss sound from played.

View in GitHub

preventResetCombo():Void

Prevents the combo from being reset.

View in GitHub

preventStunned():Void

Prevents the default sing animation from being played.

View in GitHub

preventVocalsMute():Void

Prevents the vocals volume from being muted in case its a parameter of onPlayerMiss

View in GitHub

preventVocalsUnmute():Void

Prevents the vocals volume from being set to 1 after pressing the note.

View in GitHub

recycle(note:Note, score:Int, misses:Int, muteVocals:Bool, healthGain:Float, missSound:String, missVolume:Float, ghostMiss:Bool, gfSad:Bool, gfSadAnim:String, forceGfAnim:Bool, forceAnim:Null<Bool>, animSuffix:String, characters:Array<Character>, playerID:Int, noteType:String, direction:Int, accuracy:Null<Float>):NoteMissEvent

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