Kristal Wiki

Getting Started

These pages get you ready to use the engine.

Downloading Kristal
Installing and Playing Mods

General Mod Creation

These pages teach you about mod development.

Understanding the Basics
Creating a Mod
Using Libraries
Creating an Item
Creating a Spell
Actors
Party Members
Custom Keybinds
The UI System

The Overworld

Everything to do with the overworld.

Designing a Map
Cutscenes

Battles

Everything related to creating battles.

Battlers
Encounters

API Reference

An auto-generated API reference for Kristal.

⮬Back to Top⮭

ActionButton

┗> Object > Class

Constructor

ActionButton(type: any, battler: any, x: any, y: any)

Arguments:

type: any
battler: any
x: any
y: any

Methods

ActionButton:draw()

ActionButton:hasSpecial()

Returns:

1: boolean

ActionButton:select()

ActionButton:unselect()

Fields

Undocumented

ActionButton.battler: any

ActionButton.height: number

ActionButton.hovered: boolean

ActionButton.hovered_texture: love.Image|nil

Drawable image type.

Open in Browser

ActionButton.selectable: boolean

ActionButton.special_texture: love.Image|nil

Drawable image type.

Open in Browser

ActionButton.texture: love.Image|nil

Drawable image type.

Open in Browser

Kristal Wiki

Getting Started

General Mod Creation

The Overworld

Battles

API Reference

ActionButton

┗> Object > Class

Constructor

ActionButton(type: any, battler: any, x: any, y: any)

Methods

ActionButton:draw()

ActionButton:hasSpecial()

ActionButton:select()

ActionButton:unselect()

Fields

Undocumented

ActionButton.battler: any

ActionButton.height: number

ActionButton.hovered: boolean

ActionButton.hovered_texture: love.Image|nil

ActionButton.selectable: boolean

ActionButton.special_texture: love.Image|nil

ActionButton.texture: love.Image|nil

ActionButton.type: any

ActionButton.width: number