Documentation

Unity Engine


Unity Engine


GetComponent<T>(Entity)

Look up the value of a component for an entity.
Read time 1 minuteLast updated a day ago

Definition

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

Parameters

entity

The entity.

Returns

Type

Description

TA struct of type T containing the component value.

Remarks

Use this method to look up data in another entity using its Entity object. For example, if you have a component that contains an Entity field, you can look up the component data for the referenced entity using this method.
When iterating over entities coming from a query, do not use this method to access data of the current entity in the set. This function is much slower than accessing the data directly.
When you call this method on the main thread, it invokes EntityManager.GetComponentData.
This lookup method results in a slower, indirect memory access. When possible, organize your data to minimize the need for indirect lookups.