funkin.game.cutscenes.dialogue.DialogueBox

Constructor

View on GitHub

`new(name:String)`

Variables

`cutscene:DialogueCutscene = DialogueCutscene.cutscene`

`defPath:String = "dialogue/boxes/"`

`defaultTextTypeSFX:Array<FlxSound>`

`dialogueBoxData:Access`

`dialogueBoxScript:Script`

`dialogueEnded:Bool = false`

`nextSFX:String = Paths.sound("dialogue/next")`

`positions:Map<String, CharPosDef> = []`

`text:FlxTypeText`

Methods

View on GitHub

`playBubbleAnim(bubble:String, suffix:String = "", text:String = "", ?format:Array<TextFormat>, speed:Float = 0.05, ?customSFX:FlxSound, ?customTypeSFX:Array<FlxSound>, setTextAfter:Bool = false, allowDefault:Bool = true):Void`

View on GitHub

`popupChar(char:DialogueCharacter, force:Bool = false):Void`

View on GitHub

`resetText(text:String = "", ?formats:Array<TextFormat>, ?event:DialogueBoxSetTextEvent):Void`

View on GitHub

`startText(text:String = "", ?format:Array<TextFormat>, speed:Float = 0.05, ?customTypeSFX:Array<FlxSound>):Void`

Inherited Variables

Defined by FunkinSprite

`animDatas:Map<String, AnimData> = []`

`animEnabled:Bool = true`

`animOffsets:Map<String, FlxPoint> = new Map<String,FlxPoint>()`

`animateAtlas:FlxAnimate`

`beatAnims:Array<BeatAnim> = []`

`beatInterval:Int = 2`

ODD interval -> not aligned to beats EVEN interval -> aligned to beats

`beatOffset:Int = 0`

`debugMode:Bool = false`

`extra:Map<String, Dynamic> = []`

`globalCurFrame:Int`

`lastAnimContext:PlayAnimContext = DANCE`

`name:String`

`skipNegativeBeats:Bool = false`

`spriteAnimType:XMLAnimType = NONE`

`zoomFactor:Float = 1`

`zoomFactorEnabled:Bool = true`

Inherited Methods

Defined by FunkinSprite

View on GitHub

`inlineaddAnim(name:String, prefix:String, frameRate:Float = 24, ?looped:Bool, ?forced:Bool, ?indices:Array<Int>, x:Float = 0, y:Float = 0, animType:XMLAnimType = NONE):ErrorCode`

View on GitHub

class DialogueBox

package funkin.game.cutscenes.dialogue

extends FunkinSprite

Constructor

new(name:String)

Variables

cutscene:DialogueCutscene = DialogueCutscene.cutscene

defPath:String = "dialogue/boxes/"

defaultTextTypeSFX:Array<FlxSound>

dialogueBoxData:Access

dialogueBoxScript:Script

dialogueEnded:Bool = false

nextSFX:String = Paths.sound("dialogue/next")

positions:Map<String, CharPosDef> = []

text:FlxTypeText

Methods

playBubbleAnim(bubble:String, suffix:String = "", text:String = "", ?format:Array<TextFormat>, speed:Float = 0.05, ?customSFX:FlxSound, ?customTypeSFX:Array<FlxSound>, setTextAfter:Bool = false, allowDefault:Bool = true):Void

popupChar(char:DialogueCharacter, force:Bool = false):Void

resetText(text:String = "", ?formats:Array<TextFormat>, ?event:DialogueBoxSetTextEvent):Void

startText(text:String = "", ?format:Array<TextFormat>, speed:Float = 0.05, ?customTypeSFX:Array<FlxSound>):Void

Inherited Variables

Defined by FunkinSprite

animDatas:Map<String, AnimData> = []

animEnabled:Bool = true

animOffsets:Map<String, FlxPoint> = new Map<String,FlxPoint>()

animateAtlas:FlxAnimate

beatAnims:Array<BeatAnim> = []

beatInterval:Int = 2

beatOffset:Int = 0

debugMode:Bool = false

extra:Map<String, Dynamic> = []

globalCurFrame:Int

lastAnimContext:PlayAnimContext = DANCE

name:String

skipNegativeBeats:Bool = false

spriteAnimType:XMLAnimType = NONE

zoomFactor:Float = 1

zoomFactorEnabled:Bool = true

Inherited Methods

Defined by FunkinSprite

