Skip to main content

OnGuiClosedEvent

Struct OnGuiClosedEvent 

Source
pub struct OnGuiClosedEvent {
    pub element: LuaGuiElement,
    pub entity: LuaEntity,
    pub equipment: LuaEquipment,
    pub gui_type: &'static str,
    pub inventory: LuaInventory,
    pub item: LuaItemStack,
    pub name: &'static str,
    pub other_player: LuaPlayer,
    pub player_index: u32,
    pub surface_index: u32,
    pub tick: u32,
    pub tile_position: LuaAny,
}
Expand description

Called when the player closes the GUI they have open.

This can only be raised when the GUI’s player controller is still valid. If a GUI is thus closed due to the player disconnecting, dying, or becoming a spectator in other ways, it won’t cause this event to be raised.

It’s not advised to open any other GUI during this event because if this is run as a request to open a different GUI the game will force close the new opened GUI without notice to ensure the original requested GUI is opened.

Fields§

§element: LuaGuiElement§entity: LuaEntity§equipment: LuaEquipment§gui_type: &'static str§inventory: LuaInventory§item: LuaItemStack§name: &'static str§other_player: LuaPlayer§player_index: u32§surface_index: u32§tick: u32§tile_position: LuaAny

Trait Implementations§

Source§

impl Clone for OnGuiClosedEvent

Source§

fn clone(&self) -> OnGuiClosedEvent

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 OnGuiClosedEvent

Source§

impl Debug for OnGuiClosedEvent

Source§

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

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

impl Default for OnGuiClosedEvent

Source§

fn default() -> OnGuiClosedEvent

Returns the “default value” for a type. Read more
Source§

impl PartialEq for OnGuiClosedEvent

Source§

fn eq(&self, other: &OnGuiClosedEvent) -> 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 OnGuiClosedEvent

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.