Codename LogoCodename Logo

funkin.backend.scripting.events.dialogue.DialogueBoxSetTextEvent

APIWiki
View source

final class DialogueBoxSetTextEvent

package funkin.backend.scripting.events.dialogue

extends CancellableEvent

@:directlyUsed@:build(funkin.backend.system.macros.EventMacro.build())@:autoBuild(funkin.backend.system.macros.EventMacro.build())

Constructor

View in GitHub

new()

Variables

customTypeSFX:Array<FlxSound>

format:Array<TextFormat>

speed:Null<Float>

text:String

Methods

View in GitHub

recycle(text:String, format:Array<TextFormat>, speed:Null<Float>, customTypeSFX:Array<FlxSound>):DialogueBoxSetTextEvent

Inherited Variables

Defined by CancellableEvent

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

Additional data if used in scripts

Inherited Methods

Defined by CancellableEvent

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