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.


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

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.


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⮭

OverworldSoul

┗> Object > Class


The soul of the player used when in the Overworld.
The Overworld soul defines the player's hitbox against bullets in the Overworld and controls taking damage from them - as such it is only visible if inside a battle area.


Constructor

OverworldSoul(x: any, y: any)

Arguments:

x: any
y: any



Methods



OverworldSoul:onAdd(parent: any)

Arguments:

parent: any

OverworldSoul:onCollide(bullet: WorldBullet)

(Override) Called whenever a bullet hits the soul
By default, calls bullet:onCollide() which handles the soul taking damage

Arguments:

bullet: WorldBullet

The class that all World bullets in Kristal originate from.
Generic bullets can be spawned into the world with Game.world:spawnBullet(texture, x, y)
Files in scripts/world/bullets will also be loaded as world bullets and should Extend this class. Extension bullets can be spawned into the world with Game.world:spawnBullet(id, ...) - their id defaults to their filepath, starting from scripts/world/bullets. Additional arguments ... are passed into the bullet type's init function.


OverworldSoul:onRemove(parent: any)

Arguments:

parent: any



Fields

OverworldSoul.collider: CircleCollider

The hitbox of the soul, defaulting to a circle with an 8 pixel radius


Undocumented