View source

class HoldNoteScriptEvent

package funkin.modding.events

extends NoteScriptEvent › ScriptEvent

import funkin.modding.events.ScriptEvent

@:directlyUsed

Available on all platforms

Constructor

@:value({ cancelable : false, comboCount : 0 })new(type:ScriptEventType, holdNote:SustainTrail, healthChange:Float, score:Int, isComboBreak:Bool, comboCount:Int = 0, cancelable:Bool = false)

Variables

@:value(false)doesNotesplash:Bool = false

Whether this note hit causes a note splash to display. Defaults to true only on "sick" notes.

@:value(0)hitDiff:Float = 0

The time difference when the player hit the note

holdNote:SustainTrail

The hold note that was hit (or dropped).

@:value(false)isComboBreak:Bool = false

If the hit causes a combo break.

score:Int

The score the player received for hitting the note.

Methods

Inherited Variables

Defined by NoteScriptEvent

read onlycomboCount:Int

The combo count as it is with this event. Will be (combo) on miss events and (combo + 1) on hit events (the stored combo count won't update if the event is cancelled).

healthChange:Float

The health gained or lost from this note. This affects both hits and misses. Remember that max health is 2.00.

read onlynote:NoteSprite

The note associated with this event. You cannot replace it, but you can edit it.

playSound:Bool

Whether to play the record scratch sound (if this event type is NOTE_MISS).

Defined by ScriptEvent

read onlycancelable:Bool

If true, the behavior associated with this event can be prevented. For example, cancelling COUNTDOWN_START should prevent the countdown from starting, until another script restarts it, or cancelling NOTE_HIT should cause the note to be missed.

read onlyeventCanceled:Bool

Whether the event has been canceled by one of the scripts that received it.

read onlyshouldPropagate:Bool

Whether the event should continue to be triggered on additional targets.

read onlytype:ScriptEventType

The type associated with the event.

Inherited Methods

Defined by ScriptEvent

cancel():Void

Cancel this event. This is an alias for cancelEvent() but I make this typo all the time.

cancelEvent():Void

Call this function on a cancelable event to cancel the associated behavior. For example, cancelling COUNTDOWN_START will prevent the countdown from starting.

stopPropagation():Void

Call this function to stop any other Scripteds from receiving the event.