Struct Menu 

pub struct Menu {
    behavior: MenuBehavior,
    layout: MenuLayout,
    kind: Box<dyn MenuKind>,
    overrides_player_slots: bool,
}

A menu opened by a player: the shared click machinery plus one MenuKind.

The single concrete menu type. It owns the MenuBehavior, the MenuLayout, and a boxed MenuKind. Click handlers are inherent methods.

Fields

behavior: MenuBehavior

layout: MenuLayout

kind: Box<dyn MenuKind>

overrides_player_slots: bool

Implementations

impl Menu

pub(super) fn from_parts( behavior: MenuBehavior, layout: MenuLayout, kind: Box<dyn MenuKind>, overrides_player_slots: bool, ) -> Self

Assembles a menu from its parts.

pub const fn behavior(&self) -> &MenuBehavior

Returns a reference to the shared menu behavior.

pub const fn behavior_mut(&mut self) -> &mut MenuBehavior

Returns a mutable reference to the shared menu behavior.

pub fn kind(&self) -> &dyn MenuKind

Returns a reference to this menu’s kind.

pub fn kind_mut(&mut self) -> &mut dyn MenuKind

Returns a mutable reference to this menu’s kind.

pub const fn container_id(&self) -> u8

The container ID for this menu (0 for the player inventory).

pub const fn menu_type(&self) -> Option<MenuTypeRef>

The menu type for the open-screen packet, or None for the player’s own inventory.

pub const fn overrides_player_slots(&self) -> bool

Returns whether this menu paints over the client’s standard player slots.

pub fn still_valid(&self, player: &Player) -> bool

Returns true if this menu is still valid for the player.

pub fn can_take_item_for_pick_all( &self, carried: &ItemStack, slot_index: usize, ) -> bool

Returns true if the item can be taken from the slot during pickup all.

pub fn removed(&mut self, player: &Player)

Called when the menu is closed. Hands the carried item and input sections back to the player, then runs the kind’s cleanup. Items drop into the world if the player can’t take them (see Player::returns_menu_items_to_inventory).

pub fn set_item_name(&mut self, name: impl Into<String>, player: &Player)

Applies a client rename to the menu’s kind. A no-op for kinds without a rename input.

pub(crate) fn clear_or_count_crafting_items( &mut self, predicate: &dyn Fn(&ItemStack) -> bool, amount_to_remove: i32, counting_only: bool, ) -> i32

Clears or counts crafting-grid items in the base inventory menu, returning the number cleared or counted. Returns 0 for any other menu.

pub(crate) fn update_crafting_result(&mut self)

Recomputes the base inventory menu’s crafting result. A no-op for any other menu.

fn slots_changed(&mut self, guard: &mut ContainerLockGuard, player: &Player)

Recomputes recipe-driven slots after a change (delegates to the kind).

pub fn on_open(&mut self, player: &Player)

Runs the kind’s on_open hook, after contents are built but before they are sent to the client.

pub fn on_tick(&mut self, player: &Player)

Runs the kind’s on_tick hook. Called once per server tick while open.

fn quick_move_stack( &mut self, guard: &mut ContainerLockGuard, slot_index: usize, player: &Player, ) -> ItemStack

Shift-click (quick move) for a slot: the kind’s override if any, else the declarative route table. Returns the item originally in the slot, or empty if nothing moved.

pub fn clicked(&mut self, click: Click, player: &Player)

Handles a click action in this menu. Packet clicks are validated via Click::parse; invalid programmatically constructed clicks are ignored.

TODO: Add tryItemClickBehaviorOverride for bundle item support.

fn do_quick_move(&mut self, slot_index: usize, player: &Player)

Handles quick move (shift-click).

fn do_swap(&mut self, slot_index: usize, with: SwapTarget, player: &Player)

Handles swap (number keys for a hotbar slot, or swap-hands for the offhand).

fn do_pickup_all( &mut self, slot_index: usize, direction: FillDirection, player: &Player, )

Handles pickup all (double-click): collects matching items from all slots into the carried stack.

Trait Implementations

impl Debug for Menu

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

Formats the value using the given formatter.