Struct Rider 

pub struct Rider { /* private fields */ }

Core component for any entity that rides elevators.

This is the minimum data the simulation needs. Games attach additional components (VipTag, FreightData, PersonData, etc.) for game-specific behavior. An entity with Rider but no Route component can be boarded/exited manually by game code.

Implementations

impl Rider

pub const fn weight(&self) -> Weight

Weight contributed to elevator load.

pub const fn phase(&self) -> RiderPhase

Current rider lifecycle phase.

pub const fn current_stop(&self) -> Option<EntityId>

The stop entity this rider is currently at (while Waiting/Arrived/Abandoned/Resident).

pub const fn spawn_tick(&self) -> u64

Tick when this rider was spawned.

pub const fn board_tick(&self) -> Option<u64>

Tick when this rider boarded (for ride-time metrics).

pub const fn tag(&self) -> u64

Opaque consumer-attached tag. The engine doesn’t interpret this value; consumers use it to correlate riders with external identifiers (e.g. a game-side sim id, a player id, a freight shipment id) without maintaining a parallel RiderId → u64 map. Defaults to 0, which is reserved by convention for “untagged.”

Trait Implementations

impl Clone for Rider

fn clone(&self) -> Rider

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Rider

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Rider

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Rider

fn eq(&self, other: &Rider) -> 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 Serialize for Rider

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl WorldQuery for &Rider

type Item<'w> = &'w Rider

The item yielded per entity.

fn fetch(world: &World, id: EntityId) -> Option<Self::Item<'_>>

Try to fetch data for a single entity. Returns None if missing.

fn contains(world: &World, id: EntityId) -> bool

Check component presence without extracting data.

impl StructuralPartialEq for Rider