Struct WorldHolder 

pub struct WorldHolder {
    pub partial: Arc<RwLock<RawRwLock, PartialWorld>>,
    pub shared: Arc<RwLock<RawRwLock, World>>,
}

A component that keeps strong references to our PartialWorld and World for local players.

This can also act as a convenient way to access the player’s World, since the alternative is to look up the player’s WorldName in the Worlds resource.

Fields

partial: Arc<RwLock<RawRwLock, PartialWorld>>

The slice of the world that this client actually has loaded, based on its render distance.

shared: Arc<RwLock<RawRwLock, World>>

The combined PartialWorlds of all clients in the same world.

The distinction between this and partial is mostly only relevant if you’re using a shared world (i.e. a swarm). If in doubt, prefer to use the shared world.

Implementations

impl WorldHolder

pub fn new(entity: Entity, shared: Arc<RwLock<RawRwLock, World>>) -> WorldHolder

Create a new WorldHolder for the given entity.

The partial world will be created for you. The render distance will be set to a default value, which you can change by creating a new partial world.

pub fn reset(&mut self)

Reset the World to be a reference to an empty world, but with the same registries as the current one.

This is used by Azalea when entering the config state.

Trait Implementations

impl Clone for WorldHolder

fn clone(&self) -> WorldHolder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Component for WorldHolder

where WorldHolder: Send + Sync + 'static,

const STORAGE_TYPE: StorageType = bevy_ecs::component::StorageType::Table

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<WorldHolder>>

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_replace() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_replace [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]