InventoryRow
Defined in: server/api.d.ts:2193
A stack of one item class with one set of properties. Two rows never hold the same class with equal properties unless a restore put them there. Stackable custom rows merge only with matching properties. Nonstackable custom rows each contain one unit.
Properties
Section titled “Properties”amount
Section titled “amount”amount:
number
Defined in: server/api.d.ts:2212
Units in the row.
condition
Section titled “condition”condition:
number
Defined in: server/api.d.ts:2227
Health as a fraction of what this quality allows, 0 to 1. Same as metadata.condition.
equipped
Section titled “equipped”equipped:
number
Defined in: server/api.d.ts:2232
Units the body wears or holds: reported by a player, authored stock for an NPC. Reads include them; pass them to Inventory.set to dress a restored body.
health
Section titled “health”health:
number
Defined in: server/api.d.ts:2222
Absolute item health. Same as metadata.health.
id:
string
Defined in: server/api.d.ts:2197
The row’s identity within its owner’s inventory. Stable while the row exists; save it with the row and pass it back to Inventory.set.
item:
string
Defined in: server/api.d.ts:2202
Item class GUID.
metadata
Section titled “metadata”metadata:
Record<string,unknown>
Defined in: server/api.d.ts:2237
Every property the server keeps: quality, health, condition, and on missiles poison (a buff GUID) and poisonCharges, and onEquipBuffs (buff GUIDs). Custom items also carry custom: { name?, description?, data? }. Data stays server-side. A default is left out. Pass it back as it is to keep an item exactly.
name:
string
Defined in: server/api.d.ts:2207
Internal table name, or Items.register id for a custom type. Display overrides are in metadata.custom.name.
quality
Section titled “quality”quality:
number
Defined in: server/api.d.ts:2217
Quality, from 1 up to the class’s maximum. Same as metadata.quality.