Kristal Wiki

General Information

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

General Information

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⮭

ContextMenu

┗> Object > Class

Constructor

ContextMenu(name: any)

Arguments:

name: any

Methods

ContextMenu:addMenuItem(name: any, description: any, callback: any, options: any)

Arguments:

name: any
description: any
callback: any
options: any

ContextMenu:adjustToCorner()

ContextMenu:calculateSize()

ContextMenu:close()

ContextMenu:draw()

ContextMenu:getHorizontalPadding()

Returns:

1: integer

ContextMenu:getInnerHeight()

Returns:

1: unknown

ContextMenu:getInnerWidth()

Returns:

1: unknown

ContextMenu:getLocalMousePosition()

Returns:

1: number
2: number

ContextMenu:getScreenBounds()

Returns:

1: number
2: number
3: number
4: number

ContextMenu:getVerticalPadding()

Returns:

1: integer

ContextMenu:isMouseOver(x1: any, y1: any, x2: any, y2: any)

Arguments:

x1: any
y1: any
x2: any
y2: any

Returns:

1: boolean

ContextMenu:keepInBounds()

ContextMenu:onMousePressed(x: any, y: any, button: any, istouch: any, presses: any)

Arguments:

x: any
y: any
button: any
istouch: any
presses: any

Returns:

1: boolean

ContextMenu:onMouseReleased(x: any, y: any, button: any, istouch: any, presses: any)

Arguments:

x: any
y: any
button: any
istouch: any
presses: any

Kristal Wiki

Kristal Wiki

┗> Object > Class

Constructor

ContextMenu(name: any)

Methods

ContextMenu:addMenuItem(name: any, description: any, callback: any, options: any)

ContextMenu:adjustToCorner()

ContextMenu:calculateSize()

ContextMenu:close()

ContextMenu:draw()

ContextMenu:getHorizontalPadding()

ContextMenu:getInnerHeight()

ContextMenu:getInnerWidth()

ContextMenu:getLocalMousePosition()

ContextMenu:getScreenBounds()

ContextMenu:getVerticalPadding()

ContextMenu:isMouseOver(x1: any, y1: any, x2: any, y2: any)

ContextMenu:keepInBounds()

ContextMenu:onMousePressed(x: any, y: any, button: any, istouch: any, presses: any)

ContextMenu:onMouseReleased(x: any, y: any, button: any, istouch: any, presses: any)

ContextMenu:update()

Fields

Undocumented

ContextMenu.adjusted: boolean

ContextMenu.adjusted: boolean

ContextMenu.adjusted: boolean

ContextMenu.anim_timer: integer

ContextMenu.anim_timer: number

ContextMenu.anim_timer: number

ContextMenu.anim_timer: number

ContextMenu.closing: boolean

ContextMenu.closing: boolean

ContextMenu.font: love.Font

ContextMenu.font_name: string

ContextMenu.font_size: integer

ContextMenu.grab_offset_x: integer

ContextMenu.grab_offset_x: unknown

ContextMenu.grab_offset_y: integer

ContextMenu.grab_offset_y: unknown

ContextMenu.grabbing: boolean

ContextMenu.grabbing: boolean

ContextMenu.grabbing: boolean

ContextMenu.height: unknown

ContextMenu.items: table

ContextMenu.layer: integer

ContextMenu.name: any

ContextMenu.width: unknown

ContextMenu.x: number

ContextMenu.y: number