Skip to main content

ItemDef

Struct ItemDef 

Source
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>,
}
Expand description

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.

Implementations§

Source§

impl ItemDef

Source

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

Source

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

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

Source

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

Display name shown in-game.

Source

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

A tooltip line shown on hover.

Source

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

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

Source

pub fn fire_resistant(self) -> ItemDef

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

Source

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

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

Source

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

Make this item edible with the given nutritional properties.

Trait Implementations§

Source§

impl Clone for ItemDef

Source§

fn clone(&self) -> ItemDef

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ItemDef

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.