Struct ObserverState

pub struct ObserverState { /* private fields */ }

Contains Observer information. This defines how a given observer behaves. It is the “source of truth” for a given observer entity’s behavior.

Implementations

impl ObserverState

pub fn with_event(self, event: ComponentId) -> ObserverState

Observe the given event. This will cause the Observer to run whenever an event with the given ComponentId is triggered.

pub fn with_events( self, events: impl IntoIterator<Item = ComponentId>, ) -> ObserverState

Observe the given event list. This will cause the Observer to run whenever an event with any of the given ComponentIds is triggered.

pub fn with_entities( self, entities: impl IntoIterator<Item = Entity>, ) -> ObserverState

Observe the given Entity list. This will cause the Observer to run whenever the Event is triggered for any Entity target in the list.

pub fn with_components( self, components: impl IntoIterator<Item = ComponentId>, ) -> ObserverState

Observe the given ComponentId list. This will cause the Observer to run whenever the Event is triggered for any ComponentId target in the list.

Trait Implementations

impl Component for ObserverState

const STORAGE_TYPE: StorageType = StorageType::SparseSet

A constant indicating the storage type used for this component.

fn register_component_hooks(hooks: &mut ComponentHooks)

Called when registering this component, allowing mutable access to its ComponentHooks.

fn register_required_components( _component_id: ComponentId, _components: &mut Components, _storages: &mut Storages, _required_components: &mut RequiredComponents, _inheritance_depth: u16, )

Registers required components.

impl Default for ObserverState

fn default() -> ObserverState

Returns the “default value” for a type.