Struct NodeHandles 

pub struct NodeHandles { /* private fields */ }

Side-table mapping small i32 ids to node handles, for script hosts whose value type cannot hold a 64-bit handle (candela’s Value is internally i32). intern is idempotent per entity, so a handle keeps the same id across a tick; the sentinel id 0 means “no node”.

Registered as a Resource for embedders that want a world-scoped table; the runtime also drives a process-global instance (see intern_node / resolve_node) so a Send + Sync host with no &World at call time can still mint ids.

Implementations

impl NodeHandles

pub fn intern(&mut self, entity: Entity, generation: u32) -> i32

Intern (entity, generation), returning a stable i32 id (>= 1). Re-interning the same entity returns the same id.

pub fn intern_raw(&mut self, packed: u64) -> i32

Intern any packed handle (a real element’s NodeHandle::pack or a reserved spawn token), returning a stable i32 id. Idempotent per packed value.

pub fn resolve(&self, id: i32) -> Option<NodeHandle>

Resolve an interned id back to a live-element handle. Returns None for 0, an unknown id, or a reserved spawn token (which has no entity until command-drain materializes it).

pub fn resolve_raw(&self, id: i32) -> Option<u64>

Resolve an interned id to its packed bits (real handle or reserved spawn token). 0 / unknown yields None.

Trait Implementations

impl Component for NodeHandles

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 NodeHandles

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

Formats the value using the given formatter.

impl Default for NodeHandles

fn default() -> NodeHandles

Returns the “default value” for a type.

impl Resource for NodeHandles

where Self: Send + Sync + 'static,