Kristal Wiki

General Information

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.

Advanced

These pages teach you more complex but powerful parts of the engine.

API Reference

An auto-generated API reference for Kristal.

⮬Back to Top⮭

Kristal Wiki

General Information

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.

Advanced

These pages teach you more complex but powerful parts of the engine.

API Reference

An auto-generated API reference for Kristal.

⮬Back to Top⮭

Text

┗> Object > Class

The Text object, made for displaying formatted text.

If you're looking for text which writes itself out over time, see DialogueText.

Constructor

Text(text: any, x: any, y: any, w: any, h: any, options: any)

Arguments:

text: any
x: any
y: any
w: any
h: any
options: any

Methods

Text:cloneState(state: table)

A helper function to avoid deep-cloning the entire state table.

@param state — The state to clone.

@return state — The cloned state.

Arguments:

state: table

The state to clone.

Returns:

state: table

The cloned state.

Text:draw()

Text:drawChar(node: any, state: any, use_color: any)

Arguments:

node: any
state: any
use_color: any

Text:drawToCanvas(func: any, clear: any)

Arguments:

func: any
clear: any

Text:getCharPosition(node: any, state: any)

Arguments:

node: any
state: any

Returns:

1: unknown
2: unknown

Text:getDebugRectangle()

Returns:

1: table

Text:getFont()

Returns:

1: love.Font

Text:getNodeSize(node: any, state: any, include_scale: any)

Arguments:

node: any
state: any
include_scale: any

Returns:

1: integer
2: unknown

Text:getScaledSize()

Returns:

1: number
2: number

Text:getSize()

Returns:

1: integer
2: integer

Text:getTextColor(state: any, use_base_color: any)

Arguments:

state: any
use_base_color: any

Returns:

1: unknown
2: unknown
3: unknown
4: number

Text:getTextHeight()

Returns:

1: integer

Text:getTextWidth()

Returns:

1: integer

Text:isModifier(command: any)

Arguments:

command: any

Returns:

1: true

Text:isStyleAnimated(style: any)

Arguments:

style: any

Returns:

1: true

Text:isTrue(text: any)

Arguments:

text: any

Returns:

1: boolean

Text:onAddToStage(stage: any)

Arguments:

stage: any

Text:processCustomCommand(node: any, dry: any)

Arguments:

node: any
dry: any

Text:processInitialNodes()

Text:processModifier(node: any, dry: any)

Arguments:

node: any
dry: any

Text:processNode(node: any, dry: any)

Arguments:

node: any
dry: any

Text:processStyle(style: any)

Arguments:

style: any

Returns:

1: boolean

Text:registerCommand(command: any, func: any, options: any)

Arguments:

command: any
func: any
options: any

Text:resetState()

Text:setText(text: any)

Arguments:

text: any

Text:setTextColor(r: any, g: any, b: any, a: any)

Arguments:

r: any
g: any
b: any
a: any

Text:textToNodes(input_string: any)

Arguments:

input_string: any

Returns:

1: table
2: string

Kristal Wiki

Kristal Wiki

┗> Object > Class

Constructor

Text(text: any, x: any, y: any, w: any, h: any, options: any)

Methods

Text:cloneState(state: table)

Text:draw()

Text:drawChar(node: any, state: any, use_color: any)

Text:drawToCanvas(func: any, clear: any)

Text:getCharPosition(node: any, state: any)

Text:getDebugRectangle()

Text:getFont()

Text:getNodeSize(node: any, state: any, include_scale: any)

Text:getScaledSize()

Text:getSize()

Text:getTextColor(state: any, use_base_color: any)

Text:getTextHeight()

Text:getTextWidth()

Text:isModifier(command: any)

Text:isStyleAnimated(style: any)

Text:isTrue(text: any)

Text:onAddToStage(stage: any)

Text:processCustomCommand(node: any, dry: any)

Text:processInitialNodes()

Text:processModifier(node: any, dry: any)

Text:processNode(node: any, dry: any)

Text:processStyle(style: any)

Text:registerCommand(command: any, func: any, options: any)

Text:resetState()

Text:setText(text: any)

Text:setTextColor(r: any, g: any, b: any, a: any)

Text:textToNodes(input_string: any)

Text:update()

Fields

Undocumented

Text.COLORS: table

Text.COMMANDS: table

Text.align: string

Text.alignment_offset: table

Text.alignment_offset: table

Text.alignment_offset: table

Text.auto_size: boolean

Text.canvas: unknown

Text.canvas: unknown

Text.custom_command_dry: table

Text.custom_commands: table

Text.default_height: integer

Text.default_width: integer

Text.display_text: string

Text.draw_every_frame: boolean

Text.draw_every_frame: boolean

Text.draw_every_frame: boolean

Text.draw_every_frame: boolean

Text.draw_every_frame: boolean

Text.font: string

Text.font_size: nil

Text.height: unknown

Text.height: integer

Text.indent_string: string

Text.last_shake: integer

Text.line_offset: integer

Text.nodes: table

Text.nodes_to_draw: table

Text.nodes_to_draw: table

Text.preprocess: boolean

Text.preprocess: boolean

Text.set_text_without_stage: boolean

Text.set_text_without_stage: boolean

Text.set_text_without_stage: boolean

Text.set_text_without_stage: boolean

Text.sprites: table

Text.sprites: table

Text.state: table

Text.state: table|unknown

Text.state: nil

Text.state: table|unknown

Text.state: table|nil

Text.state: table|unknown|nil

Text.style: string