Struct HandleEntityRemap 

pub struct HandleEntityRemap { /* private fields */ }

An EntityMapper a Resource = Entity HandleKind’s resolve can consult (world.resource::<HandleEntityRemap>()) and populate (set_mapped) when reconstructing scene-based entities whose cross-references named another handle-entity by its old session’s Entity id. Reset at the start of every load_handles call.

BTreeMap for deterministic iteration if a consumer ever walks it.

Implementations

impl HandleEntityRemap

pub fn clear(&mut self)

Trait Implementations

impl Component for HandleEntityRemap

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 Debug for HandleEntityRemap

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

Formats the value using the given formatter.

impl Default for HandleEntityRemap

fn default() -> HandleEntityRemap

Returns the “default value” for a type.

impl EntityMapper for HandleEntityRemap

fn get_mapped(&mut self, source: Entity) -> Entity

Returns the “target” entity that maps to the given source.

fn set_mapped(&mut self, source: Entity, target: Entity)

Maps the target entity to the given source. For some implementations this might not actually determine the result of EntityMapper::get_mapped.

impl Resource for HandleEntityRemap

where Self: Send + Sync + 'static,