Search the docs

Find a guide, global, type or member

TypeContentcontent.luau

ItemDef

A custom item. Without model it keeps the base item's look, and its name unless name is set.

Fields

itemDef.base: string?#

The vanilla item it is built on, a minecraft: key; default "minecraft:paper".

itemDef.model: string?#

A model key (see content.model). omitted: the base item's vanilla look

itemDef.name: Text?#

Display name.

itemDef.color: number?#

Colour of name, 0xRRGGBB; only with name.

itemDef.lore: { Text }?#

Tooltip lines under the name.

itemDef.stack: number?#

Max stack size, 1..99; default 64, or 1 with durability.

itemDef.durability: number?#

Durability: the damage it takes before breaking. Makes the item unstackable.

itemDef.tint: number?#

Colours the model's tinted faces, 0xRRGGBB.

itemDef.tool: { speed: number }?#

Makes it a tool. speed multiplies mining progress on blocks it is the right tool for; 1 is a bare hand.

itemDef.weapon: { damage: number, speed: number? }?#

Makes it a weapon: damage per hit and, optionally, attack speed (above 0).

itemDef.armor: { slot: "head" | "chest" | "legs" | "feet" | "offhand", points: number, toughness: number? }?#

Makes it wearable in slot, granting armor points and toughness (default 0).