GetComponent
Look up the value of a component for an entity.
Read time 1 minuteLast updated 4 days ago
Definition
- Type: Method
- Namespace: Unity.Entities
- Assembly: UnityEngine.EntitiesModule
GetComponent<T>(Entity)
Look up the value of a component for an entity.
public static T GetComponent<T>(Entity entity) where T : unmanaged, IComponentData
Parameters
The entity.
Returns
Type | Description |
|---|---|
| T | A 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 a set of entities with an idomatic foreach query, don't use this method to access the data of the current entity in the set. It's faster to access the data by requesting it as an argument of a query.
When you call this method it gets replaced with component access methods through ComponentLookup<T>.
This lookup method results in a slower, indirect memory access. When possible, organize your data to minimize the need for indirect lookups.
Not working in IJobEntity, and Utility methods
GetComponent<T>(SystemHandle)
Gets the value of a component for an entity associated with a system.
public static T GetComponent<T>(SystemHandle systemHandle) where T : unmanaged, IComponentData
Parameters
The system handle.
Returns
Type | Description |
|---|---|
| T | A struct of type T containing the component value. |
Remarks
Use this method to look up data in another system owned entity using its SystemHandle object.
When you call this method it gets replaced with component access methods through ComponentLookup<T>.
Not working in IJobEntity, and Utility methods