Codename LogoCodename Logo

funkin.backend.scripting.events.CancellableEvent

APIWiki
View source

class CancellableEvent

package funkin.backend.scripting.events

implements IFlxDestroyable

extended by DialogueBoxCharPopupEvent, DialogueBoxPlayBubbleEvent, DialogueBoxSetTextEvent, DialogueBoxStructureEvent, DialogueCharHideEvent, DialogueCharShowEvent, DialogueCharStructureEvent, DialogueStructureEvent, AmountEvent, CamMoveEvent, CountdownEvent, DanceEvent, DirectionAnimEvent, DiscordPresenceUpdateEvent, DrawEvent, DynamicEvent, EventGameEvent, FreeplayAlphaUpdateEvent, FreeplaySongSelectEvent, GameOverCreationEvent, GameOverEvent, InputSystemEvent, MenuChangeEvent, NameEvent, NoteCreationEvent, NoteHitEvent, NoteMissEvent, NoteUpdateEvent, PauseCreationEvent, PlayAnimEvent, PointEvent, RatingUpdateEvent, ResizeEvent, SimpleNoteEvent, StageNodeEvent, StageXMLEvent, StateEvent, StrumCreationEvent, WeekSelectEvent

@:directlyUsed@:allow(funkin.backend.scripting.ScriptPack)@:autoBuild(funkin.backend.system.macros.EventMacro.build())@:noCustomClass

Constructor

View in GitHub

new()

Creates a new cancellable event. This allows scripts to call cancel() to cancel the event.

Variables

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

Additional data if used in scripts

Methods

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