Kristal Wiki

Getting Started

These pages get you ready to use the engine.

General Mod Creation

These pages teach you about mod development.

The Overworld

Everything to do with the overworld.

Battles

Everything related to creating battles.

API Reference

An auto-generated API reference for Kristal.

⮬Back to Top⮭

Textbox

┗> Object > Class

Constructor

Textbox(x: any, y: any, width: any, height: any, default_font: any, default_font_size: any, battle_box: any)

Arguments:

x: any
y: any
width: any
height: any
default_font: any
default_font_size: any
battle_box: any

Methods

Textbox:addFunction(id: any, func: any)

Arguments:

id: any
func: any

Textbox:addReaction(id: any, text: any, x: any, y: any, face: any, actor: any)

Arguments:

id: any
text: any
x: any
y: any
face: any
actor: any

Textbox:advance()

Textbox:getBorder()

Returns:

1: number\|nil
2: number\|nil

Textbox:getDebugRectangle()

Returns:

1: table

Textbox:getText()

Returns:

1: unknown

Textbox:isDone()

Returns:

1: boolean|nil

Textbox:isTyping()

Returns:

1: boolean|nil

Textbox:resetFunctions()

Textbox:resetReactions()

Textbox:setActor(actor: any)

Arguments:

actor: any

Textbox:setAdvance(advance: any)

Arguments:

advance: any

Textbox:setAlign(align: any)

Arguments:

align: any

Textbox:setAuto(auto: any)

Arguments:

auto: any

Textbox:setCallback(callback: any)

Arguments:

callback: any

Textbox:setFace(face: any, ox: any, oy: any)

Arguments:

face: any
ox: any
oy: any

Textbox:setFont(font: any, size: any)

Arguments:

font: any
size: any

Textbox:setSize(w: any, h: any)

Arguments:

w: any
h: any

Textbox:setSkippable(skippable: any)

Arguments:

skippable: any

Textbox:setText(text: any, callback: any)

Arguments:

text: any
callback: any

Textbox:update()

Textbox:updateTextBounds()

Fields

Undocumented

Textbox.REACTION_X: table

Textbox.REACTION_X_BATTLE: table

Textbox.REACTION_Y: table

Textbox.REACTION_Y_BATTLE: table

Textbox.actor: nil

Textbox.actor: any

Textbox.advance_callback: nil

Textbox.advance_callback: any

Textbox.battle_box: any

Textbox.box: UIBox

Textbox.default_font: any

Textbox.default_font_size: any

Textbox.face: Sprite

A simple object that renders a texture.
This texture must be placed inside assets/sprites/.

Textbox.face_x: integer

Textbox.face_y: integer

Textbox.font: any

Textbox.font_size: any

Textbox.height: any

Textbox.reaction_instances: table

Textbox.reactions: table

Textbox.text: DialogueText

Textbox.text_x: integer

Textbox.text_y: integer

TODO: This was changed 2px lower with the new font, but it was 4px offset. Why? (Used to be 0)

Kristal Wiki

Getting Started

General Mod Creation

The Overworld

Battles

API Reference

Textbox

┗> Object > Class

Constructor

Textbox(x: any, y: any, width: any, height: any, default_font: any, default_font_size: any, battle_box: any)

Methods

Textbox:addFunction(id: any, func: any)

Textbox:addReaction(id: any, text: any, x: any, y: any, face: any, actor: any)

Textbox:advance()

Textbox:getBorder()

Textbox:getDebugRectangle()

Textbox:getText()

Textbox:isDone()

Textbox:isTyping()

Textbox:resetFunctions()

Textbox:resetReactions()

Textbox:setActor(actor: any)

Textbox:setAdvance(advance: any)

Textbox:setAlign(align: any)

Textbox:setAuto(auto: any)

Textbox:setCallback(callback: any)

Textbox:setFace(face: any, ox: any, oy: any)

Textbox:setFont(font: any, size: any)

Textbox:setSize(w: any, h: any)

Textbox:setSkippable(skippable: any)

Textbox:setText(text: any, callback: any)

Textbox:update()

Textbox:updateTextBounds()

Fields

Undocumented

Textbox.REACTION_X: table

Textbox.REACTION_X_BATTLE: table

Textbox.REACTION_Y: table

Textbox.REACTION_Y_BATTLE: table

Textbox.actor: nil

Textbox.actor: any

Textbox.advance_callback: nil

Textbox.advance_callback: any

Textbox.battle_box: any

Textbox.box: UIBox

Textbox.default_font: any

Textbox.default_font_size: any

Textbox.face: Sprite

Textbox.face_x: integer

Textbox.face_x: integer

Textbox.face_x: integer

Textbox.face_y: integer

Textbox.face_y: integer

Textbox.face_y: integer

Textbox.font: any

Textbox.font: any

Textbox.font: any

Textbox.font_size: any

Textbox.font_size: any

Textbox.font_size: any

Textbox.height: any

Textbox.reaction_instances: table

Textbox.reaction_instances: table

Textbox.reaction_instances: table

Textbox.reactions: table

Textbox.reactions: table

Textbox.text: DialogueText

Textbox.text_x: integer

Textbox.text_x: integer

Textbox.text_x: integer

Textbox.text_y: integer

Textbox.text_y: integer

Textbox.text_y: integer

Textbox.width: any

Textbox.wrap_add_w: integer