Struct WorldId

pub struct WorldId(/* private fields */);

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

impl WorldId

pub fn new() -> Option<Self>

Create a new, unique WorldId. Returns None if the supply of unique WorldIds has been exhausted

Please note that the WorldIds created from this method are unique across time - if a given WorldId is Dropped its value still cannot be reused

Trait Implementations

impl Clone for WorldId

fn clone(&self) -> WorldId

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for WorldId

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl ExclusiveSystemParam for WorldId

type State = WorldId

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

type Item<'s> = WorldId

The item type returned when constructing this system param. See SystemParam::Item.

fn init(world: &mut World, _system_meta: &mut SystemMeta) -> Self::State

Creates a new instance of this param’s State.

fn get_param<'s>( state: &'s mut Self::State, _system_meta: &SystemMeta, ) -> Self::Item<'s>

Creates a parameter to be passed into an ExclusiveSystemParamFunction.

impl FromWorld for WorldId

fn from_world(world: &mut World) -> Self

Creates Self using data from the given World.

impl Hash for WorldId

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for WorldId

fn eq(&self, other: &WorldId) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl SparseSetIndex for WorldId

fn sparse_set_index(&self) -> usize

Gets the sparse set index corresponding to this instance.

fn get_sparse_set_index(value: usize) -> Self

Creates a new instance of this type with the specified index.

impl SystemParam for WorldId

type State = ()

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

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.

fn init_state(_: &mut World) -> Self::State

Creates a new instance of this param’s State.

fn init_access( _state: &Self::State, _system_meta: &mut SystemMeta, _component_access_set: &mut FilteredAccessSet, _world: &mut World, )

Registers any World access used by this SystemParam

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.

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( state: &mut Self::State, system_meta: &SystemMeta, world: UnsafeWorldCell<'_>, ) -> Result<(), SystemParamValidationError>

Validates that the param can be acquired by the get_param.

impl Copy for WorldId

impl Eq for WorldId

impl ReadOnlySystemParam for WorldId

impl StructuralPartialEq for WorldId