Skip to main content

Item

Struct Item 

Source
pub struct Item {
    pub key: Identifier,
    pub components: DataComponentMap,
    pub craft_remainder: Option<Identifier>,
    pub id: OnceLock<usize>,
}
Expand description

A Minecraft item type.

Fields§

§key: Identifier§components: DataComponentMap§craft_remainder: Option<Identifier>

The item key returned when this item is used in crafting (e.g., “bucket” from milk_bucket). Stored as an Identifier to avoid circular reference issues during initialization.

§id: OnceLock<usize>

Cached registry ID, set during registration for O(1) lookup on hot paths.

Implementations§

Source§

impl Item

Source

pub fn new( key: Identifier, item_name: TextComponent, craft_remainder: Option<Identifier>, ) -> Self

Creates an item with Vanilla’s mandatory name and default model components.

Source

pub fn from_block(block: BlockRef, item_name: TextComponent) -> Self

Source

pub fn from_block_custom_name( _block: BlockRef, name: &'static str, item_name: TextComponent, ) -> Self

Source

pub fn builder_set<T: Component + DowncastType>( self, component: DataComponentType<T>, value: Option<T>, ) -> Self

Builder method to set a component on this item. Used during static initialization.

Source

pub fn get_crafting_remainder(&self) -> ItemStack

Returns the item stack that remains after this item is used in crafting. For example, milk_bucket returns an empty bucket.

Source

pub fn has_tag(&'static self, tag: &Identifier) -> bool

Returns true if this item is tagged with the given tag.

Trait Implementations§

Source§

impl Debug for Item

Source§

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

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

impl Eq for Item

Source§

impl From<&'static Item> for ItemStack

Source§

fn from(item: ItemRef) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for Item

Source§

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

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

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

Inequality operator !=. Read more
Source§

impl RegistryEntry for Item

Source§

fn key(&self) -> &Identifier

Source§

fn try_id(&self) -> Option<usize>

Source§

fn id(&self) -> usize

Panics Read more
Source§

impl RegistryHolderSetEntry for Item

Source§

const REGISTRY_NAME: &'static str = "item"

Human-readable registry name used in codec errors.
Source§

fn holder_set_by_id(id: usize) -> Option<&'static Self>

Looks up an entry by its protocol registry ID.
Source§

fn holder_set_by_key(key: &Identifier) -> Option<&'static Self>

Looks up an entry by its registry key.
Source§

fn holder_set_tag_exists(tag: &Identifier) -> bool

Returns whether the registry contains this tag.
Source§

fn holder_set_tag_contains(entry: &'static Self, tag: &Identifier) -> bool

Returns whether an entry belongs to this tag.

Auto Trait Implementations§

§

impl !Freeze for Item

§

impl !RefUnwindSafe for Item

§

impl !UnwindSafe for Item

§

impl Send for Item

§

impl Sync for Item

§

impl Unpin for Item

§

impl UnsafeUnpin for Item

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
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> IntoShared for T

Source§

fn into_shared(self) -> Arc<Mutex<RawMutex, Self>>

Wraps this value in an Arc<SyncMutex<>>
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<E> StatValueRegistryEntry for E
where E: RegistryEntry + Send + Sync,

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.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more