Struct Item

Source
pub struct Item {
    pub typ: ItemType,
    pub price: u32,
    pub mushroom_price: u32,
    pub model_id: u16,
    pub class: Option<Class>,
    pub type_specific_val: u32,
    pub attributes: EnumMap<AttributeType, u32>,
    pub gem_slot: Option<GemSlot>,
    pub rune: Option<Rune>,
    pub enchantment: Option<Enchantment>,
    pub color: u8,
}
Expand description

Information about a single item. This can be anything, that is either in a inventory, in a reward slot, or similar

Fields§

§typ: ItemType

The type of this item. May contain further type specific values

§price: u32

Either the price to buy, or sell

§mushroom_price: u32

The price you would have to pay for this item. Note that this value is junk for other players and potentially in other cases, where you should not be able to see a price

§model_id: u16

The model id of this item

§class: Option<Class>

The class restriction, that this item has. Will only cover the three main classes

§type_specific_val: u32

Either the armor, weapon dmg, or other. You should be using armor(), or the weapon types damages though, if you want to have a safe abstraction. This is only public in case I am missing a case here

§attributes: EnumMap<AttributeType, u32>

The stats this item gives, when equipped

§gem_slot: Option<GemSlot>

The gemslot of this item, if any. A gemslot can be filled or empty

§rune: Option<Rune>

The rune on this item

§enchantment: Option<Enchantment>

The enchantment applied to this item

§color: u8

This is the color, or other cosmetic variation of an item. There is no clear 1 => red mapping, so only the raw value here

Implementations§

Source§

impl Item

Source

pub fn equipment_ident(&self) -> Option<EquipmentIdent>

Maps an item to its ident. This is mainly useful, if you want to see, if a item is already in your scrapbook

Source

pub fn is_unique(&self) -> bool

Checks, if this item is unique. Technically they are not always unique, as the scrapbook/keys can be sold, but it should be clear what this is

Source

pub fn is_epic(&self) -> bool

Checks if this item is an epic

Source

pub fn is_legendary(&self) -> bool

Checks if this item is a legendary

Source

pub fn armor(&self) -> u32

The armor rating of this item. This is just the effect_val, if any

Source

pub fn is_enchantable(&self) -> bool

Checks, if this item can be enchanted

Source

pub fn can_be_equipped_by_companion(&self, class: impl Into<Class>) -> bool

Checks if a companion of the given class can equip this item.

Returns true if the item itself is equipment and this class has the ability to wear it

Source

pub fn can_be_equipped_by(&self, class: Class) -> bool

Checks if a character of the given class can equip this item. Note that this only checks the class, so this will make no sense if you use this for anything that can not equip items at all (monsters, etc.). For companions you should use can_companion_equip

Returns true if the item itself is equipment and this class has the ability to wear it

Source

pub fn can_be_used_by(&self, class: Class) -> bool

Checks if a character of the given class can use this item. If you want to check equipment, you should use can_be_equipped_by

Returns true if the item does not have a class requirement, or if the class requirement matches the given class.

Trait Implementations§

Source§

impl Clone for Item

Source§

fn clone(&self) -> Item

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Item

Source§

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

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

impl<'de> Deserialize<'de> for Item

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for Item

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for Item

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl Eq for Item

Source§

impl StructuralPartialEq for Item

Auto Trait Implementations§

§

impl Freeze for Item

§

impl RefUnwindSafe for Item

§

impl Send for Item

§

impl Sync for Item

§

impl Unpin for Item

§

impl UnwindSafe 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
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<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

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

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

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

Source§

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.

Source§

impl<T> Instrument for T

Source§

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

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

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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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.
Source§

impl<T> WithSubscriber for T

Source§

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> ErasedDestructor for T
where T: 'static,