class CancellableEvent

package funkin.scripting.events

implements IFlxDestroyable

extended by CamMoveEvent, CountdownEvent, DanceEvent, DirectionAnimEvent, DiscordPresenceUpdateEvent, FreeplaySongSelectEvent, InputSystemEvent, MenuChangeEvent, NameEvent, NoteCreationEvent, NoteHitEvent, NoteUpdateEvent, PauseCreationEvent, PlayAnimEvent, PointEvent, RatingUpdateEvent, ResizeEvent, SimpleNoteEvent, StateEvent, StrumCreationEvent, WeekSelectEvent

@:directlyUsed@:build(hscript.ClassExtendMacro.build())@:allow(ScriptPack)@:autoBuild(funkin.macros.EventMacro.build())@:noCustomClass

Constructor

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

destroy():Void

@: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)

recycleBase():Void

toString():String

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

Returns:

String