HomeWikiSourceDownloadsDiscord

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⮭

Constructor

Battler(x: any, y: any, width: any, height: any)

Arguments:

x: any
y: any
width: any
height: any



Methods

Battler:flash(sprite: any, offset_x: any, offset_y: any, layer: any)

Arguments:

sprite: any
offset_x: any
offset_y: any
layer: any


Battler:onBubbleRemove(bubble: any)

Arguments:

bubble: any

Battler:onBubbleSpawn(bubble: any)

Arguments:

bubble: any

Battler:recruitMessage(x: any, y: any, type: any)

Arguments:

x: any
y: any
type: any

Returns:

1: RecruitMessage

Battler:setActor(actor: any, use_overlay: any)

Arguments:

actor: any
use_overlay: any

Battler:setAnimation(animation: any, callback: any)

Shorthand for convenience

Arguments:

animation: any
callback: any

Returns:

1: boolean|nil

Battler:setCustomSprite(sprite: any, ox: any, oy: any, speed: any, loop: any, after: any)

Arguments:

sprite: any
ox: any
oy: any
speed: any
loop: any
after: any

Battler:sparkle(r: any, g: any, b: any)

Arguments:

r: any
g: any
b: any

Battler:spawnSpeechBubble(text: any, options: any)

Arguments:

text: any
options: any

Returns:

1: SpeechBubble

Battler:statusMessage(x: any, y: any, type: any, arg: any, color: any, kill: any)

Arguments:

x: any
y: any
type: any
arg: any
color: any
kill: any

Returns:

1: DamageNumber

Battler:toggleOverlay(overlay: any)

Arguments:

overlay: any



Fields


Undocumented






Battler.dialogue_bubble: nil

Speech bubble style - defaults to "round" or "cyber", depending on chapter