inlineaddAnim(name:String, prefix:String, frameRate:Float = 24, ?looped:Bool, ?forced:Bool, ?indices:Array<Int>, x:Float = 0, y:Float = 0, animType:XMLAnimType = NONE):ErrorCode

addOffset(name:String, x:Float = 0, y:Float = 0):Void

copyAtlasValues():Void

getAnim(name:String):OneOfTwo<FlxAnimation, FlxSymbolAnimation>

inlinegetAnimName():String

inlinegetAnimOffset(name:String):Null<FlxPoint>

inlinegetNameList():Array<String>

inlinehasAnim(AnimName:String):Bool

inlinehasAnimation(AnimName:String):Bool

inlineisAnimAtEnd():Bool

inlineisAnimFinished():Bool

inlineisAnimReversed():Bool

loadSprite(path:String, Unique:Bool = false, ?Key:String):FunkinSprite

measureHit(curMeasure:Int):Void

onPropertySet(property:String, value:Dynamic):Void

inlineremoveAnim(name:String):Void

inlineremoveAnimation(name:String):Void

stepHit(curBeat:Int):Void

inlinestopAnim():Void

inlinestopAnimation():Void

switchOffset(anim1:String, anim2:String):Void

`new(name:String)`

`cutscene:DialogueCutscene = DialogueCutscene.cutscene`

`defPath:String = "dialogue/boxes/"`

`defaultTextTypeSFX:Array<FlxSound>`

`dialogueBoxData:Access`

`dialogueBoxScript:Script`

`dialogueEnded:Bool = false`

`nextSFX:String = Paths.sound("dialogue/next")`

`positions:Map<String, CharPosDef> = []`

`text:FlxTypeText`

`playBubbleAnim(bubble:String, suffix:String = "", text:String = "", ?format:Array<TextFormat>, speed:Float = 0.05, ?customSFX:FlxSound, ?customTypeSFX:Array<FlxSound>, setTextAfter:Bool = false, allowDefault:Bool = true):Void`

`popupChar(char:DialogueCharacter, force:Bool = false):Void`

`resetText(text:String = "", ?formats:Array<TextFormat>, ?event:DialogueBoxSetTextEvent):Void`

`startText(text:String = "", ?format:Array<TextFormat>, speed:Float = 0.05, ?customTypeSFX:Array<FlxSound>):Void`

`animDatas:Map<String, AnimData> = []`

`animEnabled:Bool = true`

`animOffsets:Map<String, FlxPoint> = new Map<String,FlxPoint>()`

`animateAtlas:FlxAnimate`

`beatAnims:Array<BeatAnim> = []`

`beatInterval:Int = 2`

`beatOffset:Int = 0`

`debugMode:Bool = false`

`extra:Map<String, Dynamic> = []`

`globalCurFrame:Int`

`lastAnimContext:PlayAnimContext = DANCE`

`name:String`

`skipNegativeBeats:Bool = false`

`spriteAnimType:XMLAnimType = NONE`

`zoomFactor:Float = 1`

`zoomFactorEnabled:Bool = true`

`inlineaddAnim(name:String, prefix:String, frameRate:Float = 24, ?looped:Bool, ?forced:Bool, ?indices:Array<Int>, x:Float = 0, y:Float = 0, animType:XMLAnimType = NONE):ErrorCode`

`addOffset(name:String, x:Float = 0, y:Float = 0):Void`

`copyAtlasValues():Void`

`getAnim(name:String):OneOfTwo<FlxAnimation, FlxSymbolAnimation>`

`inlinegetAnimName():String`

`inlinegetAnimOffset(name:String):Null<FlxPoint>`

`inlinegetNameList():Array<String>`

`inlinehasAnim(AnimName:String):Bool`

`inlinehasAnimation(AnimName:String):Bool`

`inlineisAnimAtEnd():Bool`

`inlineisAnimFinished():Bool`

`inlineisAnimReversed():Bool`

`loadSprite(path:String, Unique:Bool = false, ?Key:String):FunkinSprite`

`measureHit(curMeasure:Int):Void`

`onPropertySet(property:String, value:Dynamic):Void`

`inlineremoveAnim(name:String):Void`

`inlineremoveAnimation(name:String):Void`

`stepHit(curBeat:Int):Void`

`inlinestopAnim():Void`

`inlinestopAnimation():Void`

`switchOffset(anim1:String, anim2:String):Void`