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⮭

Forcefield

┗> Event > Object > Class


Constructor


Forcefield(x: any, y: any, w: any, h: any, properties: any)

Arguments:

x: any
y: any
w: any
h: any
properties: any




Methods


Forcefield:draw()



Forcefield:onInteract(player: any, dir: any)

Arguments:

player: any
dir: any

Returns:

1: boolean


Forcefield:update()



Forcefield:updateActive()



Forcefield:updateSize()




Fields



Undocumented



Forcefield.alpha: integer



Forcefield.alpha: number



Forcefield.always_visible: boolean



Forcefield.anim_speed: number



Forcefield.anim_timer: integer



Forcefield.anim_timer: number



Forcefield.collidable: boolean



Forcefield.collidable: boolean



Forcefield.dir: string



Forcefield.dir: string



Forcefield.dir: string



Forcefield.end_sprite: love.Image[]|nil



Forcefield.end_x: number



Forcefield.end_x: number



Forcefield.end_x: number



Forcefield.end_y: number



Forcefield.end_y: number



Forcefield.end_y: number



Forcefield.flag: string



Forcefield.flag_value: any



Forcefield.inverted: boolean



Forcefield.middle_sprite: love.Image[]|nil



Forcefield.single_sprite: love.Image[]|nil



Forcefield.solid: boolean



Forcefield.start_x: number



Forcefield.start_x: integer



Forcefield.start_x: number



Forcefield.start_y: number



Forcefield.start_y: number



Forcefield.start_y: integer



Forcefield.visible: boolean



Forcefield.visible: boolean


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