Shop

Runs the moment the player enters the shop.
Most dialogue and behaviour of the shop should be defined here.
This includes (but is not limited to) defining most standard shop text (excluding TALK menu dialogue), registering items, talk topics, configuring the Shopkeeper, and defining the assets to use (i.e. background and music).

Checks that the player meets the conditions to purchase an item, and then purchases it.

@param current_item — The shop entry of the item being purchased.

(Override) Draws a background for the shop.

Used to draw the comparative bonus number for an item stat against a party member's current equipment.

@param sell_data — An entry in the sell_options table reflecting the storage to enter.

return #1:
    | "MAINMENU" -- The state used when the player is in the Main menu.
    | "BUYMENU" -- The state used when the player is in the Buy menu.
    | "SELLMENU" -- The state used when the player is selecting the storage they wish to sell items from.
    | "SELLING" -- The state used after the player has selected a storage and is now choosing items to sell.
    | "TALKMENU" -- The state used when the player is selecting a topic to talk about in the Talk menu.
    | "DIALOGUE" -- The state used when dialogue is occurring.
    | "LEAVE" -- The state used to initiate leaving the shop.
    | "LEAVING" -- The state used whilst the shop is transitioning out.

Adds the voice of the Shop to a set of dialogue texts.

Leaves the shop with a fade out transition.

Leaves the shop instantly, without a transition.

(Override) Called whenever the [emote:...] text tag is used in Shop dialogue. Sets the sprite of the shopkeeper.

@param emote — The path to the image to set, or id of the animation to set.

(Override) Runs when the player enters the shop, after it has been fully initialised.

(Override) Called when the player selects to leave the shop from the main menu, happens at the same time the leaving dialogue begins.

(Override)

(Override)

old:
    | "MAINMENU" -- The state used when the player is in the Main menu.
    | "BUYMENU" -- The state used when the player is in the Buy menu.
    | "SELLMENU" -- The state used when the player is selecting the storage they wish to sell items from.
    | "SELLING" -- The state used after the player has selected a storage and is now choosing items to sell.
    | "TALKMENU" -- The state used when the player is selecting a topic to talk about in the Talk menu.
    | "DIALOGUE" -- The state used when dialogue is occurring.
    | "LEAVE" -- The state used to initiate leaving the shop.
    | "LEAVING" -- The state used whilst the shop is transitioning out.

new:
    | "MAINMENU" -- The state used when the player is in the Main menu.
    | "BUYMENU" -- The state used when the player is in the Buy menu.
    | "SELLMENU" -- The state used when the player is selecting the storage they wish to sell items from.
    | "SELLING" -- The state used after the player has selected a storage and is now choosing items to sell.
    | "TALKMENU" -- The state used when the player is selecting a topic to talk about in the Talk menu.
    | "DIALOGUE" -- The state used when dialogue is occurring.
    | "LEAVE" -- The state used to initiate leaving the shop.
    | "LEAVING" -- The state used whilst the shop is transitioning out.

(Override) Called whenever the player enters the TALK submenu.

A function that runs later than Shop:init(), primarily setting up UI elements of the shop.
Code that needs access to variables such as the shop's background Sprite object that would otherwise go in Shop:init() should go here.

Adds an item to the shop at the next available index.

@param item — An Item instance or the id of an item to add to the shop.

@param options — An optional list of properties that can be defined for this item in the shop, overriding the default values set on the item:

@return success — Whether the item was successfully added to the shop.

options:
    | "name" -- The name of the item shown in the shop.
    | "description" -- The description of the item shown in the shop
    | "price" -- The price of the item in this shop
    | "bonuses" -- The preview stat bonuses provided by the item (does not affect actual item stat bonuses)
    | "color" -- The color of the item name text
    | "flag" -- The name of a flag used to store the remaining stock of this item. Defaults to `stock_<index>_<item.id>`
    | "stock" -- The default number of stock of this item. Infinite if unspecified.

Registers a talk topic that will appear in the TALK submenu.

@param talk — The name of the topic.

@param color — The color that the topic name will appear as. Defaults to white.

Registers a talk topic that will appear in the TALK submenu when specific conditions are met.
By default, the new topic will appear after the current topic at index has been chosen once.

@param talk — The name of the topic.

@param index — The index that will be replaced with this topic.

