HomeWikiSourceDownloadsDiscord

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⮭

OverworldSoul

┗> Object > Class


Constructor


OverworldSoul(x: any, y: any)

Arguments:

x: any
y: any




Methods


OverworldSoul:canDebugSelect()

Returns:

1: boolean


OverworldSoul:draw()



OverworldSoul:onAdd(parent: any)

Arguments:

parent: any


OverworldSoul:onCollide(bullet: any)

Arguments:

bullet: any


OverworldSoul:onRemove(parent: any)

Arguments:

parent: any


OverworldSoul:update()




Fields



Undocumented



OverworldSoul.alpha: integer



OverworldSoul.alpha: integer



OverworldSoul.collider: CircleCollider



OverworldSoul.debug_rect: table



OverworldSoul.inv_flash_timer: integer



OverworldSoul.inv_flash_timer: number



OverworldSoul.inv_flash_timer: integer



OverworldSoul.inv_timer: integer



OverworldSoul.inv_timer: number



OverworldSoul.sprite: Sprite

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



OverworldSoul.target_lerp: integer



OverworldSoul.world: any



OverworldSoul.world: nil



OverworldSoul.x: unknown



OverworldSoul.y: unknown


DELTARUNE by Toby Fox. Website designed by NyakoFox. © 2023 Kristal Team. All rights reserved.