Documentation

Unity Engine


Unity Engine


HasComponent<T>(Entity)

Checks whether an entity has a specific type of component.
Read time 1 minuteLast updated a day ago

Definition

  • Type: Method
  • Namespace: Unity.Entities
  • Assembly: UnityEngine.EntitiesModule
Warning
Deprecated. Use SystemAPI.HasComponent instead (RemovedAfter Entities 1.0)
protected bool HasComponent<T>(Entity entity) where T : unmanaged, IComponentData

Parameters

entity

The Entity object.

Returns

Type

Description

boolTrue, if the specified entity has the component.

Remarks

Always returns false for an entity that has been destroyed.
Use this method to check if another entity has a given type of component using its Entity object. For example, if you have a component that contains an Entity field, you can check whether the referenced entity has a specific type of component using this method. (Entities in the set always have required components, so you don’t need to check for them.)
When iterating over entities coming from a query, avoid using this method with the current entity in the set. It is generally faster to adjust your query to avoid optional components.
When you call this method on the main thread, it invokes EntityManager.HasComponent.
This lookup method results in a slower, indirect memory access. When possible, organize your data to minimize the need for indirect lookups.