Struct InstanceHolder

pub struct InstanceHolder {
    pub partial_instance: Arc<RwLock<RawRwLock, PartialInstance>>,
    pub instance: Arc<RwLock<RawRwLock, Instance>>,
}

A component that keeps strong references to our PartialInstance and Instance for local players.

This can also act as a convenience for accessing the player’s Instance since the alternative is to look up the player’s InstanceName in the InstanceContainer.

Fields

partial_instance: Arc<RwLock<RawRwLock, PartialInstance>>

The partial instance is the world this client currently has loaded. It has a limited render distance.

instance: Arc<RwLock<RawRwLock, Instance>>

The world is the combined PartialInstances of all clients in the same world.

This is only relevant if you’re using a shared world (i.e. a swarm).

Implementations

impl InstanceHolder

pub fn new( entity: Entity, instance: Arc<RwLock<RawRwLock, Instance>>, ) -> InstanceHolder

Create a new InstanceHolder for the given entity.

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

pub fn reset(&mut self)

Reset the Instance to a new reference to an empty instance, but with the same registries as the current one.

This is used by Azalea when entering the config state.

Trait Implementations

impl Clone for InstanceHolder

fn clone(&self) -> InstanceHolder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Component for InstanceHolder

where InstanceHolder: 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, components: &mut ComponentsRegistrator<'_>, required_components: &mut RequiredComponents, inheritance_depth: u16, recursion_check_stack: &mut Vec<ComponentId>, )

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 register_component_hooks(hooks: &mut ComponentHooks)

👎Deprecated since 0.16.0: Use the individual hook methods instead (e.g., Component::on_add, etc.)

Called when registering this component, allowing mutable access to its [ComponentHooks].

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]