Shop stock

Status: experimental.

What it is

The game has two kinds of shop you can add goods to: traders, who are people with a shop of their own, and vending machines. This API lets your mod put an item in a trader’s shop (a fixed stack that is kept topped up) or add one more item for sale in a vending machine. Reading shops, stock and prices is on the economy page.

A trader’s stock here is not a price list. A trader still prices an item by the item’s own value, so you can’t set a separate trader price for one item.

When to use it

  • Sell your mod’s item at a trader, so the player can buy it without crafting.
  • Add your mod’s item to a vending machine, with your own price.
  • Put a one-time starting stack of an item into a trader.
  • Take back stock your mod added.

Quick example

This mod keeps 5 apples in a trader’s shop and adds apples to a vending machine for sale at the game’s normal price. When the game is ready, it also logs every shop in the scene with its id, so you can find the right key.

using ObenseuerCore;

[ModInfo("example.applestall", "Apple Stall", "0.1.0")]
[ModDependency("obenseuer.moddingframework", "0.11.0")]
public class AppleStall : FrameworkMod
{
    protected override void OnLoad()
    {
        if (!ShopStock.IsAvailable)
            Log.Warn("Shop stock is off, so no stock can be added. See the limits on the shop keys page.");

        Events.WhenReady(() =>
        {
            foreach (ShopInfo shop in Shops.All())
            {
                if (shop.Kind == ShopKind.Trader)
                {
                    if (ShopStock.AddTraderStock(Mod.Id, shop.Id, 10620, 5))
                        Log.Info("Kept 5 apples in " + shop.Name + ".");
                    else
                        Log.Warn("The trader stock was refused for " + shop.Name + ". See the limits on the traders page.");
                }
                else if (shop.Kind == ShopKind.Vending)
                {
                    if (ShopStock.AddVendingEntry(Mod.Id, shop.Id, 10620, 10, 0f, MoneyCurrency.OC))
                        Log.Info("Added apples to " + shop.Name + ".");
                    else
                        Log.Warn("The vending entry was refused for " + shop.Name + ". See the limits on the vending machines page.");
                }
            }

            foreach (ShopInfo shop in Shops.All())
                Log.Info(shop.Kind + " " + shop.Name + " " + shop.Id);
        });
    }
}

The first value of each call is your mod id, Mod.Id (see Mod id). The shop key is the Id of a shop from Shops.All(), so the mod finds the shops itself instead of hard coding a key. The number 10620 is the apple’s item id. A price of 0 means the machine uses the game’s normal price. Each call returns true when it was applied, and the mod logs a warning when it was refused. See Using events for more on WhenReady. The limits are on the traders and vending machines pages.

Table of contents