Skip to main content

RecipeBookFillRequestEvent

Struct RecipeBookFillRequestEvent 

Source
pub struct RecipeBookFillRequestEvent {
    pub recipe_id: RecipeId,
    pub make_all: bool,
    pub cancelled: bool,
}
Expand description

A player is about to auto-fill a recipe from the recipe book (cancellable).

Fired at the Validate stage on the game bus after the server has resolved the recipe and pre-checked that the player’s inventory has enough ingredients, but before any item is moved. Cancelling the event aborts the auto-fill — the grid stays untouched and RecipeBookFilledEvent is not dispatched. Plugins use it for permission gating (admin-only recipes, anti-grief rate-limits, gated unlocks).

The crafting player is available via ctx.player().

Fields§

§recipe_id: RecipeId

Stable identifier of the recipe the player clicked.

§make_all: bool

Whether the player shift-clicked (asking for the largest possible batch). The Phase 2 server implementation always behaves as if falsetrue is plumbed through but silently degrades for now (Phase 3 will add real stacking).

§cancelled: bool

Whether this event has been cancelled by a Validate handler.

Trait Implementations§

Source§

impl Clone for RecipeBookFillRequestEvent

Source§

fn clone(&self) -> RecipeBookFillRequestEvent

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for RecipeBookFillRequestEvent

Source§

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

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

impl Event for RecipeBookFillRequestEvent

Source§

fn is_cancelled(&self) -> bool

Whether this event has been cancelled by a Validate handler.
Source§

fn cancel(&mut self)

Cancels this event. Process and Post handlers will be skipped. Read more
Source§

fn as_any(&self) -> &dyn Any

Upcasts to &dyn Any for type-erased dispatch.
Source§

fn as_any_mut(&mut self) -> &mut dyn Any

Upcasts to &mut dyn Any for mutable type-erased dispatch.
Source§

fn bus_kind(&self) -> BusKind

Returns which event bus this event is dispatched on. Read more
Source§

impl EventRouting for RecipeBookFillRequestEvent

Source§

const BUS: BusKind = crate::events::BusKind::Game

The bus this event type is dispatched on.

Auto Trait Implementations§

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
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> 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.