HomeWikiSourceDownloadsDiscord

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⮭

Constructor




Methods

Shop:addMoney(amount: any)

Arguments:

amount: any

Shop:buyItem(current_item: any)

Arguments:

current_item: any



Shop:drawBonuses(party_member: any, old_item: any, bonuses: any, stat: any, x: any, y: any)

Arguments:

party_member: any
old_item: any
bonuses: any
stat: any
x: any
y: any

Shop:enterSellMenu(sell_data: any)

Arguments:

sell_data: any

Shop:getFlag(name: any, default: any)

Arguments:

name: any
default: any

Returns:

1: unknown|nil

Shop:getMoney()

Returns:

1: unknown

Shop:getState()

Returns:

1: string

Shop:getVoice()

Returns:

1: unknown

Shop:getVoicedText(text: any)

Arguments:

text: any

Returns:

1: table|unknown



Shop:onEmote(emote: any)

Arguments:

emote: any


Shop:onKeyPressed(key: any, is_repeat: any)

Arguments:

key: any
is_repeat: any


Shop:onRemove(parent: any)

Arguments:

parent: any

Shop:onStateChange(old: any, new: any)

Arguments:

old: any
new: any




Shop:registerItem(item: any, options: any)

Arguments:

item: any
options: any

Returns:

1: boolean|nil

Shop:registerTalk(talk: any, color: any)

Arguments:

talk: any
color: any

Shop:registerTalkAfter(talk: any, index: any, flag: any, value: any, color: any)

Arguments:

talk: any
index: any
flag: any
value: any
color: any

Shop:removeMoney(amount: any)

Arguments:

amount: any

Shop:replaceItem(index: any, item: any, options: any)

Arguments:

index: any
item: any
options: any

Returns:

1: boolean

Shop:replaceTalk(talk: any, index: any, color: any)

Arguments:

talk: any
index: any
color: any

Shop:sellItem(current_item: any)

Arguments:

current_item: any

Shop:setDialogueText(text: any, no_voice: any)

Arguments:

text: any
no_voice: any

Shop:setFlag(name: any, value: any)

Arguments:

name: any
value: any

Shop:setMoney(amount: any)

Arguments:

amount: any

Shop:setRightText(text: any, no_voice: any)

Arguments:

text: any
no_voice: any

Shop:setState(state: any, reason: any)

Arguments:

state: any
reason: any

Shop:startDialogue(text: any, callback: any)

Arguments:

text: any
callback: any

Shop:startTalk(talk: any)

Arguments:

talk: any



Fields


Undocumented




Shop.background_sprite: Sprite

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

























Shop.buy_confirmation_text: string

Shown when you're about to buy something.







Shop.buy_menu_text: string

Shown when you're in the BUY menu


Shop.buy_no_space_text: string

Shown when you don't have enough space to buy something.


Shop.buy_refuse_text: string

Shown when you refuse to buy something


Shop.buy_storage_text: string

Shown when you buy something and it goes in your storage


Shop.buy_text: string

Shown when you buy something


Shop.buy_too_expensive_text: string

Shown when you don't have enough money to buy something


Shop.currency_text: string













Shop.current_selecting_choice: integer

self.current_selecting will be in use... so let's just add another????????








Shop.dialogue_text: DialogueText


Shop.encounter_text: string

Shown when you first enter a shop






Shop.font: love.Font|nil

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

Open in Browser




Shop.hide_storage_text: boolean





















Shop.large_box: UIBox

Construct the UI



Shop.leaving_text: string

Shown when you leave a shop



Shop.main_current_selecting: integer

This'll be a separate variable because it keeps track of what you selected between main menu options. This can normally be done with hardcoded position sets, like in other places, but in the Spamton shop in Deltarune, SELL is replaced with BUYMORE!!!, and when you exit out of that menu, it places you on the correct menu option.








Shop.plain_font: love.Font|nil

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

Open in Browser



Shop.right_text: DialogueText


Shop.sell_confirmation_text: string

Shown when you're about to sell something.












Shop.sell_menu_text: string

Shown when you're in the SELL menu


Shop.sell_no_price_text: string

Shown when something doesn't have a sell price


Shop.sell_no_storage_text: string

Shown when you have nothing in a storage


Shop.sell_nothing_text: string

Shown when you try to sell an empty spot



Shop.sell_options_text: table


Shop.sell_refuse_text: string

Shown when you refuse to sell something


Shop.sell_text: string

Shown when you sell something



Shop.shop_text: string

Shown when you return to the main menu of the shop




Shop.state: string

STATES: MAINMENU, BUYMENU, SELLMENU, SELLING, TALKMENU, LEAVE, LEAVING, DIALOGUE







Shop.talk_text: string

Shown when you enter the talk menu.