Struct ambient_api::prelude::Entity

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

An Entity is a collection of components and associated values.

Use the spawn method to insert the Entity into the world.

Implementations

impl Entity

pub fn new() -> Entity

Creates a new Entity.

pub fn len(&self) -> usize

Returns the number of component (values) in the entity.

pub fn is_empty(&self) -> bool

Returns true if the entity has no components (values).

pub fn has<T>(&self, component: Component<T>) -> boolwhere T: SupportedValue,

Returns true if this has component.

pub fn has_components(&self, components: &[&dyn UntypedComponent]) -> bool

Returns true if this has all of components.

pub fn get<T>(&self, component: Component<T>) -> Option<T>where T: SupportedValue,

Gets the data for component in this, if it exists.

pub fn get_ref<T>(&self, component: Component<T>) -> Option<&T>where T: SupportedValueRef,

Gets a reference to the data for component in this, if it exists.

pub fn set<T>(&mut self, component: Component<T>, value: T)where T: SupportedValue,

Adds component to this with value. It will replace an existing component if present.

pub fn set_default<T>(&mut self, component: Component<T>)where T: SupportedValue + Default,

Sets the component in this to the default value for T.

pub fn with<T>(self, component: Component<T>, value: T) -> Entitywhere T: SupportedValue,

Adds component to this with value, and returns self to allow for easy chaining.

pub fn with_merge(self, other: impl Into<Entity>) -> Entity

Merges in the other Entity and returns this; any fields that were present in both will be replaced by other’s.

pub fn without<T>(self, component: Component<T>) -> Entitywhere T: SupportedValue,

Removes component to this with value, and returns self to allow for easy chaining.

pub fn remove<T>(&mut self, component: Component<T>) -> Option<T>where T: SupportedValue,

Removes the specified component from this, and returns the value if it was present.

pub fn merge(&mut self, other: Entity)

Merges in the other Entity; any fields that were present in both will be replaced by other’s.

pub fn spawn(&self) -> EntityId

Spawns an entity with these components.

Returns spawned_entity_uid.

Trait Implementations

impl Clone for Entity

fn clone(&self) -> Entity

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Entity

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

Formats the value using the given formatter.

impl Default for Entity

fn default() -> Entity

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Entity

fn deserialize<__D>( __deserializer: __D ) -> Result<Entity, <__D as Deserializer<'de>>::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T> From<T> for Entitywhere T: Concept,

fn from(concept: T) -> Entity

Converts to this type from the input type.

impl PartialEq for Entity

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

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

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

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

impl Serialize for Entity

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

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Entity