Skip to main content

ItemKind

Enum ItemKind 

Source
pub enum ItemKind<Id: Copy + Eq + Hash + Debug> {
    Consumable,
    Equipment,
    KeyItem,
    Evolution,
    StatBoost,
    Currency,
    TeachMove,
    Custom(Id),
}
Expand description

Broad classification of an item’s purpose, influencing default shop, bag, and usage behaviour.

The generic parameter Id allows a game-specific crate to supply additional custom kinds (e.g. ItemKind::Custom(GameItemKind::TM)).

§Default methods

Each variant has baked-in defaults for four orthogonal behaviours. A game’s ItemProvider implementation may override any of these per-item.

Variants§

§

Consumable

Single-use recovery / utility items (potions, antidotes, repels).

§

Equipment

Equippable gear (weapons, armour, accessories).

§

KeyItem

Plot-critical items that cannot be sold, discarded, or stacked.

§

Evolution

Items that trigger a monster evolution.

§

StatBoost

Permanent stat-enhancing items (vitamins, feathers).

§

Currency

In-game currency (dollars, coins, shards).

§

TeachMove

Items that teach a new move (TMs, HMs, skill discs).

§

Custom(Id)

Game-specific kind not covered by the standard variants.

Implementations§

Source§

impl<Id: Copy + Eq + Hash + Debug> ItemKind<Id>

Source

pub fn default_sellable(&self) -> bool

Whether shops will buy this kind of item by default.

Source

pub fn default_discardable(&self) -> bool

Whether this kind of item can be discarded from the bag by default.

Source

pub fn default_stackable(&self) -> bool

Whether multiple copies of this kind of item stack in a single inventory slot by default.

Source

pub fn default_consumed_on_use(&self) -> bool

Whether this kind of item is consumed (removed from inventory) on successful use by default.

Trait Implementations§

Source§

impl<Id: Clone + Copy + Eq + Hash + Debug> Clone for ItemKind<Id>

Source§

fn clone(&self) -> ItemKind<Id>

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<Id: Copy + Copy + Eq + Hash + Debug> Copy for ItemKind<Id>

Source§

impl<Id: Debug + Copy + Eq + Hash + Debug> Debug for ItemKind<Id>

Source§

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

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

impl<Id: Eq + Copy + Eq + Hash + Debug> Eq for ItemKind<Id>

Source§

impl<Id: Hash + Copy + Eq + Hash + Debug> Hash for ItemKind<Id>

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl<Id: PartialEq + Copy + Eq + Hash + Debug> PartialEq for ItemKind<Id>

Source§

fn eq(&self, other: &ItemKind<Id>) -> bool

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

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

Inequality operator !=. Read more
Source§

impl<Id: PartialEq + Copy + Eq + Hash + Debug> StructuralPartialEq for ItemKind<Id>

Auto Trait Implementations§

§

impl<Id> Freeze for ItemKind<Id>
where Id: Freeze,

§

impl<Id> RefUnwindSafe for ItemKind<Id>
where Id: RefUnwindSafe,

§

impl<Id> Send for ItemKind<Id>
where Id: Send,

§

impl<Id> Sync for ItemKind<Id>
where Id: Sync,

§

impl<Id> Unpin for ItemKind<Id>
where Id: Unpin,

§

impl<Id> UnsafeUnpin for ItemKind<Id>
where Id: UnsafeUnpin,

§

impl<Id> UnwindSafe for ItemKind<Id>
where Id: UnwindSafe,

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