@param flag — The name of the flag that will be checked against to determine when the topic should be replaced.

@param value — The value the flag should be at for the topic to be replaced.

@param color — The color that the topic name will appear as. Defaults to yellow.

Adds or replaces an item in the shop.

@param index — The index in the shop which this item should appear at.

@param item — An Item instance or the id of an item to add to the shop.

@param options — An optional list of properties that can be defined for this item in the shop, overriding the default values set on the item:

@return success — Whether the item was successfully added to the shop.

options:
    | "name" -- The name of the item shown in the shop.
    | "description" -- The description of the item shown in the shop
    | "price" -- The price of the item in this shop
    | "bonuses" -- The preview stat bonuses provided by the item (does not affect actual item stat bonuses)
    | "color" -- The color of the item name text
    | "flag" -- The name of a flag used to store the remaining stock of this item. Defaults to `stock_<index>_<item.id>`
    | "stock" -- The default number of stock of this item. Infinite if unspecified.

Replaces one talk topic with another.

@param talk — The name of the topic.

@param index — The index that will be replaced with this topic.

@param color — The color that the topic name will appear as. Defaults to yellow.

Changes the shop to a new state.

@param state — The new state of the shop.

@param reason — Additional information that the new state needs, if required:

• SELLING - The selected entry of the sell_options table in SELLMENU.
• TALKMENU - An optional "DIALOGUE" string literal to indicate that the user has returned from the "DIALOGUE" state.

state:
    | "MAINMENU" -- The state used when the player is in the Main menu.
    | "BUYMENU" -- The state used when the player is in the Buy menu.
    | "SELLMENU" -- The state used when the player is selecting the storage they wish to sell items from.
    | "SELLING" -- The state used after the player has selected a storage and is now choosing items to sell.
    | "TALKMENU" -- The state used when the player is selecting a topic to talk about in the Talk menu.
    | "DIALOGUE" -- The state used when dialogue is occurring.
    | "LEAVE" -- The state used to initiate leaving the shop.
    | "LEAVING" -- The state used whilst the shop is transitioning out.

Starts a dialogue with the shopkeeper, setting the state to DIALOGUE. Use this function inside of Shop:startTalk(topic).

@param text — One or more lines of dialogue, supporting Text Commands. Additionally supports the command [emote:name] which will cause the Shopkeeper's sprite to change to the sprite specified by name and onEmote() to run.

@param callback — As a function, this argument is called when the dialogue finishes. If it returns true, the shop state will not reset when the dialogue finishes. As a string, the shop is set to this state when the dialogue finishes.

(Override) Runs every time the player selects a topic in the TALK menu. \ Call Shop:startDialogue() from within this function with text appropriate to the selected topic.

@param talk — The name of the Topic that the player selected.

The filepath of the background texture for this shop, relative to assets/sprites

The Sprite instance used to control the background. Not defined in Shop:init().

Whether item prices should be hidden (Defaults to false)

Whether the shop should hide the text showing your remaining storage text (Defaults to false)

A table of items that the shop offers. Should be set through Shop:registerItem()

A table defining what will happen when the player leaves the shop. The keys map (target map name), x and y OR marker (target position in map), facing, (player facing direction in map), menu (return to main menu) can be defined for this table.

A table defining the options that will be displayed when on the main menu of the shop (State MAINMENU).
Each entry in this table should be a two string table, defining the name of the option first,
followed by the name of the state that the stop should enter when the option is selected.

The Music instance used to control the shop's music

A table defining the options that will be displayed when in the SELL menu of the shop (State SELLMENU).
Each entry in this table should be a two string table, defining the name of the option first,
followed by the name of the item storage that should be opened to sell from after.

Defines the text shown when in each of the different SELL submenus.
The keys items, weapons, armors, and storage can be defined for this table.

The filepath of the song to play in this shop, relative to assets/music

A table defining the stat icons used when previewing items in this shop.

The current state of the shop, should only be set using Shop:setState().

The current reason for the state of the shop, should only be set using Shop:setState().

A table of topics that will replace other topics once they have been chosen. Should be set through Shop:registerTalkAfter()

A table of topics available in the TALK menu. Should be set through Shop:registerTalk()

The filepath of the voice sound to use for the shop, relative to assets/sounds/voice.

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

Oh my god

Construct the UI

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.

Same here too...