Struct ItemDef 

pub struct ItemDef {
    pub id: String,
    pub max_stack: u8,
    pub name: Option<String>,
    pub tooltip: Option<String>,
    pub max_damage: u32,
    pub fire_resistant: bool,
    pub fuel_ticks: u32,
    pub food: Option<FoodDef>,
    pub tool: Option<ToolItem>,
    pub armor: Option<ArmorPiece>,
    pub wearable: Option<String>,
}

A custom item to register, identified by namespace:path.

Fields

id: String

max_stack: u8

name: Option<String>

tooltip: Option<String>

max_damage: u32

Durability. 0 = non-damageable. If set, max_stack is forced to 1.

fire_resistant: bool

Immune to fire and lava damage (like netherite items).

fuel_ticks: u32

Furnace fuel burn time in ticks (0 = not fuel; 200 = one coal equivalent).

food: Option<FoodDef>

Nutritional properties; None = not food.

tool: Option<ToolItem>

A tool or a weapon of a material.

armor: Option<ArmorPiece>

A piece of armor of a material.

wearable: Option<String>

Worn in this slot without being armor: head, chest, legs, feet.

Implementations

impl ItemDef

pub fn new(id: impl Into<String>) -> ItemDef

pub fn tool( self, kind: impl Into<String>, material: impl Into<String>, attack_damage: f32, attack_speed: f32, ) -> ItemDef

A tool (pickaxe, axe, shovel, hoe, a mod’s mineable tag mymod:mineable/hammer) or a sword, of material (a ToolMaterial: the game’s iron… or a mod’s).

pub fn armor( self, slot: impl Into<String>, material: impl Into<String>, ) -> ItemDef

A piece of armor for slot (head, chest, legs, feet) of material (an ArmorMaterial: the game’s diamond… or a mod’s).

pub fn wearable(self, slot: impl Into<String>) -> ItemDef

Worn in slot (head, chest, legs, feet) without being armor.

pub fn max_stack(self, n: u8) -> ItemDef

Maximum stack size (default 64). Ignored when max_damage is set.

pub fn name(self, name: impl Into<String>) -> ItemDef

Display name shown in-game.

pub fn tooltip(self, tooltip: impl Into<String>) -> ItemDef

A tooltip line shown on hover.

pub fn max_damage(self, durability: u32) -> ItemDef

Make this a damageable item (tool/weapon/armour). Forces stack size to 1.

pub fn fire_resistant(self) -> ItemDef

Make this item fire-resistant (won’t burn in fire or lava).

pub fn fuel(self, ticks: u32) -> ItemDef

Register as furnace fuel burning for ticks (200 ticks = 1 item smelted).

pub fn food(self, food: FoodDef) -> ItemDef

Make this item edible with the given nutritional properties.

Trait Implementations

impl Clone for ItemDef

fn clone(&self) -> ItemDef

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ItemDef

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ItemDef

fn deserialize<__D>( __deserializer: __D, ) -> Result<ItemDef, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Schema for ItemDef

fn shape() -> Shape

What the format looks like.

fn read(v: &ValueRef<'_>, cx: &mut Reader<'_>) -> Option<ItemDef>

Reads v. Problems go to cx at its current path; None when the value couldn’t be read (the problem is in cx).

fn write(&self) -> Value

The value, as the format writes it.

fn absent() -> Option<Self>

The value of a field that isn’t there — None: the field is required.

fn skip(&self) -> bool

Whether a struct leaves this field out when writing it.

impl Serialize for ItemDef

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.