pub struct DisconnectEvent {
pub entity: Entity,
pub reason: Option<FormattedText>,
}
Expand description
An event sent when a client got disconnected from the server.
If the client was kicked with a reason, that reason will be present in the
reason
field.
This event won’t be sent if creating the initial connection to the server
failed, for that see ConnectionFailedEvent
.
Fields§
§entity: Entity
§reason: Option<FormattedText>
Trait Implementations§
Source§impl Event for DisconnectEvent
impl Event for DisconnectEvent
Source§const AUTO_PROPAGATE: bool = false
const AUTO_PROPAGATE: bool = false
When true, this event will always attempt to propagate when triggered, without requiring a call
to
Trigger::propagate
.Source§type Traversal = ()
type Traversal = ()
The component that describes which Entity to propagate this event to next, when propagation is enabled.
§fn register_component_id(world: &mut World) -> ComponentId
fn register_component_id(world: &mut World) -> ComponentId
Generates the [
ComponentId
] for this event type. Read more§fn component_id(world: &World) -> Option<ComponentId>
fn component_id(world: &World) -> Option<ComponentId>
Fetches the [
ComponentId
] for this event type,
if it has already been generated. Read moreAuto Trait Implementations§
impl Freeze for DisconnectEvent
impl RefUnwindSafe for DisconnectEvent
impl Send for DisconnectEvent
impl Sync for DisconnectEvent
impl Unpin for DisconnectEvent
impl UnwindSafe for DisconnectEvent
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
§impl<T> CompatExt for T
impl<T> CompatExt for T
§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Converts
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
, which can then be
downcast
into Box<dyn ConcreteType>
where ConcreteType
implements Trait
.§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Converts
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
, which can then be further
downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
Converts
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
Converts
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.