Method SetComponent
SetComponent<T>(Entity, T)
Sets the value of a component of an entity.
Declaration
public static void SetComponent<T>(Entity entity, T component) where T : unmanaged, IComponentData
Parameters
Type | Name | Description |
---|---|---|
Entity | entity | The entity. |
T | component | The data to set. |
Type Parameters
Name | Description |
---|---|
T | The component type. |
Remarks
Use this method to look up and set data in another entity using its Entity object. For example, if you have a component that contains an Entity field, you can update 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 gets replaced with component access methods through Component
In both cases, 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. |
SetComponent<T>(SystemHandle, T)
Sets the value of a component of an entity associated with a system.
Declaration
public static void SetComponent<T>(SystemHandle systemHandle, T component) where T : unmanaged, IComponentData
Parameters
Type | Name | Description |
---|---|---|
System |
systemHandle | The system handle. |
T | component | The data to set. |
Type Parameters
Name | Description |
---|---|
T | The component type. |
Remarks
Use this method to look up and set data in another system owned entity using its System
When you call this method gets replaced with component access methods through Component
Exceptions
Type | Condition |
---|---|
Argument |
Thrown if the component type has no fields. |