Struct ItemDefinitionBuilder

pub struct ItemDefinitionBuilder<K, S, D: Default> { /* private fields */ }

Builder for ItemDefinition.

Implementations

impl<K: Clone, S: Clone, D: Default + Clone> ItemDefinitionBuilder<K, S, D>

pub fn key(&mut self, value: K) -> &mut Self

The key identifying this item definition.

pub fn slot_type(&mut self, value: S) -> &mut Self

The type / item group that this item definition is part of.

pub fn name(&mut self, value: String) -> &mut Self

The display name of this item definition.

pub fn friendly_name(&mut self, value: String) -> &mut Self

The friendly name of this item definition. Mostly used to find items by name instead of by key.

pub fn description(&mut self, value: String) -> &mut Self

The display description of this item definition.

pub fn maximum_stack(&mut self, value: Option<usize>) -> &mut Self

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.

pub fn maximum_durability(&mut self, value: Option<usize>) -> &mut Self

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.

pub fn user_data(&mut self, value: D) -> &mut Self

Custom user data. For example: rarity, weight, list of allowed upgrades, etc…

pub fn build( &self, ) -> Result<ItemDefinition<K, S, D>, ItemDefinitionBuilderError>

Builds a new ItemDefinition.

Errors

If a required field has not been initialized.

Trait Implementations

impl<K: Clone, S: Clone, D: Clone + Default> Clone for ItemDefinitionBuilder<K, S, D>

fn clone(&self) -> ItemDefinitionBuilder<K, S, D>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<K: Clone, S: Clone, D: Default + Clone> Default for ItemDefinitionBuilder<K, S, D>

fn default() -> Self

Returns the “default value” for a type.