pub struct ToolChild {
pub entity: Entity,
pub slot: &'static ToolCallSlot,
pub issued: Has<Issued>,
pub outcome: Option<&'static EffectOutcome>,
pub batch_held: Has<BatchHeld>,
}Expand description
What the batch’s systems read of a tool child of a turn: which call it is, whether it was issued, its outcome, whether the batch’s own hold is on it.
Fields§
§entity: EntityThe effect entity.
slot: &'static ToolCallSlotWhich call of the batch it is.
issued: Has<Issued>Whether the bus issued it.
outcome: Option<&'static EffectOutcome>The outcome, once landed.
batch_held: Has<BatchHeld>Whether the batch’s own hold is on it.
Trait Implementations§
impl ArchetypeQueryData for ToolChildwhere
for<'__a> Entity: ArchetypeQueryData,
for<'__a> &'static ToolCallSlot: ArchetypeQueryData,
for<'__a> Has<Issued>: ArchetypeQueryData,
for<'__a> Option<&'static EffectOutcome>: ArchetypeQueryData,
for<'__a> Has<BatchHeld>: ArchetypeQueryData,
impl IterQueryData for ToolChildwhere
for<'__a> Entity: IterQueryData,
for<'__a> &'static ToolCallSlot: IterQueryData,
for<'__a> Has<Issued>: IterQueryData,
for<'__a> Option<&'static EffectOutcome>: IterQueryData,
for<'__a> Has<BatchHeld>: IterQueryData,
Source§impl QueryData for ToolChild
impl QueryData for ToolChild
Source§unsafe fn fetch<'__w, '__s>(
_state: &'__s Self::State,
_fetch: &mut <Self as WorldQuery>::Fetch<'__w>,
_entity: Entity,
_table_row: TableRow,
) -> Option<Self::Item<'__w, '__s>>
unsafe fn fetch<'__w, '__s>( _state: &'__s Self::State, _fetch: &mut <Self as WorldQuery>::Fetch<'__w>, _entity: Entity, _table_row: TableRow, ) -> Option<Self::Item<'__w, '__s>>
SAFETY: we call fetch for each member that implements Fetch.
Source§const IS_READ_ONLY: bool = true
const IS_READ_ONLY: bool = true
True if this query is read-only and may not perform mutable access.
Source§const IS_ARCHETYPAL: bool
const IS_ARCHETYPAL: bool
Returns true if (and only if) this query data relies strictly on archetypes to limit which
entities are accessed by the Query. Read more
Source§type ReadOnly = ToolChild
type ReadOnly = ToolChild
The read-only variant of this
QueryData, which satisfies the ReadOnlyQueryData trait.Source§type Item<'__w, '__s> = ToolChildItem<'__w, '__s>
type Item<'__w, '__s> = ToolChildItem<'__w, '__s>
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, '__wshort, '__s>(
item: Self::Item<'__wlong, '__s>,
) -> Self::Item<'__wshort, '__s>
fn shrink<'__wlong: '__wshort, '__wshort, '__s>( item: Self::Item<'__wlong, '__s>, ) -> Self::Item<'__wshort, '__s>
This function manually implements subtyping for the query items.
Source§fn provide_extra_access(
state: &mut Self::State,
access: &mut Access,
available_access: &Access,
)
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 moreSource§fn iter_access(_state: &Self::State) -> impl Iterator<Item = EcsAccessType<'_>>
fn iter_access(_state: &Self::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.impl ReadOnlyQueryData for ToolChild
Source§impl ReleaseStateQueryData for ToolChildwhere
for<'__a> Entity: ReleaseStateQueryData,
for<'__a> &'static ToolCallSlot: ReleaseStateQueryData,
for<'__a> Has<Issued>: ReleaseStateQueryData,
for<'__a> Option<&'static EffectOutcome>: ReleaseStateQueryData,
for<'__a> Has<BatchHeld>: ReleaseStateQueryData,
impl ReleaseStateQueryData for ToolChildwhere
for<'__a> Entity: ReleaseStateQueryData,
for<'__a> &'static ToolCallSlot: ReleaseStateQueryData,
for<'__a> Has<Issued>: ReleaseStateQueryData,
for<'__a> Option<&'static EffectOutcome>: ReleaseStateQueryData,
for<'__a> Has<BatchHeld>: ReleaseStateQueryData,
Source§fn release_state<'__w>(_item: Self::Item<'__w, '_>) -> Self::Item<'__w, 'static>
fn release_state<'__w>(_item: Self::Item<'__w, '_>) -> Self::Item<'__w, 'static>
Releases the borrow from the query state by converting an item to have a
'static state lifetime.impl SingleEntityQueryData for ToolChildwhere
for<'__a> Entity: SingleEntityQueryData,
for<'__a> &'static ToolCallSlot: SingleEntityQueryData,
for<'__a> Has<Issued>: SingleEntityQueryData,
for<'__a> Option<&'static EffectOutcome>: SingleEntityQueryData,
for<'__a> Has<BatchHeld>: SingleEntityQueryData,
Source§impl WorldQuery for ToolChild
impl WorldQuery for ToolChild
Source§unsafe fn set_archetype<'__w, '__s>(
_fetch: &mut <Self as WorldQuery>::Fetch<'__w>,
_state: &'__s Self::State,
_archetype: &'__w Archetype,
_table: &'__w Table,
)
unsafe fn set_archetype<'__w, '__s>( _fetch: &mut <Self as WorldQuery>::Fetch<'__w>, _state: &'__s Self::State, _archetype: &'__w Archetype, _table: &'__w Table, )
SAFETY: we call set_archetype for each member that implements Fetch
Source§unsafe fn set_table<'__w, '__s>(
_fetch: &mut <Self as WorldQuery>::Fetch<'__w>,
_state: &'__s Self::State,
_table: &'__w Table,
)
unsafe fn set_table<'__w, '__s>( _fetch: &mut <Self as WorldQuery>::Fetch<'__w>, _state: &'__s Self::State, _table: &'__w Table, )
SAFETY: we call set_table for each member that implements Fetch
Source§const IS_DENSE: bool
const IS_DENSE: bool
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> = ToolChildFetch<'__w>
type Fetch<'__w> = ToolChildFetch<'__w>
Per archetype/table state retrieved by this
WorldQuery to compute Self::Item for each entity.Source§type State = ToolChildState
type State = ToolChildState
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, '__wshort>(
fetch: <ToolChild as WorldQuery>::Fetch<'__wlong>,
) -> <ToolChild as WorldQuery>::Fetch<'__wshort>
fn shrink_fetch<'__wlong: '__wshort, '__wshort>( fetch: <ToolChild as WorldQuery>::Fetch<'__wlong>, ) -> <ToolChild as WorldQuery>::Fetch<'__wshort>
This function manually implements subtyping for the query fetches.
Source§unsafe fn init_fetch<'__w, '__s>(
_world: UnsafeWorldCell<'__w>,
state: &'__s Self::State,
_last_run: Tick,
_this_run: Tick,
) -> <Self as WorldQuery>::Fetch<'__w>
unsafe fn init_fetch<'__w, '__s>( _world: UnsafeWorldCell<'__w>, state: &'__s Self::State, _last_run: Tick, _this_run: Tick, ) -> <Self 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 moreSource§fn update_component_access(state: &Self::State, _access: &mut FilteredAccess)
fn update_component_access(state: &Self::State, _access: &mut FilteredAccess)
Source§fn init_nested_access(
state: &Self::State,
_system_name: Option<&str>,
_component_access_set: &mut FilteredAccessSet,
_world: UnsafeWorldCell<'_>,
)
fn init_nested_access( state: &Self::State, _system_name: Option<&str>, _component_access_set: &mut FilteredAccessSet, _world: UnsafeWorldCell<'_>, )
Adds any component accesses to other entities used by this
WorldQuery. Read moreSource§fn init_state(world: &mut World) -> ToolChildState
fn init_state(world: &mut World) -> ToolChildState
Creates and initializes a
State for this WorldQuery type.Source§fn get_state(components: &Components) -> Option<ToolChildState>
fn get_state(components: &Components) -> Option<ToolChildState>
Source§fn matches_component_set(
state: &Self::State,
_set_contains_id: &impl Fn(ComponentId) -> bool,
) -> bool
fn matches_component_set( state: &Self::State, _set_contains_id: &impl Fn(ComponentId) -> bool, ) -> bool
Source§fn update_archetypes(_state: &mut Self::State, _world: UnsafeWorldCell<'_>)
fn update_archetypes(_state: &mut Self::State, _world: UnsafeWorldCell<'_>)
Called when the query state is updating its archetype cache.
This can be used by nested queries to update their internal archetype caches.
Auto Trait Implementations§
impl !RefUnwindSafe for ToolChild
impl !UnwindSafe for ToolChild
impl Freeze for ToolChild
impl Send for ToolChild
impl Sync for ToolChild
impl Unpin for ToolChild
impl UnsafeUnpin for ToolChild
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<T> ConditionalSend for Twhere
T: Send,
Source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
Source§fn into_any(self: Box<T>) -> Box<dyn Any>
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>
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)
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)
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> DowncastSend for T
impl<T> DowncastSend for T
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
Source§impl<T> IntoResult<T> for T
impl<T> IntoResult<T> for T
Source§fn into_result(self) -> Result<T, RunSystemError>
fn into_result(self) -> Result<T, RunSystemError>
Converts this type into the system output type.