Skip to main content

Inventory

Struct Inventory 

Source
pub struct Inventory<I: ItemType> {
    pub slots: Vec<Option<InventorySlot<I>>>,
    pub capacity: usize,
}
Expand description

Fixed-capacity player inventory backed by a flat slot vector.

The inventory holds up to capacity stacks, each stored as Option<InventorySlot<I>>. None denotes an empty slot.

Items of the same type are automatically stacked: Inventory::add fills existing stacks of the matching type before opening a new slot. Inventory::remove drains stacks in order and clears slots that reach zero.

The default capacity is 36 slots (4 rows × 9 columns), matching the standard Minecraft-style layout expected by the built-in hotbar and inventory UI widgets.

§Examples

use voxel_framework::items::{Inventory, DefaultItem};

let mut inv = Inventory::<DefaultItem>::new(9);
inv.add(DefaultItem::IronOre, 5);
assert_eq!(inv.count_of(DefaultItem::IronOre), 5);

Fields§

§slots: Vec<Option<InventorySlot<I>>>

The backing slot vector. None at index i means slot i is empty.

The length always equals capacity; slots are never removed from the vector.

§capacity: usize

Maximum number of distinct item stacks the inventory can hold.

Set at construction time; cannot be changed after the fact without rebuilding the inventory.

Implementations§

Source§

impl<I: ItemType> Inventory<I>

Source

pub fn new(capacity: usize) -> Self

Creates a new empty inventory with the given slot capacity.

Source

pub fn add(&mut self, item: I, count: u32) -> u32

Adds count of item to the inventory.

Items are stacked onto existing slots of the same type first, then into empty slots. Returns the number of items that could not be added because slot capacity or the per-item u32 representational ceiling is exceeded. This is not an author-configured stack limit. Invalid public fields or positive default/empty sentinels are rejected without mutation.

Source

pub fn remove(&mut self, item: I, count: u32) -> u32

Removes up to count of item from the inventory.

Returns the number of items that were actually removed (may be less than count if the inventory held fewer).

Source

pub fn count_of(&self, item: I) -> u32

Returns the total number of item, defensively saturating for invalid publicly modified fields rather than wrapping or panicking.

Source

pub fn is_full(&self) -> bool

Returns true if every slot is occupied.

Trait Implementations§

Source§

impl<I: Clone + ItemType> Clone for Inventory<I>

Source§

fn clone(&self) -> Self

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<I: ItemType> Container<I> for Inventory<I>

Source§

fn try_exchange_atomic( &mut self, remove: &[(I, u32)], add: &[(I, u32)], ) -> Option<Result<(), ContainerExchangeError>>

Optionally consume and produce a complete exchange atomically. Read more
Source§

fn add(&mut self, item: I, count: u32) -> u32

Adds count of item. Returns the number of items that could NOT be inserted due to capacity (0 = all inserted).
Source§

fn remove(&mut self, item: I, count: u32) -> u32

Removes up to count of item. Returns the number actually removed.
Source§

fn count_of(&self, item: I) -> u32

Total number of item across all slots.
Source§

fn capacity(&self) -> usize

Maximum number of distinct item stacks this container can hold.
Source§

fn is_full(&self) -> bool

Returns true if every slot is occupied.
Source§

fn iter_slots(&self) -> impl Iterator<Item = Option<&InventorySlot<I>>>

Iterates over all slots, yielding Some(&InventorySlot<I>) for occupied slots and None for empty ones. Yields exactly capacity() items.
Source§

fn slot_at(&self, index: usize) -> Option<&InventorySlot<I>>

Returns the slot at index, or None if the index is out of bounds or the slot is empty. Never panics.
Source§

impl<I: Debug + ItemType> Debug for Inventory<I>

Source§

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

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

impl<I: ItemType> Default for Inventory<I>

Source§

fn default() -> Self

Creates a default inventory with 36 slots (4 rows × 9 columns).

Source§

impl<I: ItemType> Resource for Inventory<I>
where Self: Send + Sync + 'static,

Auto Trait Implementations§

§

impl<I> Forget for Inventory<I>

§

impl<I> Freeze for Inventory<I>

§

impl<I> Move for Inventory<I>

§

impl<I> RefUnwindSafe for Inventory<I>

§

impl<I> Send for Inventory<I>

§

impl<I> Sync for Inventory<I>

§

impl<I> Unpin for Inventory<I>

§

impl<I> UnsafeUnpin for Inventory<I>

§

impl<I> UnwindSafe for Inventory<I>

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, U> AsBindGroupShaderType<U> for T
where U: ShaderType, &'a T: for<'a> Into<U>,

Source§

fn as_bind_group_shader_type(&self, _images: &RenderAssets<GpuImage>) -> U

Return the T ShaderType for self. When used in AsBindGroup derives, it is safe to assume that all images in self exist.
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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> ConditionalSend for T
where T: Send,

Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Converts Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>, which can then be downcast into Box<dyn ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Converts Rc<Trait> (where Trait: Downcast) to Rc<Any>, which can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Converts &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Converts &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSend for T
where T: Any + Send,

Source§

fn into_any_send(self: Box<T>) -> Box<dyn Any + Send>

Converts Box<Trait> (where Trait: DowncastSend) to Box<dyn Any + Send>, which can then be downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

impl<S, T> Duplex<S> for T
where T: FromSample<S> + ToSample<S>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<S> FromSample<S> for S

Source§

fn from_sample_(s: S) -> S

Source§

impl<T> FromWorld for T
where T: Default,

Source§

fn from_world(_world: &mut World) -> T

Creates Self using default().

Source§

impl<T, W> HasTypeWitness<W> for T
where W: MakeTypeWitness<Arg = T>, T: ?Sized,

Source§

const WITNESS: W = W::MAKE

A constant of the type witness
Source§

impl<T> Identity for T
where T: ?Sized,

Source§

const TYPE_EQ: TypeEq<T, <T as Identity>::Type> = TypeEq::NEW

Proof that Self is the same type as Self::Type, provides methods for casting between Self and Self::Type.
Source§

type Type = T

The same type as Self, used to emulate type equality bounds (T == U) with associated type equality constraints (T: Identity<Type = U>).
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> IntoResult<T> for T

Source§

fn into_result(self) -> Result<T, RunSystemError>

Converts this type into the system output type.
Source§

impl<A> Is for A
where A: Any,

Source§

fn is<T>() -> bool
where T: Any,

Checks if the current type “is” another type, using a TypeId equality comparison. This is most useful in the context of generic logic. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Settings for T
where T: 'static + Send + Sync,

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> ToSample<U> for T
where U: FromSample<T>,

Source§

fn to_sample_(self) -> U

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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> TypeData for T
where T: 'static + Send + Sync + Clone,

Source§

fn clone_type_data(&self) -> Box<dyn TypeData>

Creates a type-erased clone of this value.
Source§

impl<T> WasmNotSend for T
where T: Send,

Source§

impl<T> WasmNotSendSync for T

Source§

impl<T> WasmNotSync for T
where T: Sync,

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