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.

API Reference

An auto-generated API reference for Kristal.

⮬Back to Top⮭

GonerChoice

┗> Object > Class

Constructor

GonerChoice(x: any, y: any, choices: any, on_complete: any, on_select: any)

Arguments:

x: any
y: any
choices: any
on_complete: any
on_select: any

Methods

GonerChoice:clampSelection()

GonerChoice:draw()

GonerChoice:finish(callback: any)

Arguments:

callback: any

GonerChoice:getChoice(x: any, y: any)

Arguments:

x: any
y: any

Returns:

1: unknown
2: unknown
3: unknown

GonerChoice:getChoiceText(choice: any, x: any, y: any)

Arguments:

choice: any
x: any
y: any

Returns:

1: unknown

GonerChoice:getSoulTarget(choice: any, x: any, y: any)

Arguments:

choice: any
x: any
y: any

Returns:

1: number
2: integer

GonerChoice:isHidden(choice: any, x: any, y: any)

Arguments:

choice: any
x: any
y: any

Returns:

1: boolean

GonerChoice:moveSelection(x: any, y: any, dx: any, dy: any)

Arguments:

x: any
y: any
dx: any
dy: any

GonerChoice:onCancel(choice: any, x: any, y: any)

Arguments:

choice: any
x: any
y: any

GonerChoice:onComplete(choice: any, x: any, y: any)

Arguments:

choice: any
x: any
y: any

GonerChoice:onHover(choice: any, x: any, y: any)

Arguments:

choice: any
x: any
y: any

GonerChoice:onSelect(choice: any, x: any, y: any)

Arguments:

choice: any
x: any
y: any

GonerChoice:resetSize()

GonerChoice:resetSoulPosition()

GonerChoice:resetSoulTarget()

GonerChoice:select(x: any, y: any)

Arguments:

x: any
y: any

GonerChoice:setChoice(x: any, y: any, choice: any)

Arguments:

x: any
y: any
choice: any

GonerChoice:setChoices(choices: any, selected_x: any, selected_y: any)

Arguments:

choices: any
selected_x: any
selected_y: any

GonerChoice:setSelectedOption(x: any, y: any, move_soul: any)

Arguments:

x: any
y: any
move_soul: any

GonerChoice:setSoulOffset(x: any, y: any)

Arguments:

x: any
y: any

GonerChoice:setSoulOrigin(ox: any, oy: any)

Arguments:

ox: any
oy: any

GonerChoice:setSoulPosition(x: any, y: any, set_target: any)

Arguments:

x: any
y: any
set_target: any

GonerChoice:setSoulTarget(x: any, y: any)

Arguments:

x: any
y: any

GonerChoice:setWrap(x: any, y: any)

Arguments:

x: any
y: any

GonerChoice:update()

Fields

Undocumented

GonerChoice.alpha: integer

GonerChoice.alpha: number

GonerChoice.cancel_repeat: boolean

GonerChoice.choice: nil

GonerChoice.choice: unknown

GonerChoice.choice_x: nil

GonerChoice.choice_x: any

GonerChoice.choice_y: nil

GonerChoice.choice_y: any

GonerChoice.choices: any

GonerChoice.done: boolean

GonerChoice.font: love.Font|nil

Defines the shape of characters that can be drawn onto the screen.

Open in Browser

GonerChoice.height: integer

GonerChoice.on_cancel: nil

GonerChoice.on_complete: any

GonerChoice.on_hover: nil

GonerChoice.on_select: any

GonerChoice.selected_x: integer

GonerChoice.selected_x: any

GonerChoice.selected_x: number

GonerChoice.selected_x: unknown

GonerChoice.selected_y: integer

GonerChoice.selected_y: any

GonerChoice.selected_y: number

GonerChoice.selected_y: unknown

GonerChoice.soul: Sprite

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

GonerChoice.soul_align: string

GonerChoice.soul_offset_x: integer

GonerChoice.soul_offset_x: any

GonerChoice.soul_offset_y: integer

GonerChoice.soul_offset_y: any

GonerChoice.soul_origin_x: any

GonerChoice.soul_origin_y: any

GonerChoice.soul_speed: number

GonerChoice.soul_target_x: integer

GonerChoice.soul_target_x: any

GonerChoice.soul_target_y: integer

GonerChoice.soul_target_y: any

GonerChoice.state: string

FADEIN, CHOICE, FADEOUT