Struct Passengers 

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

Automatically maintained on a vehicle entity; lists the entities currently riding it.

This is populated by inserting Riding on passenger entities. You can access the passenger entities using .iter()

Trait Implementations

impl Component for Passengers

where Passengers: Send + Sync + 'static,

const STORAGE_TYPE: StorageType = bevy_ecs::component::StorageType::Table

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 register_required_components( _requiree: ComponentId, required_components: &mut RequiredComponentsRegistrator<'_, '_>, )

Registers required components.

fn on_discard() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_discard 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.

fn map_entities<M>(this: &mut Passengers, mapper: &mut M)

where M: EntityMapper,

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]

fn relationship_accessor() -> Option<ComponentRelationshipAccessor<Passengers>>

Returns ComponentRelationshipAccessor required for working with relationships in dynamic contexts.

fn on_add() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

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

fn on_insert() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

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

fn on_remove() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

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

fn on_despawn() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

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

impl Debug for Passengers

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

Formats the value using the given formatter.

impl RelationshipTarget for Passengers

const LINKED_SPAWN: bool = false

If this is true, when despawning or cloning (when linked cloning is enabled), the related entities targeting this entity will also be despawned or cloned.

type Relationship = Riding

The Relationship that populates this RelationshipTarget collection.

type Collection = Vec<Entity>

The collection type that stores the “source” entities for this RelationshipTarget component.

fn collection(&self) -> &<Passengers as RelationshipTarget>::Collection

Returns a reference to the stored RelationshipTarget::Collection.

fn collection_mut_risky( &mut self, ) -> &mut <Passengers as RelationshipTarget>::Collection

Returns a mutable reference to the stored RelationshipTarget::Collection.

fn from_collection_risky( collection: <Passengers as RelationshipTarget>::Collection, ) -> Passengers

Creates a new RelationshipTarget from the given RelationshipTarget::Collection.

fn on_discard(world: DeferredWorld<'_>, _: HookContext)

The on_discard component hook that maintains the Relationship / RelationshipTarget connection.

fn on_despawn(world: DeferredWorld<'_>, _: HookContext)

The on_despawn component hook that despawns entities stored in an entity’s RelationshipTarget when that entity is despawned.

fn with_capacity(capacity: usize) -> Self

Creates this RelationshipTarget with the given pre-allocated entity capacity.

fn iter( &self, ) -> <Self::Collection as RelationshipSourceCollection>::SourceIter<'_>

Iterates the entities stored in this collection.

fn len(&self) -> usize

Returns the number of entities in this collection.

fn is_empty(&self) -> bool

Returns true if this entity collection is empty.