Struct Inventory

pub struct Inventory {
    pub inventory_menu: Menu,
    pub id: u8,
    pub container_menu: Option<Menu>,
    pub container_menu_title: Option<FormattedText>,
    pub carried: ItemSlot,
    pub state_id: u32,
    pub quick_craft_status: QuickCraftStatusKind,
    pub quick_craft_kind: QuickCraftKind,
    pub quick_craft_slots: HashSet<u16>,
    pub selected_hotbar_slot: u8,
}

A component present on all local players that have an inventory.

Fields

inventory_menu: Menu

A component that contains the player’s inventory menu. This is guaranteed to be a Menu::Player.

We keep it as a Menu since Menu has some useful functions that bare azalea_inventory::Player doesn’t have.

id: u8

The ID of the container that’s currently open. Its value is not guaranteed to be anything specific, and may change every time you open a container (unless it’s 0, in which case it means that no container is open).

container_menu: Option<Menu>

The current container menu that the player has open. If no container is open, this will be None.

container_menu_title: Option<FormattedText>

The custom name of the menu that’s currently open. This is Some when container_menu is Some.

carried: ItemSlot

The item that is currently held by the cursor. Slot::Empty if nothing is currently being held.

This is different from Self::selected_hotbar_slot, which is the item that’s selected in the hotbar.

state_id: u32

An identifier used by the server to track client inventory desyncs. This is sent on every container click, and it’s only ever updated when the server sends a new container update.

quick_craft_status: QuickCraftStatusKind

quick_craft_kind: QuickCraftKind

quick_craft_slots: HashSet<u16>

A set of the indexes of the slots that have been right clicked in this “quick craft”.

selected_hotbar_slot: u8

The index of the item in the hotbar that’s currently being held by the player. This MUST be in the range 0..9 (not including 9).

In a vanilla client this is changed by pressing the number keys or using the scroll wheel.

Implementations

impl Inventory

pub fn menu(&self) -> &Menu

Returns a reference to the currently active menu. If a container is open it’ll return Self::container_menu, otherwise Self::inventory_menu.

Use Self::menu_mut if you need a mutable reference.

pub fn menu_mut(&mut self) -> &mut Menu

Returns a mutable reference to the currently active menu. If a container is open it’ll return Self::container_menu, otherwise Self::inventory_menu.

Use Self::menu if you don’t need a mutable reference.

pub fn simulate_click( &mut self, operation: &ClickOperation, player_abilities: &PlayerAbilities, )

Modify the inventory as if the given operation was performed on it.

pub fn held_item(&self) -> ItemSlot

Get the item in the player’s hotbar that is currently being held.

Trait Implementations

impl Clone for Inventory

fn clone(&self) -> Inventory

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Component for Inventory

where Inventory: Send + Sync + 'static,

type Storage = TableStorage

A marker type indicating the storage type used for this component. This must be either [TableStorage] or [SparseStorage].

impl Debug for Inventory

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

Formats the value using the given formatter.

impl Default for Inventory

fn default() -> Inventory

Returns the “default value” for a type.