Codename LogoCodename Logo

funkin.backend.scripting.events.CancellableEvent

APIWikiTools
View source

class CancellableEvent

package funkin.backend.scripting.events

implements IFlxDestroyable

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

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

Constructor

View on GitHub

new()

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

Variables

data:Dynamic = { }

Additional data if used in scripts

Methods

View on GitHub

destroy():Void

View on GitHub

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 on GitHub

recycleBase():Void

View on GitHub

toString():String

Returns a string representation of the event, in this format: [CancellableEvent] [CancellableEvent (Cancelled)]

Returns:

String