Skip to main content

ToolMaterial

Struct ToolMaterial 

Source
pub struct ToolMaterial {
    pub id: String,
    pub durability: u32,
    pub speed: f32,
    pub attack_damage: f32,
    pub enchantability: u32,
    pub level: String,
    pub repair: String,
    pub level_index: u32,
    pub incorrect: String,
    pub game_tools: String,
}
Expand description

What tools are made of. The game’s are built in (ToolMaterial::built_ins); a mod declares its own in a .ydef (kind: "tool_material") or registers one (Registry::register_tool_material).

Fields§

§id: String§durability: u32

Uses before it breaks.

§speed: f32

How fast it mines (wood 2 … netherite 9, gold 12).

§attack_damage: f32

Attack damage it adds (wood 0 … netherite 4).

§enchantability: u32§level: String

Its level on the tool ladder (minecraft:iron, mymod:mythril).

§repair: String

What repairs it: an item id or #tag.

§level_index: u32

Minecraft 1.20’s level number of level (wood 0 … netherite 4).

§incorrect: String

Minecraft 1.21’s tag of the blocks a tool of it can’t mine for drops (minecraft:incorrect_for_iron_tool).

§game_tools: String

What the game’s tools of it are named by (wooden_: minecraft:wooden_axe); empty for a mod’s own.

Implementations§

Source§

impl ToolMaterial

Source

pub fn built_ins() -> &'static [ToolMaterial]

The game’s materials: wood, stone, iron, diamond, gold, netherite.

Source

pub fn built_in(name: &str) -> Option<&'static ToolMaterial>

One of the game’s, by short name or id.

Source

pub fn like(id: impl Into<String>, like: &str) -> Option<ToolMaterial>

id with like’s level (one of the game’s: iron), durability, speed, damage, enchantability and repair — change what differs.

Source

pub fn game_tool(&self, kind: &str) -> Option<GameTool>

The game’s tool of kind (a mod’s kind: REFERENCE_KIND) made of this material, or — a mod’s — of REFERENCE_MATERIAL.

Trait Implementations§

Source§

impl Clone for ToolMaterial

Source§

fn clone(&self) -> ToolMaterial

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 ToolMaterial

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Fields for ToolMaterial

Source§

const FIELDS: &'static [(&'static str, &'static str)]

Source§

impl PartialEq for ToolMaterial

Source§

fn eq(&self, other: &ToolMaterial) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl Schema for ToolMaterial

Source§

fn encode(&self, __yog_w: &mut Writer)

Writes itself in the binary form, straight — Schema::write’s value encoded, unless the type knows better (derived ones do).
Source§

fn decode(__yog_d: &mut Decoder<'_>) -> Option<ToolMaterial>

Reads itself from the binary form, straight; None when it isn’t what Schema::encode writes — then read_bytes reads the slow way, which says what’s wrong. Through a value unless the type knows better (derived ones do).
Source§

fn pack(&self, __yog_p: &mut Packer)

Packs itself into a frame (crate::frame): its binary form as bytes, unless the type packs itself (derived ones and plain types do).
Source§

fn unpack(__yog_u: &mut Unpacker<'_>) -> Option<ToolMaterial>

Reads itself out of a frame; None if the bytes aren’t what Schema::pack writes.
Source§

fn shape() -> Shape

What the format looks like.
Source§

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

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

fn write(&self) -> Value

The value, as the format writes it.
Source§

fn absent() -> Option<Self>

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

fn skip(&self) -> bool

Whether a struct leaves this field out when writing it.
Source§

fn pack_list(items: &[Self], p: &mut Packer)

A list of these packed: a count, then each one (floats raw).
Source§

fn unpack_list(u: &mut Unpacker<'_>) -> Option<Vec<Self>>

A list of these out of a frame.
Source§

fn encode_list(items: &[Self], w: &mut Writer)

A list of these written straight (numbers pack theirs).
Source§

fn decode_list(d: &mut Decoder<'_>) -> Option<Vec<Self>>

A list of these read straight.
Source§

impl StructuralPartialEq for ToolMaterial

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> Arg<T> for T

Source§

fn arg(self) -> T

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> Message for T
where T: Schema,

Source§

fn to_bytes(&self) -> Vec<u8> ⓘ

The payload’s bytes.
Source§

fn from_bytes(bytes: &[u8]) -> Option<Self>

The message read from a payload; None if it isn’t one.
Source§

fn with_bytes<R>(&self, f: impl FnOnce(&[u8]) -> R) -> R

f on the payload, packed in this thread’s reused buffers: nothing allocated once they’ve grown to the thread’s messages.
Source§

impl<T> Packet for T
where T: Schema,

Source§

fn to_payload(&self) -> Vec<u8> ⓘ

Source§

fn from_payload(bytes: &[u8]) -> Option<T>

None for bytes that aren’t this packet.
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 = !

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

fn try_from(value: U) -> Result<T, !>

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.