funkin.scripting.events.NoteHitEvent

Constructor

`@:value({ ratingSuffix : "", ratingPrefix : "", rating : "sick", animSuffix : "", score : 350, unmuteVocals : true })new(note:Note, character:Character, player:Bool, noteType:String, direction:Int, healthGain:Float, unmuteVocals:Bool = true, score:Int = 350, animSuffix:String = "", rating:String = "sick", ?accuracy:Float, ratingPrefix:String = "", ratingSuffix:String = "")`

Creates a new NoteHitEvent.

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. "-alt" for alt notes, "" for normal ones.

`character:Character`

Character that pressed the note

`@:value(true)countAsCombo:Bool = true`

Whenever a miss should be added.

`direction:Int`

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

`healthGain:Float`

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

`@:value(true)misses:Bool = true`

Whenever a miss should be added.

`note:Note`

Note that has been pressed

`noteType:String`

Note Type name (null if default note)

`@:value(true)numAntialiasing:Bool = true`

Whenever antialiasing should be enabled on combo number.

`@:value(0.5)numScale:Float = 0.5`

Scale of combo numbers.

`player:Bool`

Whenever the Character is a player

`@:value("sick")rating:String = "sick"`

Rating name. Defaults to "sick", "good", "bad" and "shit". Customisable.

`@:value(true)ratingAntialiasing:Bool = true`

Whenever antialiasing should be enabled on ratings.

`ratingPrefix:String`

Prefix of the rating sprite path. Defaults to "game/score/"

`@:value(0.7)ratingScale:Float = 0.7`

Scale of ratings.

`ratingSuffix:String`

Suffix of the rating sprite path.

`score:Int`

Score gained after note press.

`@:value(null)showRating:Null<Bool> = null`

Whenever ratings should be shown or not.

Methods

`preventAnim():Void`

Prevents the default sing animation from being played.

`preventCamZooming():Void`

Prevents the camera zoom every 4 beats from enabling.

`preventDeletion():Void`

Prevents the note from being deleted.

`preventLastSustainHit():Void`

Prevents the sustain tail (the last one) from being automatically hit when the sustain before it is hit.

`preventStrumGlow():Void`

Prevents the strum from glowing after this note has been pressed.

`preventVocalsMute():Void`

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

`preventVocalsUnmute():Void`

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

class NoteHitEvent

package funkin.scripting.events

extends CancellableEvent