Skip to main content

Click

Enum Click 

Source
pub enum Click {
    Pickup {
        slot: usize,
        button: MouseButton,
    },
    DropCarried {
        button: MouseButton,
    },
    QuickMove {
        slot: usize,
    },
    Swap {
        slot: usize,
        with: SwapTarget,
    },
    Clone {
        slot: usize,
    },
    Throw {
        slot: usize,
        whole_stack: bool,
    },
    PickupAll {
        slot: usize,
        direction: FillDirection,
    },
    QuickCraft(QuickCraft),
}
Expand description

A container click, validated from the raw protocol fields.

Produced by Click::parse; every slot is guaranteed in range for the menu the click was parsed against.

Variants§

§

Pickup

Left/right click on a slot.

Fields

§slot: usize

The clicked slot.

§button: MouseButton

Which mouse button was used.

§

DropCarried

Left/right click outside the window, dropping the carried stack (slot_num == -999 on the wire).

Fields

§button: MouseButton

Left drops the whole stack, right drops a single item.

§

QuickMove

Shift-click.

Fields

§slot: usize

The clicked slot.

§

Swap

Number key 1-9 or the offhand key, swapping a menu slot with a player inventory slot.

Fields

§slot: usize

The clicked menu slot.

§with: SwapTarget

The player inventory slot to swap with.

§

Clone

Middle-click copy (creative only).

Fields

§slot: usize

The clicked slot.

§

Throw

Drop key: Q (single item) or Ctrl+Q (whole stack).

Fields

§slot: usize

The clicked slot.

§whole_stack: bool

True for Ctrl+Q (drop the whole stack, repeating while the slot refills with the same item).

§

PickupAll

Double-click, collecting matching stacks into the cursor.

Fields

§slot: usize

The double-clicked slot.

§direction: FillDirection

Which end of the menu to start collecting from.

§

QuickCraft(QuickCraft)

One phase of a drag (paint) operation.

Implementations§

Source§

impl Click

Source

pub const fn slot(&self) -> Option<usize>

The slot this click targets, or None for clicks outside the window and drag phases.

Source

pub const fn is_valid_for(&self, slot_count: usize) -> bool

Returns whether every index encoded in this click satisfies the invariants normally established by Click::parse.

Source§

impl Click

Source

pub fn parse( slot_num: i16, button: i8, click_type: ClickType, slot_count: usize, ) -> Option<Self>

Parses the raw fields of a container-click packet against a menu with slot_count slots.

Returns None for malformed input — an out-of-range slot, an invalid swap button, an unknown mouse button, or an invalid drag encoding. Callers should ignore the click (vanilla’s behavior for packets its clients never send) but may still want to resync the client.

Trait Implementations§

Source§

impl Clone for Click

Source§

fn clone(&self) -> Click

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 Copy for Click

Source§

impl Debug for Click

Source§

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

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

impl Eq for Click

Source§

impl PartialEq for Click

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Click

Auto Trait Implementations§

§

impl Freeze for Click

§

impl RefUnwindSafe for Click

§

impl Send for Click

§

impl Sync for Click

§

impl Unpin for Click

§

impl UnsafeUnpin for Click

§

impl UnwindSafe for Click

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
§

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

§

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

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

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

§

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

Compare self to key and return true if they are equal.
§

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

§

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

Compares self with key and returns true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

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

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

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> IntoShared for T

Source§

fn into_shared(self) -> Arc<Mutex<RawMutex, Self>>

Wraps this value in an Arc<SyncMutex<>>
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

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

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + 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
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + 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.
§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

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