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⮭

ArenaSprite

┗> Object > Class


A special object used to draw the arena to the screen.


Constructor

ArenaSprite(arena: Arena, x: number?, y: number?)

Arguments:

arena: Arena

The region that the player is confined to within waves in a battle. Usually accessed through Game.battle.arena, which is only set during waves.

x: number?
y: number?



Methods

ArenaSprite:canDeepCopyKey(key: any)

Arguments:

key: any

Returns:

1: boolean





Fields

ArenaSprite.arena: Arena

The arena this Object is drawing.

ArenaSprite.background: boolean

Whether to draw the arena's background.


Undocumented