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 entities_with_location( &self, ) -> impl Iterator<Item = (Entity, EntityLocation)>

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) -> &[ComponentId]

Returns a slice of all of the components in the archetype.

All of the IDs are unique.

pub fn iter_components(&self) -> impl Iterator<Item = ComponentId> + Clone

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 an 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) -> u32

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 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_replace_hook(&self) -> bool

Returns true if any of the components in this archetype have on_replace 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_despawn_hook(&self) -> bool

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

pub fn has_add_observer(&self) -> bool

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

pub fn has_insert_observer(&self) -> bool

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

pub fn has_replace_observer(&self) -> bool

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

pub fn has_remove_observer(&self) -> bool

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

pub fn has_despawn_observer(&self) -> bool

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

Trait Implementations

impl QueryData for &Archetype

SAFETY: Self is the same as Self::ReadOnly

const IS_READ_ONLY: bool = true

True if this query is read-only and may not perform mutable access.

const IS_ARCHETYPAL: bool = true

Returns true if (and only if) this query data relies strictly on archetypes to limit which entities are accessed by the Query.

type ReadOnly = &Archetype

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

type Item<'w, 's> = &'w Archetype

The item returned by this WorldQuery This will be the data retrieved by the query, and is visible to the end user when calling e.g. Query<Self>::get.

fn shrink<'wlong, 'wshort, 's>( item: <&Archetype as QueryData>::Item<'wlong, 's>, ) -> <&Archetype as QueryData>::Item<'wshort, 's>

where 'wlong: 'wshort,

This function manually implements subtyping for the query items.

unsafe fn fetch<'w, 's>( _state: &'s <&Archetype as WorldQuery>::State, fetch: &mut <&Archetype as WorldQuery>::Fetch<'w>, entity: Entity, _table_row: TableRow, ) -> Option<<&Archetype as QueryData>::Item<'w, 's>>

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 an entity in the current archetype. Accesses components registered in WorldQuery::update_component_access.

fn iter_access( _state: &<&Archetype as WorldQuery>::State, ) -> impl Iterator<Item = EcsAccessType<'_>>

Returns an iterator over the access needed by QueryData::fetch. Access conflicts are usually checked in WorldQuery::update_component_access, but in certain cases this method can be useful to implement a way of checking for access conflicts in a non-allocating way.

fn provide_extra_access( _state: &mut Self::State, _access: &mut Access, _available_access: &Access, )

Offers additional access above what we requested in update_component_access. Implementations may add additional access that is a subset of available_access and does not conflict with anything in access, and must update access to include that access.

impl ReleaseStateQueryData for &Archetype

fn release_state<'w>( item: <&Archetype as QueryData>::Item<'w, '_>, ) -> <&Archetype as QueryData>::Item<'w, 'static>

Releases the borrow from the query state by converting an item to have a 'static state lifetime.

impl WorldQuery for &Archetype

SAFETY: update_component_access does 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.

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

Per archetype/table state retrieved by this WorldQuery to compute Self::Item for each entity.

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_fetch<'wlong, 'wshort>( fetch: <&Archetype as WorldQuery>::Fetch<'wlong>, ) -> <&Archetype as WorldQuery>::Fetch<'wshort>

where 'wlong: 'wshort,

This function manually implements subtyping for the query fetches.

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

Creates a new instance of Self::Fetch, by combining data from the World with the cached Self::State. Readonly accesses resources registered in WorldQuery::update_component_access.

unsafe fn set_archetype<'w, 's>( _fetch: &mut <&Archetype as WorldQuery>::Fetch<'w>, _state: &'s <&Archetype as WorldQuery>::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, 's>( _fetch: &mut <&Archetype as WorldQuery>::Fetch<'w>, _state: &'s <&Archetype as WorldQuery>::State, _table: &'w Table, )

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

fn update_component_access( _state: &<&Archetype as WorldQuery>::State, _access: &mut FilteredAccess, )

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: &<&Archetype as WorldQuery>::State, _set_contains_id: &impl Fn(ComponentId) -> bool, ) -> bool

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

impl ArchetypeQueryData for &Archetype

impl ReadOnlyQueryData for &Archetype

SAFETY: access is read only