Archetype

Struct Archetype 

Source
pub struct Archetype { /* private fields */ }
Expand description

Metadata for a single archetype within a World.

For more information, see the module level documentation.

Implementations§

Source§

impl Archetype

Source

pub fn id(&self) -> ArchetypeId

Fetches the ID for the archetype.

Source

pub fn table_id(&self) -> TableId

Fetches the archetype’s Table ID.

Source

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

Fetches the entities contained in this archetype.

Source

pub fn entities_with_location( &self, ) -> impl Iterator<Item = (Entity, EntityLocation)>

Fetches the entities contained in this archetype.

Source

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.

Source

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.

Source

pub fn components(&self) -> &[ComponentId]

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

All of the IDs are unique.

Source

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.

Source

pub fn component_count(&self) -> usize

Returns the total number of components in the archetype

Source

pub fn edges(&self) -> &Edges

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

Source

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().

Source

pub fn len(&self) -> u32

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

Source

pub fn is_empty(&self) -> bool

Checks if the archetype has any entities.

Source

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

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

Source

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.

Source

pub fn has_add_hook(&self) -> bool

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

Source

pub fn has_insert_hook(&self) -> bool

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

Source

pub fn has_replace_hook(&self) -> bool

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

Source

pub fn has_remove_hook(&self) -> bool

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

Source

pub fn has_despawn_hook(&self) -> bool

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

Source

pub fn has_add_observer(&self) -> bool

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

Source

pub fn has_insert_observer(&self) -> bool

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

Source

pub fn has_replace_observer(&self) -> bool

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

Source

pub fn has_remove_observer(&self) -> bool

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

Source

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§

Source§

impl QueryData for &Archetype

SAFETY: Self is the same as Self::ReadOnly

Source§

const IS_READ_ONLY: bool = true

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

type ReadOnly = &Archetype

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

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.
Source§

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.
Source§

unsafe fn fetch<'w, 's>( _state: &'s <&Archetype as WorldQuery>::State, fetch: &mut <&Archetype as WorldQuery>::Fetch<'w>, entity: Entity, _table_row: TableRow, ) -> <&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. Read more
Source§

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. Read more
Source§

impl ReleaseStateQueryData for &Archetype

Source§

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.
Source§

impl WorldQuery for &Archetype

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

Source§

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. Read more
Source§

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

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

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.
Source§

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.
Source§

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. Read more
Source§

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. Read more
Source§

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. Read more
Source§

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

Adds any component accesses used by this WorldQuery to access. Read more
Source§

fn init_state(_world: &mut World)

Creates and initializes a State for this WorldQuery type.
Source§

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

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

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. Read more
Source§

impl ReadOnlyQueryData for &Archetype

SAFETY: access is read only

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T, U> AsBindGroupShaderType<U> for T
where U: ShaderType, &'a T: for<'a> Into<U>,

Source§

fn as_bind_group_shader_type(&self, _images: &RenderAssets<GpuImage>) -> U

Return the T ShaderType for self. When used in AsBindGroup derives, it is safe to assume that all images in self exist.
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Converts Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>, which can then be downcast into Box<dyn ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Converts Rc<Trait> (where Trait: Downcast) to Rc<Any>, which can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Converts &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Converts &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, W> HasTypeWitness<W> for T
where W: MakeTypeWitness<Arg = T>, T: ?Sized,

Source§

const WITNESS: W = W::MAKE

A constant of the type witness
Source§

impl<T> Identity for T
where T: ?Sized,

Source§

const TYPE_EQ: TypeEq<T, <T as Identity>::Type> = TypeEq::NEW

Proof that Self is the same type as Self::Type, provides methods for casting between Self and Self::Type.
Source§

type Type = T

The same type as Self, used to emulate type equality bounds (T == U) with associated type equality constraints (T: Identity<Type = U>).
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> IntoResult<T> for T

Source§

fn into_result(self) -> Result<T, RunSystemError>

Converts this type into the system output type.
Source§

impl<A> Is for A
where A: Any,

Source§

fn is<T>() -> bool
where T: Any,

Checks if the current type “is” another type, using a TypeId equality comparison. This is most useful in the context of generic logic. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more