Struct RestrictedSlot 

pub struct RestrictedSlot {
    base: NormalSlot,
    rules: Arc<RestrictedRules>,
}

A NormalSlot with custom place and pickup rules.

Fields

base: NormalSlot

rules: Arc<RestrictedRules>

Implementations

impl RestrictedSlot

pub fn new( container: impl Into<ContainerRef>, index: usize, may_place: impl Fn(usize, &ItemStack) -> bool + Send + Sync + 'static, ) -> Self

Placement gated by may_place, which receives the container-local slot index; pickup stays allowed.

pub fn guarded( container: impl Into<ContainerRef>, index: usize, may_place: impl Fn(usize, &ItemStack) -> bool + Send + Sync + 'static, may_pickup: impl Fn(usize, &ItemStack, &ContainerLockGuard, &Player) -> bool + Send + Sync + 'static, ) -> Self

Like new, but pickup is gated too.

pub(crate) fn with_rules( container: impl Into<ContainerRef>, index: usize, rules: Arc<RestrictedRules>, ) -> Self

Shares one rules object across a whole section’s slots.

Trait Implementations

impl DowncastType for RestrictedSlot

const TYPE_KEY: DowncastTypeKey

The process-wide key for this concrete type.

impl Slot for RestrictedSlot

fn storage(&self) -> &SlotStorage

Returns this slot’s physical storage and auxiliary dependencies.

fn get_item<'a>(&self, guard: &'a ContainerLockGuard) -> &'a ItemStack

Returns a reference to the item in this slot.

fn get_item_mut<'a>( &self, guard: &'a mut ContainerLockGuard, ) -> &'a mut ItemStack

Returns a mutable reference to the item in this slot.

fn set_item(&self, guard: &mut ContainerLockGuard, stack: ItemStack)

Sets the item in this slot.

fn may_place(&self, stack: &ItemStack) -> bool

Returns true if the given item can be placed in this slot.

fn may_pickup(&self, guard: &ContainerLockGuard, player: &Player) -> bool

Returns true if items can be picked up from this slot.

fn get_max_stack_size(&self, guard: &ContainerLockGuard) -> i32

Returns the maximum stack size for this slot.

fn set_changed(&self, guard: &mut ContainerLockGuard)

Marks the slot’s container as changed.

fn get_container_slot(&self) -> usize

Returns the container slot index.

fn set_by_player( &self, guard: &mut ContainerLockGuard, stack: ItemStack, _previous: &ItemStack, )

Sets the item, triggered by a player action. previous is the prior item.

fn has_item(&self, guard: &ContainerLockGuard) -> bool

Returns true if this slot has an item.

fn allow_modification( &self, guard: &ContainerLockGuard, player: &Player, ) -> bool

Returns true if partial removal is allowed from this slot.

fn get_max_stack_size_for_item( &self, guard: &ContainerLockGuard, stack: &ItemStack, ) -> i32

Returns the max stack size for stack here (min of slot and item limits).

fn remove(&self, guard: &mut ContainerLockGuard, amount: i32) -> ItemStack

Removes up to amount items from this slot and returns them.

fn try_remove( &self, guard: &mut ContainerLockGuard, amount: i32, max_amount: i32, player: &Player, ) -> Option<ItemStack>

Tries to remove items from this slot with validation.

fn on_take( &self, guard: &mut ContainerLockGuard, _stack: &ItemStack, _player: &Player, ) -> Option<ItemStack>

Called when an item is taken. Returns any remainder that couldn’t be placed back.

fn safe_take( &self, guard: &mut ContainerLockGuard, amount: i32, max_amount: i32, player: &Player, ) -> ItemStack

Takes items with all checks and callbacks. Returns the items taken.

fn safe_insert( &self, guard: &mut ContainerLockGuard, input: ItemStack, amount: i32, ) -> ItemStack

Inserts up to amount items, firing set callbacks.

fn is_fake(&self) -> bool

Returns true if normal menu persistence and transfer rules must not be applied to this slot.