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⮭

Arena

┗> Object > Class


Constructor


Arena(x: any, y: any, shape: any)

Arguments:

x: any
y: any
shape: any




Methods


Arena:draw()



Arena:drawMask()



Arena:getBackgroundColor()

Returns:

1: table


Arena:getBottom()

Returns:

1: number


Arena:getBottomLeft()

Returns:

1: number
2: number


Arena:getBottomRight()

Returns:

1: number
2: number


Arena:getCenter()

Returns:

1: number
2: number


Arena:getLeft()

Returns:

1: number


Arena:getRight()

Returns:

1: number


Arena:getTop()

Returns:

1: number


Arena:getTopLeft()

Returns:

1: number
2: number


Arena:getTopRight()

Returns:

1: number
2: number


Arena:onAdd(parent: any)

Arguments:

parent: any


Arena:onRemove(parent: any)

Arguments:

parent: any


Arena:setBackgroundColor(r: any, g: any, b: any, a: any)

Arguments:

r: any
g: any
b: any
a: any


Arena:setShape(shape: any)

Arguments:

shape: any


Arena:setSize(width: any, height: any)

Arguments:

width: any
height: any


Arena:update()




Fields



Undocumented



Arena.area_collider: PolygonCollider



Arena.bg_color: table



Arena.bg_color: table



Arena.border_line: table



Arena.bottom: integer



Arena.clockwise: boolean



Arena.collider: ColliderGroup



Arena.color: table



Arena.height: unknown



Arena.left: integer



Arena.line_width: integer

must call setShape again if u change this



Arena.mask: ArenaMask



Arena.processed_height: unknown



Arena.processed_shape: any



Arena.processed_width: unknown



Arena.right: integer



Arena.shape: any



Arena.sprite: ArenaSprite



Arena.top: integer



Arena.triangles: table



Arena.width: unknown



Arena.x: integer



Arena.y: integer


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