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

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

Arguments:

group: any
id: any
: unknown



Methods

WorldCutscene:alignFollowers(facing: any, x: any, y: any, dist: any)

Arguments:

facing: any
x: any
y: any
dist: any

WorldCutscene:attachCamera(time: any)

Arguments:

time: any

Returns:

1: fun( WorldCutscene)


WorldCutscene:attachFollowers(return_speed: any)

Arguments:

return_speed: any

Returns:

1: function



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

Arguments:

choices: any
options: any

Returns:

1: function|nil
2: Choicebox|nil






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

Arguments:

speed: any
options: any

Returns:

1: function

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

Arguments:

speed: any
options: any

Returns:

1: function

WorldCutscene:getCharacter(id: any, index: any)

Arguments:

id: any
index: any

Returns:

1: unknown|nil

WorldCutscene:getEvent(id: any)

Arguments:

id: any

Returns:

1: unknown|nil

WorldCutscene:getEvents(name: any)

Arguments:

name: any

Returns:

1: table|nil

WorldCutscene:getMarker(name: any)

Arguments:

name: any

Returns:

1: number|nil
2: number|nil



WorldCutscene:jumpTo(chara: any, : unknown)

Arguments:

chara: any
: unknown

Returns:

1: function


WorldCutscene:look(chara: any, dir: any)

Arguments:

chara: any
dir: any



WorldCutscene:panTo(: unknown)

Arguments:

: unknown

Returns:

1: function


WorldCutscene:resetSprite(chara: any)

Arguments:

chara: any


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

Arguments:

chara: any
anim: any

Returns:

1: function

WorldCutscene:setSpeaker(actor: any, talk: any)

Arguments:

actor: any
talk: any

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

Arguments:

chara: any
sprite: any
speed: any

WorldCutscene:setTextboxTop(top: any)

Arguments:

top: any

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

Arguments:

x: any
y: any
friction: any

Returns:

1: function

WorldCutscene: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


WorldCutscene:slidePath(obj: any, path: any, options: any)

Arguments:

obj: any
path: any
options: any

Returns:

1: function

WorldCutscene: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

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

Arguments:

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

Returns:

1: function

WorldCutscene:spawnNPC(actor: any, x: any, y: any, properties: any)

Arguments:

actor: any
x: any
y: any
properties: any

Returns:

1: unknown|nil

WorldCutscene:spin(chara: any, speed: any)

Arguments:

chara: any
speed: any

WorldCutscene:startEncounter(encounter: any, transition: any, enemy: any, options: any)

Arguments:

encounter: any
transition: any
enemy: any
options: any

Returns:

1: function|nil
2: Encounter|nil

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

Arguments:

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

Returns:

1: function|nil
2: Textbox|nil

WorldCutscene:textChoicer(text: any, choices: any, portrait: any, actor: any, options: any)

Arguments:

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

Returns:

1: function|nil
2: TextChoicebox|nil


WorldCutscene:walkPath(chara: any, path: any, options: any)

Arguments:

chara: any
path: any
options: any

Returns:

1: function

WorldCutscene:walkTo(chara: any, x: any, y: any, time: any, facing: any, keep_facing: any, ease: any, after: any)

Arguments:

chara: any
x: any
y: any
time: any
facing: any
keep_facing: any
ease: any
after: any

Returns:

1: function

WorldCutscene:walkToSpeed(chara: any, x: any, y: any, speed: any, facing: any, keep_facing: any, after: any)

Arguments:

chara: any
x: any
y: any
speed: any
facing: any
keep_facing: any
after: any

Returns:

1: function


Fields


Undocumented