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

Component(x_sizing: Sizing?, y_sizing: Sizing?, options: table?)

Arguments:

x_sizing: Sizing?
y_sizing: Sizing?
options: table?



Methods


Component:getComponents()

Returns:

components: Object[]



Component:getInnerSize()

Returns:

width: number
height: number


Component:getScaledMargins()

Returns:

left: number
top: number
right: number
bottom: number

Component:getScaledPadding()

Returns:

left: number
top: number
right: number
bottom: number




Component:getTotalSize()

Returns:

width: number
height: number


Component:getWorkingSize()

Returns:

width: number
height: number


Component:onAddToStage(stage: Stage)

Arguments:

stage: Stage


Component:onRemoveFromStage(stage: any)

Arguments:

stage: any


Component:reflow(ignore: Component?)

Arguments:

ignore: Component?


Component:setLayout(layout: Layout)

Arguments:

layout: Layout

Component:setMargins(left: number, top: number, right: number, bottom: number)

Arguments:

left: number
top: number
right: number
bottom: number

Component:setOverflow(overflow: string)

Arguments:

overflow: string

Component:setPadding(left: number, top: number, right: number, bottom: number)

Arguments:

left: number
top: number
right: number
bottom: number


Component:setSizing(x_sizing: Sizing?, y_sizing: Sizing?)

Arguments:

x_sizing: Sizing?
y_sizing: Sizing?




Fields


Undocumented