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

FXBase(priority: any)

Arguments:

priority: any



Methods

FXBase.SORTER(a: any, b: any)

Arguments:

a: any
b: any

Returns:

1: boolean


FXBase:canDeepCopyKey(key: any)

Arguments:

key: any

Returns:

1: boolean

FXBase:draw(texture: any)

Arguments:

texture: any

FXBase:getObjectBounds(shader: any)

Arguments:

shader: any

Returns:

1: number|unknown
2: number|unknown
3: number
4: number




Fields


Undocumented


FXBase.active: boolean

Whether this FX should be processed


FXBase.id: nil

Identifier for this FX


FXBase.parent: nil

Object this FX is attached to


FXBase.priority: any

Higher number = higher priority (processed last)


FXBase.transformed: boolean

Whether this FX should be transformed by the object (scaled, rotated, etc) Note: This will always have lower priority than non-transformed FX