Skip to content
KCKingdoms Connected Scripting APIScripting guides and API
Data shapeServer APIGenerated

Consumption

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

A server-validated serving. Item properties and pot poison come from server state; changing the snapshot does not change the decision.

baseEffects: { alcohol: number; buff: string | null; energy: number; health: number; nourishment: number; } | null

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

Native table inputs before item condition, spoilage, perks or soul modifiers. Health effects may run over time. These are not promised final stat deltas. Null when the catalog has no row.


item: string

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

Native food or potion item class GUID.


kind: "food" | "potion"

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

Native food type; potions use the game’s food type 1.


metadata: Record<string, unknown>

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

Server item properties, including condition. Empty for a pot meal.


nativeEffects: boolean

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

Whether native nutrition, energy, alcohol, potion and spoilage effects are allowed. Final in playerConsumed.


poison: string | null

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

Additional cooking pot poison buff GUID, or null. Spoilage and the item’s own effects are part of nativeEffects.


potGuid: string | null

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

Cooking pot GUID, or null for an inventory item.


rowId: string | null

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

Inventory row, or null for a pot meal.


source: "inventory" | "cookPot"

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

Where the serving comes from.