Struct Entity 

pub struct Entity { /* private fields */ }

The fundamental entity in the engine, combining a transform with a collection of behavior-defining components.

Implementations

impl Entity

Implements static factory and ID generation methods for Entity.

pub fn generate_id() -> u64

Generates the next unique entity ID using a global atomic counter.

Returns

• u64 - The next unique ID.

pub fn create<N>(name: N) -> Entity

where N: AsRef<str>,

Creates a new entity with the given name and a default identity transform.

Creates a new entity with the given name and a default identity transform.

Arguments

• N - The name of the entity.

Returns

• Entity - The newly created entity.

pub fn create_at(position: Vector2D) -> Entity

Creates a new entity at the specified position with a default name.

Arguments

• Vector2D - The initial position.

Returns

• Entity - The newly created entity.

impl Entity

Implements pooled entity lifecycle methods for Entity.

These pair ObjectPool with Entity so a spawn/despawn cycle reuses the same allocation instead of dropping the entity and building a new one. A recycled entity is reset to a clean state and given a fresh id, so a stale reference held elsewhere can never alias a live entity.

pub fn create_pooled<N>(name: N, pool: &mut ObjectPool<Entity>) -> Self

where N: Into<String>,

Checks an entity out of the pool, creating one if the pool is empty.

Arguments

• N - The name given to the entity, anything that converts into a String.
• &mut ObjectPool<Entity> - The pool the entity is checked out from.

Returns

• Entity - A ready-to-use entity carrying the requested name.

pub fn create_pooled_at( position: Vector2D, pool: &mut ObjectPool<Entity>, ) -> Self

Checks an entity out of the pool and places it at position.

The position is applied after the recycle reset, so a recycled entity never keeps the position it was last drawn at.

Arguments

• Vector2D - Where the entity should sit.
• &mut ObjectPool<Entity> - The pool the entity is checked out from.

Returns

• Entity - A ready-to-use entity at the requested position.

pub fn prewarm_pool(count: usize, pool: &mut ObjectPool<Entity>) -> usize

Builds count entities into the pool’s free list.

Only the shortfall is built, so prewarming an already-warm pool costs nothing and a spawn burst does not grow the pool mid-frame.

Arguments

• usize - How many free entities the pool should hold.
• &mut ObjectPool<Entity> - The pool to prewarm.

Returns

• usize - The number of entities that were built.

pub fn release_to_pool(entity: &mut Entity, pool: &mut ObjectPool<Entity>)

Resets an entity and hands it back to the pool.

Components, tags and transform are cleared before the entity is released so a recycled entity never inherits stale state. A fresh id is assigned on the next checkout, so the released entity’s id is not reused.

Arguments

• &mut Entity - The entity to recycle.
• &mut ObjectPool<Entity> - The pool to return it to.

impl Entity

Implements lifecycle and component management methods for Entity.

pub fn add_component(&mut self, component: ComponentRc)

Adds a component to this entity and calls its on_start lifecycle method.

Arguments

• ComponentRc - The component to add.

pub fn remove_component_by_name<N>(&mut self, name: N) -> Option<ComponentRc>

where N: AsRef<str>,

Removes the first component matching the given name.

Arguments

• N - The component name to match.

Returns

• Option<ComponentRc> - The removed component, if found.

pub fn get_component_by_name<N>(&self, name: N) -> Option<ComponentRc>

where N: AsRef<str>,

Returns the first component matching the given name.

Arguments

• N - The component name to match.

Returns

• Option<ComponentRc> - The matching component, if found.

pub fn update(&mut self, delta_time: f64)

Calls on_update on all active components.

Arguments

• f64 - The delta time in seconds.

pub fn render(&self, draw_list: &mut DrawList)

Calls on_render on all active components, recording into the draw list.

Arguments

• &mut DrawList - The draw list to record commands into.

pub fn destroy(&mut self)

Calls on_destroy on all components and clears the component list.

pub fn add_tag(&mut self, tag: String)

Adds a tag string to this entity.

Arguments

• String - The tag to add.

pub fn has_tag<T>(&self, tag: T) -> bool

where T: AsRef<str>,

Tests whether this entity has the given tag.

Arguments

• T - The tag to check.

Returns

• bool - True if the tag is present.

impl Entity

pub fn get_id(&self) -> u64

pub fn get_mut_id(&mut self) -> &mut u64

pub fn set_id(&mut self, val: u64) -> &mut Self

pub fn get_name(&self) -> &String

pub fn get_mut_name(&mut self) -> &mut String

pub fn set_name(&mut self, val: String) -> &mut Self

pub fn get_transform(&self) -> Transform2D

pub fn set_transform(&mut self, val: Transform2D) -> &mut Self

pub fn get_active(&self) -> bool

pub fn get_mut_active(&mut self) -> &mut bool

pub fn set_active(&mut self, val: bool) -> &mut Self

pub fn get_components(&self) -> &Vec<ComponentRc>

pub fn set_components(&mut self, val: Vec<ComponentRc>) -> &mut Self

pub fn get_tags(&self) -> &Vec<String>

pub fn set_tags(&mut self, val: Vec<String>) -> &mut Self

impl Entity

pub fn new( id: u64, name: String, transform: Transform2D, active: bool, components: Vec<ComponentRc>, tags: Vec<String>, ) -> Self

Trait Implementations

impl Clone for Entity

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Updatable for Entity

Forwards Entity::update through the Updatable trait so that collections of heterogeneous updateable objects can be driven by the scheduler.

The inherent Entity::update method is the canonical implementation; this impl exists purely for trait dispatch. The inherent call resolves first when both are in scope, so there is no recursion.

fn update(&mut self, delta_time: f64)

Advances the simulation by delta_time seconds.

Arguments

• f64 - Seconds elapsed since the previous update.