Kristal Wiki

The Stage object in Kristal is designed to be the highest parent object at all times.
All throughout gameplay, the active stage is Game.stage, while when in the Kristal menu, Kristal.Stage is the stage instead.

Component:onFocused()

Component:onRemoveFromStage(stage: Object)

Arguments:

stage: Object

The base class of all objects in Kristal.
When added to the stage, an object will be updated and rendered.

Component:onUnfocused()

Component:reflow(ignore: Component?)

Arguments:

ignore: Component?

Component:setFocused()

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:setScrollbar(scrollbar: ScrollbarComponent)

Arguments:

scrollbar: ScrollbarComponent

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

Arguments:

x_sizing: Sizing?
y_sizing: Sizing?

Kristal Wiki

Kristal Wiki

┗> Object > Class

Constructor

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

Methods

Component:draw()

Component:getComponents()

Component:getDebugInfo()

Component:getInnerHeight()

Component:getInnerSize()

Component:getInnerWidth()

Component:getScaledMargins()

Component:getScaledPadding()

Component:getScrollbarGutter()

Component:getScrollbarPosition()

Component:getTotalHeight()

Component:getTotalSize()

Component:getTotalWidth()

Component:getWorkingSize()

Component:isFocused()

Component:onAddToStage(stage: Stage)

Component:onFocused()

Component:onRemoveFromStage(stage: Object)

Component:onUnfocused()

Component:reflow(ignore: Component?)

Component:setFocused()

Component:setLayout(layout: Layout)

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

Component:setOverflow(overflow: string)

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

Component:setScrollbar(scrollbar: ScrollbarComponent)

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

Component:setUnfocused()

Component:update()

Fields

Component.layout: Layout

Component.margins: number[]

Component.overflow: string|"hidden"|"scroll"|"visible"

Component.padding: number[]

Component.scrollbar: ScrollbarComponent

Component.x_sizing: Sizing

Component.y_sizing: Sizing

Undocumented

Component.height: number

Component.old_height: number

Component.old_width: number

Component.scroll_x: integer

Component.scroll_y: integer

Component.width: number