Struct Riding 

pub struct Riding(pub Entity);

Placed on a passenger entity, pointing at the vehicle it rides.

Inserting this component mounts the entity; removing it (or despawning the entity) dismounts it. The vehicle’s Passengers component is kept in sync automatically.

Tuple Fields

0: Entity

Methods from Deref<Target = Entity>

pub const PLACEHOLDER: Entity

Trait Implementations

impl Clone for Riding

fn clone(&self) -> Riding

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Component for Riding

where Self: Send + Sync + 'static,

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

A constant indicating the storage type used for this component.

type Mutability = Immutable

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_insert() -> Option<ComponentHook>

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

fn on_discard() -> Option<ComponentHook>

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: EntityMapper>(this: &mut Self, mapper: &mut M)

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

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_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 Riding

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

Formats the value using the given formatter.

impl Deref for Riding

type Target = Entity

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl PartialEq for Riding

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Relationship for Riding

const ALLOW_SELF_REFERENTIAL: bool = false

If true, a relationship is allowed to point to its own entity.

type RelationshipTarget = Passengers

The [Component] added to the “target” entities of this [Relationship], which contains the list of all “source” entities that relate to the “target”.

fn get(&self) -> Entity

Gets the [Entity] ID of the related entity.

fn from(entity: Entity) -> Self

Creates this [Relationship] from the given entity.

fn set_risky(&mut self, entity: Entity)

Changes the current [Entity] ID of the entity containing the [RelationshipTarget] to another one.

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

The on_insert component hook that maintains the [Relationship] / [RelationshipTarget] connection.

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

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

impl Copy for Riding

impl Eq for Riding

impl StructuralPartialEq for Riding