Struct tuix_internal::Event

pub struct Event {
    pub origin: Entity,
    pub target: Entity,
    pub propagation: Propagation,
    pub consumable: bool,
    pub unique: bool,
    pub order: i32,
    pub message: Box<dyn Message + 'static, Global>,
    // some fields omitted
}

An event is a wrapper around a message and provides metadata on how the event should be propagated through the tree

Fields

origin: Entity

target: Entity

propagation: Propagation

consumable: bool

unique: bool

order: i32

message: Box<dyn Message + 'static, Global>

Implementations

impl Event

pub fn new<M>(message: M) -> Event where
    M: Message, 

Creates a new event with a specified message

pub fn target(self, entity: Entity) -> Event

Sets the target of the event

pub fn origin(self, entity: Entity) -> Event

Sets the origin of the event

pub fn unique(self) -> Event

Specifies that the event is unique (only one of this event type should exist in the event queue at once)

pub fn propagate(self, propagation: Propagation) -> Event

Sets the propagation of the event

pub fn direct(self, entity: Entity) -> Event

pub fn consume(&mut self)

Consumes the event (prevents the event from continuing on its propagation path)

Trait Implementations

impl PartialEq<Event> for Event

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.