Method GetComponent
GetComponent<T>(Entity)
Look up the value of a component for an entity.
Declaration
public static T GetComponent<T>(Entity entity) where T : unmanaged, IComponentData
Parameters
Type | Name | Description |
---|---|---|
Entity | entity | The entity. |
Returns
Type | Description |
---|---|
T | A struct of type T containing the component value. |
Type Parameters
Name | Description |
---|---|
T | The type of component to retrieve. |
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 via IJob
When you call this method it gets replaced with component access methods through Component
This lookup method results in a slower, indirect memory access. When possible, organize your data to minimize the need for indirect lookups.
Exceptions
Type | Condition |
---|---|
Argument |
Thrown if the component type has no fields. |
GetComponent<T>(SystemHandle)
Gets the value of a component for an entity associated with a system.
Declaration
public static T GetComponent<T>(SystemHandle systemHandle) where T : unmanaged, IComponentData
Parameters
Type | Name | Description |
---|---|---|
System |
systemHandle | The system handle. |
Returns
Type | Description |
---|---|
T | A struct of type T containing the component value. |
Type Parameters
Name | Description |
---|---|
T | The type of component to retrieve. |
Remarks
Use this method to look up data in another system owned entity using its System
When you call this method it gets replaced with component access methods through Component
Exceptions
Type | Condition |
---|---|
Argument |
Thrown if the component type has no fields. |