Struct ItemInstance

pub struct ItemInstance<K, U: Default> {
    pub key: K,
    pub quantity: usize,
    pub durability: Option<usize>,
    pub user_data: U,
}

An ItemInstance is a stack of item. It refers to the ItemDefinition’s key. The associated ItemDefinition contains the data describing that object type. An item stack can be composed of one or many of the same item. It can also have a durability, which decreases when the item is used using Inventory::use_item.

Custom data can be added into the user_data field. This data is specific to each item instance.

Generic Types:

• K: Type of the key. Usually an enum or a number (ie u32).
• U: The type of the custom user data. If you don’t have any, use the () type. It can (and probably should) be different than the custom user data used on ItemInstances

Fields

key: K

The key specifies which ItemDefinition defines the properties of this item stack.

quantity: usize

The number of items in the stack. Should not be over the associated ItemDefinition::maximum_stack.

durability: Option<usize>

The remaining durability of this item, if any. If set to None, it means that the item is unbreakable.

user_data: U

The custom user data.

Implementations

impl<K, U: Default> ItemInstance<K, U>

pub fn new(key: K, quantity: usize) -> Self

Constructs a new ItemInstance.

impl<K: Eq + Hash, U: Default + PartialEq> ItemInstance<K, U>

pub fn merge<S, U2: Default>( &mut self, other: &mut Self, item_defs: &ItemDefinitions<K, S, U2>, )

Attempts to move as much quantity from other to self as possible.

Trait Implementations

impl<K: Clone, U: Clone + Default> Clone for ItemInstance<K, U>

fn clone(&self) -> ItemInstance<K, U>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<K: Debug, U: Debug + Default> Debug for ItemInstance<K, U>

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

Formats the value using the given formatter.

impl<'de, K, U> Deserialize<'de> for ItemInstance<K, U>

where K: Deserialize<'de>, U: Deserialize<'de> + Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<K, U> Serialize for ItemInstance<K, U>

where K: Serialize, U: Serialize + Default,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.