pub struct WorldId(/* private fields */);
Expand description
A unique identifier for a World
.
The trait FromWorld
is implemented for this type, which returns the
ID of the world passed to FromWorld::from_world
.
Implementations§
Trait Implementations§
source§impl ExclusiveSystemParam for WorldId
impl ExclusiveSystemParam for WorldId
§type Item<'s> = WorldId
type Item<'s> = WorldId
The item type returned when constructing this system param.
See
SystemParam::Item
.source§fn init(world: &mut World, _system_meta: &mut SystemMeta) -> Self::State
fn init(world: &mut World, _system_meta: &mut SystemMeta) -> Self::State
Creates a new instance of this param’s
State
.source§fn get_param<'s>(
state: &'s mut Self::State,
_system_meta: &SystemMeta
) -> Self::Item<'s>
fn get_param<'s>( state: &'s mut Self::State, _system_meta: &SystemMeta ) -> Self::Item<'s>
Creates a parameter to be passed into an
ExclusiveSystemParamFunction
.source§impl FromWorld for WorldId
impl FromWorld for WorldId
source§fn from_world(world: &mut World) -> Self
fn from_world(world: &mut World) -> Self
Creates
Self
using data from the given World
.source§impl PartialEq for WorldId
impl PartialEq for WorldId
source§impl SparseSetIndex for WorldId
impl SparseSetIndex for WorldId
source§fn sparse_set_index(&self) -> usize
fn sparse_set_index(&self) -> usize
Gets the sparse set index corresponding to this instance.
source§fn get_sparse_set_index(value: usize) -> Self
fn get_sparse_set_index(value: usize) -> Self
Creates a new instance of this type with the specified index.
source§impl SystemParam for WorldId
impl SystemParam for WorldId
§type Item<'world, 'state> = WorldId
type Item<'world, 'state> = WorldId
The item type returned when constructing this system param.
The value of this associated type should be
Self
, instantiated with new lifetimes. Read moresource§fn init_state(_: &mut World, _: &mut SystemMeta) -> Self::State
fn init_state(_: &mut World, _: &mut SystemMeta) -> Self::State
Registers any
World
access used by this SystemParam
and creates a new instance of this param’s State
.source§unsafe fn get_param<'world, 'state>(
_: &'state mut Self::State,
_: &SystemMeta,
world: UnsafeWorldCell<'world>,
_: Tick
) -> Self::Item<'world, 'state>
unsafe fn get_param<'world, 'state>( _: &'state mut Self::State, _: &SystemMeta, world: UnsafeWorldCell<'world>, _: Tick ) -> Self::Item<'world, 'state>
Creates a parameter to be passed into a
SystemParamFunction
. Read moresource§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 )
For the specified
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)
Applies any deferred mutations stored in this
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<'_> )
Queues any deferred mutations to be applied at the next
apply_deferred
.impl Copy for WorldId
impl Eq for WorldId
impl ReadOnlySystemParam for WorldId
impl StructuralPartialEq for WorldId
Auto Trait Implementations§
impl Freeze for WorldId
impl RefUnwindSafe for WorldId
impl Send for WorldId
impl Sync for WorldId
impl Unpin for WorldId
impl UnwindSafe for WorldId
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
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>
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>
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)
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)
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> DowncastSync for T
impl<T> DowncastSync for T
source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
Compare self to
key
and return true
if they are equal.