HomeWikiSourceDownloadsDiscord

Kristal Wiki

General Information

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.


Advanced

These pages teach you more complex but powerful parts of the engine.


API Reference

An auto-generated API reference for Kristal.

⮬Back to Top⮭

Kristal Wiki

General Information

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.


Advanced

These pages teach you more complex but powerful parts of the engine.


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
2: number
3: number
4: number




Fields

FXBase.active: boolean

Whether this FX should be processed

FXBase.id: string

Identifier for this FX

FXBase.parent: Object

Object this FX is attached to

FXBase.priority: number

Higher number = higher priority (processed last)

FXBase.transformed: boolean

Whether this FX should be transformed by the object (scaled, rotated, etc)


Undocumented