Struct Worlds 

pub struct Worlds {
    pub map: FxHashMap<WorldName, Weak<RwLock<World>>>,
}

A container of World instances.

Worlds are stored as a Weak pointer here, so if no clients are using a world then it will be forgotten.

Fields

map: FxHashMap<WorldName, Weak<RwLock<World>>>

Implementations

impl Worlds

pub fn new() -> Self

pub fn get(&self, name: &WorldName) -> Option<Arc<RwLock<World>>>

Get a world instance from the container.

Returns None if none of the clients are in the requested world.

pub fn get_or_insert( &mut self, name: WorldName, height: u32, min_y: i32, default_registries: &RegistryHolder, ) -> Arc<RwLock<World>>

Add an empty world to the container (unless it already exists) and returns a strong reference to the world.

Trait Implementations

impl Component for Worlds

where Self: Send + Sync + 'static,

const STORAGE_TYPE: StorageType = bevy_ecs::component::StorageType::SparseSet

A constant indicating the storage type used for this component.

type Mutability = Mutable

A marker type to assist Bevy with determining if this component is mutable, or immutable. Mutable components will have [Component<Mutability = Mutable>], while immutable components will instead have [Component<Mutability = Immutable>].

fn register_required_components( _requiree: ComponentId, required_components: &mut RequiredComponentsRegistrator<'_, '_>, )

Registers required components.

fn clone_behavior() -> ComponentCloneBehavior

Called when registering this component, allowing to override clone function (or disable cloning altogether) for this component.

fn relationship_accessor() -> Option<ComponentRelationshipAccessor<Self>>

Returns [ComponentRelationshipAccessor] required for working with relationships in dynamic contexts.

fn on_add() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_add [ComponentHook] for this [Component] if one is defined.

fn on_insert() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_insert [ComponentHook] for this [Component] if one is defined.

fn on_discard() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_discard [ComponentHook] for this [Component] if one is defined.

fn on_remove() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_remove [ComponentHook] for this [Component] if one is defined.

fn on_despawn() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_despawn [ComponentHook] for this [Component] if one is defined.

fn map_entities<E>(_this: &mut Self, _mapper: &mut E)

where E: EntityMapper,

Maps the entities on this component using the given [EntityMapper]. This is used to remap entities in contexts like scenes and entity cloning. When deriving [Component], this is populated by annotating fields containing entities with #[entities]

impl Default for Worlds

fn default() -> Worlds

Returns the “default value” for a type.

impl Resource for Worlds

where Self: Send + Sync + 'static,