Struct rangoon::Entity

pub struct Entity { /* fields omitted */ }

Lightweight unique ID, or handle, of an entity

Obtained from World::spawn. Can be stored to refer to an entity in the future.

Implementations

impl Entity

pub fn to_bits(self) -> u64

Convert to a form convenient for passing outside of rust

No particular structure is guaranteed for the returned bits.

Useful for storing entity IDs externally, or in conjunction with Entity::from_bits and World::spawn_at for easy serialization. Alternatively, consider id for more compact representation.

pub fn from_bits(bits: u64) -> Entity

Reconstruct an Entity previously destructured with to_bits

Useful for storing entity IDs externally, or in conjunction with Entity::to_bits and World::spawn_at for easy serialization.

pub fn id(self) -> u32

Extract a transiently unique identifier

No two simultaneously-live entities share the same ID, but dead entities' IDs may collide with both live and dead entities. Useful for compactly representing entities within a specific snapshot of the world, such as when serializing.

See also World::find_entity_from_id.

Trait Implementations

impl Clone for Entity

pub fn clone(&self) -> Entity

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Entity

impl Debug for Entity

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

Formats the value using the given formatter.

impl Eq for Entity

impl Hash for Entity

pub fn hash<__H>(&self, state: &mut __H) where
    __H: Hasher, 

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Ord for Entity

pub fn cmp(&self, other: &Entity) -> Ordering

This method returns an Ordering between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<Entity> for Entity

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<Entity> for Entity

pub fn partial_cmp(&self, other: &Entity) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

pub fn lt(&self, other: &Entity) -> bool

This method tests less than (for self and other) and is used by the < operator.

pub fn le(&self, other: &Entity) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

pub fn gt(&self, other: &Entity) -> bool

This method tests greater than (for self and other) and is used by the > operator.

pub fn ge(&self, other: &Entity) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for Entity

impl StructuralPartialEq for Entity