Enum EntityRef 

pub enum EntityRef {
    Worldspawn,
    Entity(ErasedEntityHandle),
}

Abstraction around bevy_ecs::entity::Entity that allows us to impl Default without world access.

Variants

Worldspawn

The zero value for an entity reference - it is invalid to read or write fields on this type (TODO: is this true?), but it can be useful to pass it as an argument to builtins.

Entity(ErasedEntityHandle)

We use Entity rather than an index here so entities that aren’t managed by the VM can still be passed to QuakeC functions.

Implementations

impl EntityRef

pub fn new<T: EntityHandle>(value: T) -> Self

Create an EntityRef from a T: EntityHandle.

pub fn non_null(self) -> Result<ErasedEntityHandle>

If the entity reference is not Worldspawn, return the inner entity.

pub fn is_null(&self) -> bool

If the reference is Worldspawn, then true. Otherwise false.

Trait Implementations

impl Clone for EntityRef

fn clone(&self) -> EntityRef

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EntityRef

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

Formats the value using the given formatter.

impl Default for EntityRef

fn default() -> EntityRef

Returns the “default value” for a type.

impl From<EntityRef> for Value

fn from(value: EntityRef) -> Self

Converts to this type from the input type.

impl PartialEq for EntityRef

fn eq(&self, other: &Self) -> 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 TryFrom<Value> for EntityRef

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Value) -> Result<Self, Self::Error>

Performs the conversion.