Class MerchantStock<T>

Type Parameters

T = Record<string, unknown>

Index

Methods

create addItem removeItem hasItem getItem list size buy sell setStock setRestock priceFor setPriceFn totalSold totalRevenue totalBought totalCost resetStats tick clear dispose

Methods

`Static`create

create<T = Record<string, unknown>>(
opts?: MerchantStockOptions<T>,
): MerchantStock<T>
Type Parameters
- T = Record<string, unknown>
Parameters
- opts: MerchantStockOptions<T> = {}
Returns MerchantStock<T>
- Defined in runtime/merchant-stock.ts:111

addItem

addItem(spec: StockItemSpec<T>): boolean
Parameters
- spec: StockItemSpec<T>
Returns boolean
- Defined in runtime/merchant-stock.ts:116

removeItem

removeItem(id: string): boolean
Parameters
- id: string
Returns boolean
- Defined in runtime/merchant-stock.ts:138

hasItem

hasItem(id: string): boolean
Parameters
- id: string
Returns boolean
- Defined in runtime/merchant-stock.ts:143

getItem

getItem(id: string): StockItem<T> | null
Parameters
- id: string
Returns StockItem<T> | null
- Defined in runtime/merchant-stock.ts:147

list

list(): StockItem<T>[]
Returns StockItem<T>[]
- Defined in runtime/merchant-stock.ts:152

size

size(): number
Returns number
- Defined in runtime/merchant-stock.ts:163

buy

buy(itemId: string, quantity: number, ctx?: Record<string, unknown>): BuyResult
Parameters
- itemId: string
- quantity: number
- ctx: Record<string, unknown> = {}
Returns BuyResult
- Defined in runtime/merchant-stock.ts:165

sell

sell(
    itemId: string,
    quantity: number,
    ctx?: Record<string, unknown>,
): SellResult
Parameters
- itemId: string
- quantity: number
- ctx: Record<string, unknown> = {}
Returns SellResult
- Defined in runtime/merchant-stock.ts:190

setStock

setStock(itemId: string, qty: number): boolean
Parameters
- itemId: string
- qty: number
Returns boolean
- Defined in runtime/merchant-stock.ts:219

setRestock

setRestock(itemId: string, amount: number, intervalMs: number): boolean
Parameters
- itemId: string
- amount: number
- intervalMs: number
Returns boolean
- Defined in runtime/merchant-stock.ts:229

priceFor

priceFor(itemId: string, ctx?: Record<string, unknown>): number | null
Parameters
- itemId: string
- ctx: Record<string, unknown> = {}
Returns number | null
- Defined in runtime/merchant-stock.ts:242

setPriceFn

setPriceFn(fn: PriceModifierFn | null): void
Parameters
- fn: PriceModifierFn | null
Returns void
- Defined in runtime/merchant-stock.ts:248

totalSold

totalSold(): number
Returns number
- Defined in runtime/merchant-stock.ts:253

totalRevenue

totalRevenue(): number
Returns number
- Defined in runtime/merchant-stock.ts:254

totalBought

totalBought(): number
Returns number
- Defined in runtime/merchant-stock.ts:255

totalCost

totalCost(): number
Returns number
- Defined in runtime/merchant-stock.ts:256

resetStats

resetStats(): void
Returns void
- Defined in runtime/merchant-stock.ts:258

tick

tick(dtMs: number): void
Parameters
- dtMs: number
Returns void
- Defined in runtime/merchant-stock.ts:267

clear

clear(): void
Returns void
- Defined in runtime/merchant-stock.ts:288

dispose

dispose(): void
Returns void
- Defined in runtime/merchant-stock.ts:294