Struct YoleckEdit

pub struct YoleckEdit<'w, 's, Q: 'static + QueryData, F: 'static + QueryFilter = ()> { /* private fields */ }

Wrapper for writing queries in edit systems.

To future-proof for the multi-entity editing feature, use this instead of regular queries with With<YoleckEditMarker>.

The methods of YoleckEdit that have the same name as methods of a regular Bevy Query delegate to them, but if there are edited entities that do not fit the query they will act as if they found no match.

Implementations

impl<Q: 'static + QueryData, F: 'static + QueryFilter> YoleckEdit<'_, '_, Q, F>

pub fn single( &self, ) -> Result<<<Q as QueryData>::ReadOnly as QueryData>::Item<'_>, QuerySingleError>

pub fn single_mut( &mut self, ) -> Result<<Q as QueryData>::Item<'_>, QuerySingleError>

pub fn is_empty(&self) -> bool

pub fn has_nonmatching(&self) -> bool

Check if some non-matching entities are selected for editing.

Use this, together with is_empty for systems that can edit multiple entities but want to not show their UI when some irrelevant entities are selected as well.

pub fn iter_matching( &mut self, ) -> QueryIter<'_, '_, <Q as QueryData>::ReadOnly, (With<YoleckEditMarker>, F)>

Iterate over all the matching entities, even if some selected entities do not match.

If both matching and non-matching entities are selected, this will iterate over the matching entities only. If it is not desired to iterate at all in such cases, check has_nonmatching must be checked manually.

pub fn iter_matching_mut( &mut self, ) -> QueryIter<'_, '_, Q, (With<YoleckEditMarker>, F)>

Iterate mutably over all the matching entities, even if some selected entities do not match.

If both matching and non-matching entities are selected, this will iterate over the matching entities only. If it is not desired to iterate at all in such cases, check has_nonmatching must be checked manually.

Trait Implementations

impl<Q: 'static + QueryData, F: 'static + QueryFilter> SystemParam for YoleckEdit<'_, '_, Q, F>

type State = FetchState<Q, F>

Used to store data which persists across invocations of a system.

type Item<'w, 's> = YoleckEdit<'w, 's, Q, F>

The item type returned when constructing this system param. The value of this associated type should be Self, instantiated with new lifetimes.

fn init_state(world: &mut World, system_meta: &mut SystemMeta) -> Self::State

Registers any [World] access used by this [SystemParam] and creates a new instance of this param’s State.

unsafe fn new_archetype( state: &mut Self::State, archetype: &Archetype, system_meta: &mut SystemMeta, )

For the specified [Archetype], registers the components accessed by this [SystemParam] (if applicable).a

fn apply(state: &mut Self::State, system_meta: &SystemMeta, world: &mut World)

Applies any deferred mutations stored in this [SystemParam]’s state. This is used to apply Commands during ApplyDeferred.

fn queue( state: &mut Self::State, system_meta: &SystemMeta, world: DeferredWorld<'_>, )

Queues any deferred mutations to be applied at the next ApplyDeferred.

unsafe fn validate_param<'w, 's>( state: &'s Self::State, _system_meta: &SystemMeta, _world: UnsafeWorldCell<'w>, ) -> Result<(), SystemParamValidationError>

Validates that the param can be acquired by the get_param.

unsafe fn get_param<'w, 's>( state: &'s mut Self::State, system_meta: &SystemMeta, world: UnsafeWorldCell<'w>, change_tick: Tick, ) -> Self::Item<'w, 's>

Creates a parameter to be passed into a SystemParamFunction.

impl<'w, 's, Q: 'static + QueryData, F: 'static + QueryFilter> ReadOnlySystemParam for YoleckEdit<'w, 's, Q, F>

where Query<'w, 's, Q, (With<YoleckEditMarker>, F)>: ReadOnlySystemParam, Query<'w, 's, (), With<YoleckEditMarker>>: ReadOnlySystemParam,