Module archetype

Types for defining Archetypes, collections of entities that have the same set of components.

An archetype uniquely describes a group of entities that share the same components: a world only has one archetype for each unique combination of components, and all entities that have those components and only those components belong to that archetype.

Archetypes are not to be confused with Tables. Each archetype stores its table components in one table, and each archetype uniquely points to one table, but multiple archetypes may store their table components in the same table. These archetypes differ only by the SparseSet components.

Like tables, archetypes can be created but are never cleaned up. Empty archetypes are not removed, and persist until the world is dropped.

Archetypes can be fetched from Archetypes, which is accessible via World::archetypes.

Structs

Archetype

Metadata for a single archetype within a World.

ArchetypeComponentId

An opaque unique joint ID for a Component in an Archetype within a World.

ArchetypeEntity

Metadata about an Entity in a Archetype.

ArchetypeGeneration

The next ArchetypeId in an Archetypes collection.

ArchetypeId

An opaque unique ID for a single Archetype within a World.

ArchetypeRecord

Metadata about how a component is stored in an Archetype.

ArchetypeRow

An opaque location within a Archetype.

Archetypes

The backing store of all Archetypes within a World.

Edges

Archetypes and bundles form a graph. Adding or removing a bundle moves an Entity to a new Archetype.

Type Aliases

ComponentIndex

Maps a ComponentId to the list of Archetypes that contain the Component, along with an ArchetypeRecord which contains some metadata about how the component is stored in the archetype.