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) -> Self

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>) -> Self

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>) -> Self

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>, ) -> Self

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.

type Mutability = Mutable

A marker type to assist Bevy with determining if this component is mutable, or immutable. Mutable components will have [Component<Mutability = Mutable>], while immutable components will instead have [Component<Mutability = Immutable>].

fn on_add() -> Option<ComponentHook>

Gets the on_add ComponentHook for this Component if one is defined.

fn on_remove() -> Option<ComponentHook>

Gets the on_remove ComponentHook for this Component if one is defined.

fn register_component_hooks(hooks: &mut ComponentHooks)

👎Deprecated since 0.16.0: Use the individual hook methods instead (e.g., Component::on_add, etc.)

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

fn on_insert() -> Option<ComponentHook>

Gets the on_insert ComponentHook for this Component if one is defined.

fn on_replace() -> Option<ComponentHook>

Gets the on_replace ComponentHook for this Component if one is defined.

fn on_despawn() -> Option<ComponentHook>

Gets the on_despawn ComponentHook for this Component if one is defined.

fn register_required_components( _component_id: ComponentId, _components: &mut ComponentsRegistrator<'_>, _required_components: &mut RequiredComponents, _inheritance_depth: u16, _recursion_check_stack: &mut Vec<ComponentId>, )

Registers required components.

fn clone_behavior() -> ComponentCloneBehavior

Called when registering this component, allowing to override clone function (or disable cloning altogether) for this component.

fn map_entities<E: EntityMapper>(_this: &mut Self, _mapper: &mut E)

Maps the entities on this component using the given EntityMapper. This is used to remap entities in contexts like scenes and entity cloning. When deriving Component, this is populated by annotating fields containing entities with #[entities]

impl Default for ObserverState

fn default() -> Self

Returns the “default value” for a type.