ObservedBy

bevy_ecs::observer

Struct ObservedBy

pub struct ObservedBy(/* private fields */);

Expand description

Tracks a list of entity observers for the Entity ObservedBy is added to.

Implementations§

impl ObservedBy

pub fn get(&self) -> &[Entity]

Provides a read-only reference to the list of entities observing this entity.

Trait Implementations§

impl Component for ObservedBy

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>. Read more

fn on_remove() -> Option<ComponentHook>

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

fn clone_behavior() -> ComponentCloneBehavior

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

fn on_add() -> Option<ComponentHook>

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

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, _required_components: &mut RequiredComponentsRegistrator<'_, '_>, )

Registers required components. Read more

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] Read more

impl Debug for ObservedBy

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

Formats the value using the given formatter. Read more

impl Default for ObservedBy

fn default() -> ObservedBy

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

Auto Trait Implementations§

impl Freeze for ObservedBy

impl RefUnwindSafe for ObservedBy

impl Send for ObservedBy

impl Sync for ObservedBy

impl Unpin for ObservedBy

impl UnwindSafe for ObservedBy

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<C> Bundle for C
where C: Component,

fn component_ids( components: &mut ComponentsRegistrator<'_>, ids: &mut impl FnMut(ComponentId), )

fn get_component_ids( components: &Components, ids: &mut impl FnMut(Option<ComponentId>), )

Gets this Bundle’s component ids. This will be None if the component has not been registered.

impl<C> BundleFromComponents for C
where C: Component,

unsafe fn from_components<T, F>(ctx: &mut T, func: &mut F) -> C
where F: for<'a> FnMut(&'a mut T) -> OwningPtr<'a>,

impl<C> DynamicBundle for C
where C: Component,

type Effect = ()

An operation on the entity that happens after inserting this bundle.

unsafe fn get_components( ptr: MovingPtr<'_, C>, func: &mut impl FnMut(StorageType, OwningPtr<'_>), ) -> <C as DynamicBundle>::Effect

Moves the components out of the bundle. Read more

unsafe fn apply_effect( _ptr: MovingPtr<'_, MaybeUninit<C>>, _entity: &mut EntityWorldMut<'_>, )

Applies the after-effects of spawning this bundle. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> FromWorld for T
where T: Default,

fn from_world(_world: &mut World) -> T

Creates Self using default().

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoResult<T> for T

fn into_result(self) -> Result<T, RunSystemError>

Converts this type into the system output type.

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<T> ConditionalSend for T
where T: Send,