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

Soul(x: any, y: any, color: any)

Arguments:

x: any
y: any
color: any



Methods



Soul:getExactPosition(x: any, y: any)

Arguments:

x: any
y: any

Returns:

1: number
2: number

Soul:isMoving()

Returns:

1: boolean

Soul:move(x: any, y: any, speed: any)

Arguments:

x: any
y: any
speed: any

Returns:

1: boolean|nil
2: boolean

Soul:moveX(amount: any, move_y: any)

Arguments:

amount: any
move_y: any

Returns:

1: boolean|nil
2: boolean|nil

Soul:moveXExact(amount: any, move_y: any)

Arguments:

amount: any
move_y: any

Returns:

1: boolean
2: Arena|nil

Soul:moveY(amount: any, move_x: any)

Arguments:

amount: any
move_x: any

Returns:

1: boolean|nil
2: boolean|nil

Soul:moveYExact(amount: any, move_x: any)

Arguments:

amount: any
move_x: any

Returns:

1: boolean
2: Arena|nil

Soul:onCollide(bullet: any)

Arguments:

bullet: any

Soul:onDamage(bullet: any, amount: any)

Arguments:

bullet: any
amount: any

Soul:onRemove(parent: any)

Arguments:

parent: any

Soul:onSquished(solid: any)

Arguments:

solid: any


Soul:setExactPosition(x: any, y: any)

Arguments:

x: any
y: any

Soul:shatter(count: any)

Arguments:

count: any

Soul:transitionTo(x: any, y: any, should_destroy: any)

Arguments:

x: any
y: any
should_destroy: any



Fields


Undocumented







































Soul.partial_x: number

1px movement increments














Soul.sprite: Sprite

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