Struct EntityIdIndex

pub struct EntityIdIndex { /* private fields */ }

An index of Minecraft entity IDs to Azalea ECS entities. This is a Component so local players can keep track of entity IDs independently from the instance.

If you need a per-instance instead of per-client version of this, you can use Instance::entity_by_id.

Implementations

impl EntityIdIndex

pub fn get_by_minecraft_entity(&self, id: MinecraftEntityId) -> Option<Entity>

pub fn get_by_ecs_entity(&self, entity: Entity) -> Option<MinecraftEntityId>

pub fn contains_minecraft_entity(&self, id: MinecraftEntityId) -> bool

pub fn contains_ecs_entity(&self, id: Entity) -> bool

pub fn insert(&mut self, id: MinecraftEntityId, entity: Entity)

pub fn remove_by_minecraft_entity( &mut self, id: MinecraftEntityId, ) -> Option<Entity>

pub fn remove_by_ecs_entity( &mut self, entity: Entity, ) -> Option<MinecraftEntityId>

Trait Implementations

impl Component for EntityIdIndex

where Self: 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]

impl Default for EntityIdIndex

fn default() -> EntityIdIndex

Returns the “default value” for a type.