cubos::core::ecs::EntityPool class final
#include <core/ecs/entity/pool.hpp>

Manages the creation and destruction of entity identifiers, as well as storing their archetype identifiers.

Public functions

void reset(): Resets the pool to its initial state.
auto create(ArchetypeId archetype) -> Entity: Creates a new entity on the given archetype.
void destroy(uint32_t index): Removes an entity from the world.
void archetype(uint32_t index, ArchetypeId archetype): Changes the archetype identifier of an entity.
auto archetype(uint32_t index) const -> ArchetypeId: Gets the archetype identifier of an entity.
auto generation(uint32_t index) const -> uint32_t: Gets the generation of an entity index.
auto contains(Entity entity) const -> bool: Checks if a given entity exists.
auto size() const -> size_t: Gets the number of alive entities in the pool.

Resets the pool to its initial state.

Previously returned entity identifiers become invalid, as they might be reused.

Creates a new entity on the given archetype.

Parameters
archetype	Archetype identifier.
Returns	Entity.

Removes an entity from the world.

Parameters
index	Entity index to remove.

Changes the archetype identifier of an entity.

Parameters
index	Entity index.
archetype	New archetype identifier.

Gets the archetype identifier of an entity.

Parameters
index	Entity index.
Returns	Archetype identifier.

Gets the generation of an entity index.

Parameters
index	Entity index.
Returns	Generation.

Checks if a given entity exists.

Parameters
entity	Entity to check.
Returns	Whether the entity exists.

Gets the number of alive entities in the pool.

Returns	Number of entities.