Struct game_features::ItemDefinition [−][src]
An ItemDefinition
stores the different properties of a type of item.
It is a schema that contains the data which isn’t changing between different item instances.
Generic Types:
- K: Type of the key. Usually an enum or a number (ie u32).
- T: Type of the different item types. For example, an armor-type item can not be placed into a
weapon-type inventory slot. If you don’t need to make the distinction between different item
types, use the
()
type. - D: 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 onItemInstance
s
Fields
key: K
The key identifying this item definition.
slot_type: S
The type / item group that this item definition is part of.
name: String
The display name of this item definition.
friendly_name: String
The friendly name of this item definition. Mostly used to find items by name instead of by key.
description: String
The display description of this item definition.
maximum_stack: Option<usize>
The maximum number of elements that can be in an item stack. Setting this value to 1 disables the ability to stack this type of item.
maximum_durability: Option<usize>
The default maximum durability of this item. Setting this to None means that this item type doesn’t use the concept of durability and is unbreakable.
user_data: D
Custom user data. For example: rarity, weight, list of allowed upgrades, etc…
Implementations
impl<K, S, D: Default> ItemDefinition<K, S, D>
[src]
pub fn new(
key: K,
slot_type: S,
name: String,
friendly_name: String,
description: String,
maximum_stack: Option<usize>,
maximum_durability: Option<usize>
) -> Self
[src]
key: K,
slot_type: S,
name: String,
friendly_name: String,
description: String,
maximum_stack: Option<usize>,
maximum_durability: Option<usize>
) -> Self
Constructs a new ItemDefinition
.
Trait Implementations
impl<K: Clone, S: Clone, D: Clone + Default> Clone for ItemDefinition<K, S, D>
[src]
fn clone(&self) -> ItemDefinition<K, S, D>
[src]
pub fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl<K: Debug, S: Debug, D: Debug + Default> Debug for ItemDefinition<K, S, D>
[src]
impl<'de, K, S, D: Default> Deserialize<'de> for ItemDefinition<K, S, D> where
K: Deserialize<'de>,
S: Deserialize<'de>,
D: Deserialize<'de>,
[src]
K: Deserialize<'de>,
S: Deserialize<'de>,
D: Deserialize<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
[src]
__D: Deserializer<'de>,
impl<K, S, D: Default> Serialize for ItemDefinition<K, S, D> where
K: Serialize,
S: Serialize,
D: Serialize,
[src]
K: Serialize,
S: Serialize,
D: Serialize,
Auto Trait Implementations
impl<K, S, D> RefUnwindSafe for ItemDefinition<K, S, D> where
D: RefUnwindSafe,
K: RefUnwindSafe,
S: RefUnwindSafe,
D: RefUnwindSafe,
K: RefUnwindSafe,
S: RefUnwindSafe,
impl<K, S, D> Send for ItemDefinition<K, S, D> where
D: Send,
K: Send,
S: Send,
D: Send,
K: Send,
S: Send,
impl<K, S, D> Sync for ItemDefinition<K, S, D> where
D: Sync,
K: Sync,
S: Sync,
D: Sync,
K: Sync,
S: Sync,
impl<K, S, D> Unpin for ItemDefinition<K, S, D> where
D: Unpin,
K: Unpin,
S: Unpin,
D: Unpin,
K: Unpin,
S: Unpin,
impl<K, S, D> UnwindSafe for ItemDefinition<K, S, D> where
D: UnwindSafe,
K: UnwindSafe,
S: UnwindSafe,
D: UnwindSafe,
K: UnwindSafe,
S: UnwindSafe,
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,
[src]
T: for<'de> Deserialize<'de>,
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,