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

PartyBattler(chara: any, x: any, y: any)

Arguments:

chara: any
x: any
y: any



Methods

PartyBattler:calculateDamage(amount: any)

Arguments:

amount: any

Returns:

1: unknown

PartyBattler:calculateDamageSimple(amount: any)

Arguments:

amount: any

Returns:

1: integer





PartyBattler:flash(sprite: any, offset_x: any, offset_y: any, layer: any)

Arguments:

sprite: any
offset_x: any
offset_y: any
layer: any

PartyBattler:getElementReduction(element: any)

Arguments:

element: any

Returns:

1: number


PartyBattler:heal(amount: any, sparkle_color: any, show_up: any)

Arguments:

amount: any
sparkle_color: any
show_up: any

PartyBattler:hurt(amount: any, exact: any, color: any, options: any)

Arguments:

amount: any
exact: any
color: any
options: any




PartyBattler:removeHealth(amount: any)

Arguments:

amount: any

PartyBattler:removeHealthBroken(amount: any)

Arguments:

amount: any



PartyBattler:setActSprite(sprite: any, ox: any, oy: any, speed: any, loop: any, after: any)

Arguments:

sprite: any
ox: any
oy: any
speed: any
loop: any
after: any

PartyBattler:setSleeping(sleeping: any)

Arguments:

sleeping: any

PartyBattler:setSprite(sprite: any, speed: any, loop: any, after: any)

Arguments:

sprite: any
speed: any
loop: any
after: any


PartyBattler:toggleOverlay(overlay: any)

Arguments:

overlay: any



Fields


Undocumented



























PartyBattler.target_sprite: Sprite

A simple object that renders a texture.
This texture must be placed inside assets/sprites/.