Struct LabelResolutionRegistry 

pub struct LabelResolutionRegistry { /* private fields */ }

Available on crate feature bevy_dev_tools only.

Stores the registered label-defining component types and their priorities.

When determining an entity’s label via resolve_label, components with higher priority values will take precedence over those with lower priority values.

Entities with an explicit Name component will always take precedence over label-defining components.

Priority Conventions

See the associated constants on LabelDefinitionPriority for recommended priority levels.

Usage

Components that should be “label-defining” should be registered in this registry using LabelResolutionRegistry::register_label_defining_type, typically in the plugin that defines the component.

Implementations

impl LabelResolutionRegistry

pub const fn new() -> LabelResolutionRegistry

Creates a new, empty LabelResolutionRegistry.

pub fn register_label_defining_type<T>( &mut self, priority: LabelDefinitionPriority, )

where T: 'static,

Registers a label-defining component type with the given priority.

Higher priority components will take precedence when determining an entity’s label.

pub fn get_priority<T>(&self) -> Option<LabelDefinitionPriority>

where T: 'static,

Gets the priority of a label-defining component type, if registered.

pub fn get_priority_by_type_id( &self, type_id: TypeId, ) -> Option<LabelDefinitionPriority>

Gets the priority of a label-defining component type by its TypeId, if registered.

pub fn unregister_label_defining_type<T>(&mut self)

where T: 'static,

Removes a label-defining component type from the registry.

pub fn unregister_label_defining_type_by_type_id(&mut self, type_id: TypeId)

Removes a label-defining component type from the registry by its TypeId.

Trait Implementations

impl Component for LabelResolutionRegistry

where LabelResolutionRegistry: 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<LabelResolutionRegistry>>

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]

const HAS_SUMMARY_TICK: bool = false

Set this constant to true if the component should track a summary tick.

impl Debug for LabelResolutionRegistry

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

Formats the value using the given formatter.

impl Default for LabelResolutionRegistry

fn default() -> LabelResolutionRegistry

Returns the “default value” for a type.

impl Resource for LabelResolutionRegistry

where LabelResolutionRegistry: Send + Sync + 'static,