HomeWikiSourceDownloadsDiscord

Kristal Wiki


General Information

These pages get you ready to use the engine.


General Project Creation

These pages teach you about project 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 Project Creation

These pages teach you about project 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 ⮭

BattleDarkener

┗> Object > Class


The battle darkener object, used to darken the background while the enemy attacks.

This gets automatically spawned during battles; if you'd like to disable or customize it, override Encounter:createBattleDarkener.


Constructor




Methods





Fields

BattleDarkener.fading_out: boolean

Whether the background is currently fading out or not.

BattleDarkener.move_speed: number

The speed at which the background scrolls.

BattleDarkener.position: number

An offset used to scroll the background.

BattleDarkener.position2: number

Another offset used to scroll the background.


Undocumented