CookPot

const CookPot: object

Defined in: server/api.d.ts:5405

Server-owned stew pots. Stocked pots begin with four shared meals, with no automatic refill. State lasts until the server stops.

Type Declaration

all()

all(virtualWorld?): CookPotSnapshot[]

Lists every catalogued pot on the server’s level in one virtual world; empty for a world no player or write has used yet.

Parameters

virtualWorld?

number

Virtual world id; defaults to 0. The global visibility sentinel is not a stock world.

Returns

CookPotSnapshot[]

get()

get(guid, virtualWorld?): CookPotSnapshot | null

Returns a snapshot, or null for an unknown pot.

Parameters

guid

string

Fireplace level GUID from CookPot.all().

virtualWorld?

number

Virtual world id; defaults to 0. The global visibility sentinel is not a stock world.

Returns

CookPotSnapshot | null

poison()

poison(player, guid, rowId): CookPotResult

Poisons a stocked enabled pot with the item’s ingested effect. Refuses a second poison until refill. A meal takes the poison present when reserved, applied once on its eating receipt; NPC poisoning and native crime reactions are not included.

Parameters

player

Player

Connected player within four metres; their current virtual world selects the pot.

guid

string

Fireplace level GUID from CookPot.all().

rowId

string

Inventory row containing a native Poison item; spends exactly one.

Returns

CookPotResult

poisons()

poisons(): string[]

Item class GUIDs accepted by CookPot.poison, including each native strength variant.

Returns

string[]

refill()

refill(guid, portions?, virtualWorld?): boolean

Replaces remaining stock and capacity and clears poison, preserving food and enabled. Returns false for an unknown pot.

Parameters

guid

string

Fireplace level GUID from CookPot.all().

portions?

number

Integer from 0 to 1000; defaults to four.

virtualWorld?

number

Virtual world id; defaults to 0. The global visibility sentinel is not a stock world.

Returns

boolean

refillFromInventory()

refillFromInventory(player, guid, recipe): CookPotResult

Spends ingredients atomically and fills an empty enabled pot. Clears old poison. Validates player, distance, ability to act, world and synchronized inventory. Never pass unvalidated client recipe data.

Parameters

player

Player

Connected player within four metres; their current virtual world selects the pot.

guid

string

Fireplace level GUID from CookPot.all().

recipe

CookPotRecipe

Ingredients and yield chosen by this server script.

Returns

CookPotResult

setEnabled()

setEnabled(guid, enabled, virtualWorld?): boolean

Allows or blocks eating. Returns false for an unknown pot.

Parameters

guid

string

Fireplace level GUID from CookPot.all().

enabled

boolean

False blocks eating without changing stock or its appearance.

virtualWorld?

number

Virtual world id; defaults to 0. The global visibility sentinel is not a stock world.

Returns

boolean

setFood()

setFood(guid, food, virtualWorld?): boolean

Changes future meals and appearance, preserving stock, poison and enabled. Already reserved meals keep their previous type.

Parameters

guid

string

Fireplace level GUID from CookPot.all().

food

"goulash" | "lentil" | "soup"

Native meal type.

virtualWorld?

number

Virtual world id; defaults to 0. The global visibility sentinel is not a stock world.

Returns

boolean

setState()

setState(guid, state, virtualWorld?): boolean

Changes food level and stock together, preserving food, poison and enabled. Returns false for an unknown pot.

Parameters

guid

string

Fireplace level GUID from CookPot.all().

state

"full" | "empty" | "half"

Empty, two portions, or four portions; resets capacity to four.

virtualWorld?

number

Virtual world id; defaults to 0. The global visibility sentinel is not a stock world.

Returns

boolean