Struct Archetype

pub struct Archetype { /* private fields */ }

Metadata for a single archetype within a World.

For more information, see the module level documentation.

Implementations

impl Archetype

pub fn id(&self) -> ArchetypeId

Fetches the ID for the archetype.

pub fn table_id(&self) -> TableId

Fetches the archetype’s Table ID.

pub fn entities(&self) -> &[ArchetypeEntity]

Fetches the entities contained in this archetype.

pub fn table_components(&self) -> impl Iterator<Item = ComponentId> + '_

Gets an iterator of all of the components stored in Tables.

All of the IDs are unique.

pub fn sparse_set_components(&self) -> impl Iterator<Item = ComponentId> + '_

Gets an iterator of all of the components stored in ComponentSparseSets.

All of the IDs are unique.

pub fn components(&self) -> impl Iterator<Item = ComponentId> + '_

Gets an iterator of all of the components in the archetype.

All of the IDs are unique.

pub fn component_count(&self) -> usize

Returns the total number of components in the archetype

pub fn edges(&self) -> &Edges

Fetches a immutable reference to the archetype’s Edges, a cache of archetypal relationships.

pub fn entity_table_row(&self, row: ArchetypeRow) -> TableRow

Fetches the row in the Table where the components for the entity at index is stored.

An entity’s archetype row can be fetched from EntityLocation::archetype_row, which can be retrieved from Entities::get.

Panics

This function will panic if index >= self.len().

pub fn len(&self) -> usize

Gets the total number of entities that belong to the archetype.

pub fn is_empty(&self) -> bool

Checks if the archetype has any entities.

pub fn contains(&self, component_id: ComponentId) -> bool

Checks if the archetype contains a specific component. This runs in O(1) time.

pub fn get_storage_type(&self, component_id: ComponentId) -> Option<StorageType>

Gets the type of storage where a component in the archetype can be found. Returns None if the component is not part of the archetype. This runs in O(1) time.

pub fn get_archetype_component_id( &self, component_id: ComponentId, ) -> Option<ArchetypeComponentId>

Fetches the corresponding ArchetypeComponentId for a component in the archetype. Returns None if the component is not part of the archetype. This runs in O(1) time.

pub fn has_add_hook(&self) -> bool

Returns true if any of the components in this archetype have on_add hooks

pub fn has_insert_hook(&self) -> bool

Returns true if any of the components in this archetype have on_insert hooks

pub fn has_remove_hook(&self) -> bool

Returns true if any of the components in this archetype have on_remove hooks

pub fn has_add_observer(&self) -> bool

Returns true if any of the components in this archetype have at least one OnAdd observer

pub fn has_insert_observer(&self) -> bool

Returns true if any of the components in this archetype have at least one OnInsert observer

pub fn has_remove_observer(&self) -> bool

Returns true if any of the components in this archetype have at least one OnRemove observer

Trait Implementations

impl QueryData for &Archetype

SAFETY: Self is the same as Self::ReadOnly

type ReadOnly = &Archetype

The read-only variant of this QueryData, which satisfies the ReadOnlyQueryData trait.

impl WorldQuery for &Archetype

SAFETY: update_component_access and update_archetype_component_access do nothing. This is sound because fetch does not access components.

const IS_DENSE: bool = true

Returns true if (and only if) every table of every archetype matched by this fetch contains all of the matched components. This is used to select a more efficient “table iterator” for “dense” queries. If this returns true, WorldQuery::set_table must be used before WorldQuery::fetch can be called for iterators. If this returns false, WorldQuery::set_archetype must be used before WorldQuery::fetch can be called for iterators.

type Item<'w> = &'w Archetype

The item returned by this WorldQuery For QueryData this will be the item returned by the query. For QueryFilter this will be either (), or a bool indicating whether the entity should be included or a tuple of such things.

type Fetch<'w> = (&'w Entities, &'w Archetypes)

Per archetype/table state used by this WorldQuery to fetch Self::Item

type State = ()

State used to construct a Self::Fetch. This will be cached inside QueryState, so it is best to move as much data / computation here as possible to reduce the cost of constructing Self::Fetch.

fn shrink<'wlong: 'wshort, 'wshort>( item: Self::Item<'wlong>, ) -> Self::Item<'wshort>

This function manually implements subtyping for the query items.

unsafe fn init_fetch<'w>( world: UnsafeWorldCell<'w>, _state: &Self::State, _last_run: Tick, _this_run: Tick, ) -> Self::Fetch<'w>

Creates a new instance of this fetch.

unsafe fn set_archetype<'w>( _fetch: &mut Self::Fetch<'w>, _state: &Self::State, _archetype: &'w Archetype, _table: &Table, )

Adjusts internal state to account for the next Archetype. This will always be called on archetypes that match this WorldQuery.

unsafe fn set_table<'w>( _fetch: &mut Self::Fetch<'w>, _state: &Self::State, _table: &'w Table, )

Adjusts internal state to account for the next Table. This will always be called on tables that match this WorldQuery.

unsafe fn fetch<'w>( fetch: &mut Self::Fetch<'w>, entity: Entity, _table_row: TableRow, ) -> Self::Item<'w>

Fetch Self::Item for either the given entity in the current Table, or for the given entity in the current Archetype. This must always be called after WorldQuery::set_table with a table_row in the range of the current Table or after WorldQuery::set_archetype with a entity in the current archetype.

fn update_component_access( _state: &Self::State, _access: &mut FilteredAccess<ComponentId>, )

Adds any component accesses used by this WorldQuery to access.

fn init_state(_world: &mut World)

Creates and initializes a State for this WorldQuery type.

fn get_state(_components: &Components) -> Option<()>

Attempts to initialize a State for this WorldQuery type using read-only access to Components.

fn matches_component_set( _state: &Self::State, _set_contains_id: &impl Fn(ComponentId) -> bool, ) -> bool

Returns true if this query matches a set of components. Otherwise, returns false.

fn set_access(_state: &mut Self::State, _access: &FilteredAccess<ComponentId>)

Sets available accesses for implementors with dynamic access such as FilteredEntityRef or FilteredEntityMut.

impl ReadOnlyQueryData for &Archetype

SAFETY: access is read only