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⮭

BattleCutscene

┗> Cutscene > Class

Constructor

BattleCutscene(group: any, id: any, : unknown)

Arguments:

group: any
id: any
: unknown

Methods

BattleCutscene:battlerText(battlers: any, text: any, options: any)

Arguments:

battlers: any
text: any
options: any

Returns:

1: function\|nil
2: table\|nil

BattleCutscene:choicer(choices: any, options: any)

Arguments:

choices: any
options: any

Returns:

1: function\|nil
2: Choicebox\|nil

BattleCutscene:closeText()

BattleCutscene:fadeIn(speed: any, options: any)

Arguments:

speed: any
options: any

Returns:

1: function

BattleCutscene:fadeOut(speed: any, options: any)

Arguments:

speed: any
options: any

Returns:

1: function

BattleCutscene:getCharacter(id: any)

Arguments:

id: any

Returns:

1: unknown

BattleCutscene:getEnemies(id: any)

Arguments:

id: any

Returns:

1: table

BattleCutscene:getTarget()

Returns:

1: unknown

BattleCutscene:getUser()

Returns:

1: unknown

BattleCutscene:moveTo(chara: any, x: any, y: any, speed: any)

Arguments:

chara: any
x: any
y: any
speed: any

Returns:

1: function

BattleCutscene:onEnd()

BattleCutscene:resetSprites()

BattleCutscene:setAnimation(chara: any, anim: any)

Arguments:

chara: any
anim: any

Returns:

1: function

BattleCutscene:setSpeaker(actor: any)

Arguments:

actor: any

BattleCutscene:setSprite(chara: any, sprite: any, speed: any)

Arguments:

chara: any
sprite: any
speed: any

BattleCutscene:shakeCamera(x: any, y: any, friction: any)

Arguments:

x: any
y: any
friction: any

Returns:

1: function

BattleCutscene:shakeCharacter(chara: any, x: any, y: any, friction: any, delay: any)

Arguments:

chara: any
x: any
y: any
friction: any
delay: any

Returns:

1: function

BattleCutscene:slideTo(obj: any, x: any, y: any, time: any, ease: any)

Arguments:

obj: any
x: any
y: any
time: any
ease: any

Returns:

1: function

BattleCutscene:slideToSpeed(obj: any, x: any, y: any, speed: any)

Arguments:

obj: any
x: any
y: any
speed: any

Returns:

1: function

BattleCutscene:text(text: any, portrait: any, actor: any, options: any)

Arguments:

text: any
portrait: any
actor: any
options: any

Kristal Wiki

Getting Started

General Mod Creation

The Overworld

Battles

API Reference

BattleCutscene

┗> Cutscene > Class

Constructor

BattleCutscene(group: any, id: any, : unknown)

Methods

BattleCutscene:battlerText(battlers: any, text: any, options: any)

BattleCutscene:choicer(choices: any, options: any)

BattleCutscene:closeText()

BattleCutscene:fadeIn(speed: any, options: any)

BattleCutscene:fadeOut(speed: any, options: any)

BattleCutscene:getCharacter(id: any)

BattleCutscene:getEnemies(id: any)

BattleCutscene:getTarget()

BattleCutscene:getUser()

BattleCutscene:moveTo(chara: any, x: any, y: any, speed: any)

BattleCutscene:onEnd()

BattleCutscene:resetSprites()

BattleCutscene:setAnimation(chara: any, anim: any)

BattleCutscene:setSpeaker(actor: any)

BattleCutscene:setSprite(chara: any, sprite: any, speed: any)

BattleCutscene:shakeCamera(x: any, y: any, friction: any)

BattleCutscene:shakeCharacter(chara: any, x: any, y: any, friction: any, delay: any)

BattleCutscene:slideTo(obj: any, x: any, y: any, time: any, ease: any)

BattleCutscene:slideToSpeed(obj: any, x: any, y: any, speed: any)

BattleCutscene:text(text: any, portrait: any, actor: any, options: any)

BattleCutscene:update()

Fields

Undocumented

BattleCutscene.changed_sprite: table

BattleCutscene.changed_sprite: table

BattleCutscene.last_battle_state: any

BattleCutscene.move_targets: table

BattleCutscene.move_targets: table

BattleCutscene.textbox_actor: any

BattleCutscene.waiting_for_enemy_text: nil

BattleCutscene.waiting_for_text: nil