Struct bevy_yoleck::prelude::YoleckEdit
source · pub struct YoleckEdit<'w, 's, Q: 'static + QueryData, F: 'static + QueryFilter = ()> { /* private fields */ }
Expand description
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§
source§impl<'w, 's, Q: 'static + QueryData, F: 'static + QueryFilter> YoleckEdit<'w, 's, Q, F>
impl<'w, 's, Q: 'static + QueryData, F: 'static + QueryFilter> YoleckEdit<'w, 's, Q, F>
pub fn get_single( &self ) -> Result<<<Q as QueryData>::ReadOnly as WorldQuery>::Item<'_>, QuerySingleError>
pub fn get_single_mut( &mut self ) -> Result<<Q as WorldQuery>::Item<'_>, QuerySingleError>
pub fn is_empty(&self) -> bool
sourcepub fn has_nonmatching(&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.
sourcepub fn iter_matching(
&mut self
) -> QueryIter<'_, '_, <Q as QueryData>::ReadOnly, (With<YoleckEditMarker>, F)>
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.
sourcepub fn iter_matching_mut(
&mut self
) -> QueryIter<'_, '_, Q, (With<YoleckEditMarker>, F)>
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§
source§impl<Q: 'static + QueryData, F: 'static + QueryFilter> SystemParam for YoleckEdit<'_, '_, Q, F>
impl<Q: 'static + QueryData, F: 'static + QueryFilter> SystemParam for YoleckEdit<'_, '_, Q, F>
§type Item<'w, 's> = YoleckEdit<'w, 's, Q, F>
type Item<'w, 's> = YoleckEdit<'w, 's, Q, F>
Self
, instantiated with new lifetimes. Read moresource§fn init_state(world: &mut World, system_meta: &mut SystemMeta) -> Self::State
fn init_state(world: &mut World, system_meta: &mut SystemMeta) -> Self::State
World
access used by this SystemParam
and creates a new instance of this param’s State
.source§unsafe fn new_archetype(
state: &mut Self::State,
archetype: &Archetype,
system_meta: &mut SystemMeta
)
unsafe fn new_archetype( state: &mut Self::State, archetype: &Archetype, system_meta: &mut SystemMeta )
Archetype
, registers the components accessed by this SystemParam
(if applicable).a Read moresource§fn apply(state: &mut Self::State, system_meta: &SystemMeta, world: &mut World)
fn apply(state: &mut Self::State, system_meta: &SystemMeta, world: &mut World)
SystemParam
’s state.
This is used to apply Commands
during apply_deferred
.source§fn queue(
state: &mut Self::State,
system_meta: &SystemMeta,
world: DeferredWorld<'_>
)
fn queue( state: &mut Self::State, system_meta: &SystemMeta, world: DeferredWorld<'_> )
apply_deferred
.source§unsafe fn get_param<'w, 's>(
state: &'s mut Self::State,
system_meta: &SystemMeta,
world: UnsafeWorldCell<'w>,
change_tick: Tick
) -> Self::Item<'w, 's>
unsafe fn get_param<'w, 's>( state: &'s mut Self::State, system_meta: &SystemMeta, world: UnsafeWorldCell<'w>, change_tick: Tick ) -> Self::Item<'w, 's>
SystemParamFunction
. Read moreimpl<'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,
Auto Trait Implementations§
impl<'w, 's, Q, F> Freeze for YoleckEdit<'w, 's, Q, F>
impl<'w, 's, Q, F = ()> !RefUnwindSafe for YoleckEdit<'w, 's, Q, F>
impl<'w, 's, Q, F> Send for YoleckEdit<'w, 's, Q, F>
impl<'w, 's, Q, F> Sync for YoleckEdit<'w, 's, Q, F>
impl<'w, 's, Q, F> Unpin for YoleckEdit<'w, 's, Q, F>
impl<'w, 's, Q, F = ()> !UnwindSafe for YoleckEdit<'w, 's, Q, F>
Blanket Implementations§
source§impl<T, U> AsBindGroupShaderType<U> for T
impl<T, U> AsBindGroupShaderType<U> for T
source§fn as_bind_group_shader_type(&self, _images: &RenderAssets<GpuImage>) -> U
fn as_bind_group_shader_type(&self, _images: &RenderAssets<GpuImage>) -> U
T
ShaderType
for self
. When used in AsBindGroup
derives, it is safe to assume that all images in self
exist.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
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>
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>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
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)
fn as_any(&self) -> &(dyn Any + 'static)
&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)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.