Method AddComponent
AddComponent(Entity, ComponentType)
Adds a component to an entity.
Declaration
public bool AddComponent(Entity entity, ComponentType componentType)Parameters
| Type | Name | Description |
|---|---|---|
| Entity | entity | The Entity. |
| ComponentType | componentType | The type of component to add. |
Returns
| Type | Description |
|---|---|
| Boolean | If the component was successfully added to the entity. |
Remarks
Can add any kind of component except chunk components. For chunk components, use AddChunkComponentData<T>(Entity).
Adding a component changes the entity's archetype and results in the entity being moved to a different chunk.
The added component has the default values for the type.
If the Entity object refers to an entity that already has the specified ComponentType, the function returns false without performing any modifications.
Important: This method creates a sync point, which means that the EntityManager waits for all currently running jobs to complete before adding the component. No additional jobs can start before the method is finished. A sync point can cause a drop in performance because the ECS framework might not be able to use the processing power of all available cores.
Exceptions
| Type | Condition |
|---|---|
| ArgumentException | The Entity does not exist. |
AddComponent(SystemHandle, ComponentType)
Adds a component to an entity associated with a system.
Declaration
public bool AddComponent(SystemHandle system, ComponentType componentType)Parameters
| Type | Name | Description |
|---|---|---|
| SystemHandle | system | The system handle. |
| ComponentType | componentType | The type of component to add. |
Returns
| Type | Description |
|---|---|
| Boolean | If the component was successfully added to the entity. |
Remarks
Can add any kind of component except chunk components. For chunk components, use AddChunkComponentData<T>(Entity).
Adding a component changes the entity's archetype and results in the entity being moved to a different chunk.
The added component has the default values for the type.
If the Entity object refers to an entity that already has the specified ComponentType, the function returns false without performing any modifications.
Important: This method creates a sync point, which means that the EntityManager waits for all currently running jobs to complete before adding the component. No additional jobs can start before the method is finished. A sync point can cause a drop in performance because the ECS framework might not be able to use the processing power of all available cores.
Exceptions
| Type | Condition |
|---|---|
| ArgumentException | The Entity does not exist. |
AddComponent<T>(Entity)
Adds a component to an entity.
Declaration
[GenerateTestsForBurstCompatibility(GenericTypeArguments = new Type[]{typeof(BurstCompatibleComponentData)})]
public bool AddComponent<T>(Entity entity)Parameters
| Type | Name | Description |
|---|---|---|
| Entity | entity | The Entity. |
Returns
| Type | Description |
|---|---|
| Boolean | If the component was successfully added to the entity. |
Type Parameters
| Name | Description |
|---|---|
| T | The type of component to add. |
Remarks
Can add any kind of component except chunk components. For chunk components, use AddChunkComponentData<T>(Entity).
Adding a component changes the entity's archetype and results in the entity being moved to a different chunk.
The added component has the default values for the type.
If the Entity object refers to an entity that already has the specified ComponentType, the function returns false without performing any modifications.
Important: This method creates a sync point, which means that the EntityManager waits for all currently running jobs to complete before addting the component. No additional jobs can start before the method is finished. A sync point can cause a drop in performance because the ECS framework might not be able to use the processing power of all available cores.
Exceptions
| Type | Condition |
|---|---|
| ArgumentException | The Entity does not exist. |
AddComponent<T>(SystemHandle)
Adds a component to an entity associated with a system.
Declaration
[GenerateTestsForBurstCompatibility(GenericTypeArguments = new Type[]{typeof(BurstCompatibleComponentData)})]
public bool AddComponent<T>(SystemHandle system)Parameters
| Type | Name | Description |
|---|---|---|
| SystemHandle | system | The system handle. |
Returns
| Type | Description |
|---|---|
| Boolean | If the component was successfully added to the entity. |
Type Parameters
| Name | Description |
|---|---|
| T | The type of component to add. |
Remarks
Can add any kind of component except chunk components. For chunk components, use AddChunkComponentData<T>(Entity).
Adding a component changes the entity's archetype and results in the entity being moved to a different chunk.
The added component has the default values for the type.
If the Entity object refers to an entity that already has the specified ComponentType, the function returns false without performing any modifications.
Important: This method creates a sync point, which means that the EntityManager waits for all currently running jobs to complete before addting the component. No additional jobs can start before the method is finished. A sync point can cause a drop in performance because the ECS framework might not be able to use the processing power of all available cores.
Exceptions
| Type | Condition |
|---|---|
| ArgumentException | The Entity does not exist. |
AddComponent(EntityQuery, ComponentType)
Adds a component to a set of entities defined by a EntityQuery.
Declaration
public void AddComponent(EntityQuery entityQuery, ComponentType componentType)Parameters
| Type | Name | Description |
|---|---|---|
| EntityQuery | entityQuery | The EntityQuery defining the entities to modify. |
| ComponentType | componentType | The type of component to add. |
Remarks
Can add any kind of component.
Adding a component changes an entity's archetype and results in the entity being moved to a different chunk.
The added components have the default values for the type.
Important: This method creates a sync point, which means that the EntityManager waits for all currently running jobs to complete before addting the component. No additional jobs can start before the method is finished. A sync point can cause a drop in performance because the ECS framework might not be able to use the processing power of all available cores.
AddComponent(EntityQuery, in ComponentTypeSet)
Adds components to a set of entities defined by a EntityQuery.
Declaration
public void AddComponent(EntityQuery entityQuery, in ComponentTypeSet componentTypeSet)Parameters
| Type | Name | Description |
|---|---|---|
| EntityQuery | entityQuery | The EntityQuery defining the entities to modify. |
| ComponentTypeSet | componentTypeSet | The type of components to add. |
Remarks
You can use this method to add a component to an Entity.
The added components have the default values for the type.
Important: This method creates a sync point, which means that the EntityManager waits for all currently running jobs to complete before addting the component. No additional jobs can start before the method is finished. A sync point can cause a drop in performance because the ECS framework might not be able to use the processing power of all available cores.
AddComponent<T>(EntityQuery)
Adds a component to a set of entities defined by a EntityQuery.
Declaration
[GenerateTestsForBurstCompatibility(GenericTypeArguments = new Type[]{typeof(BurstCompatibleComponentData)})]
public void AddComponent<T>(EntityQuery entityQuery)Parameters
| Type | Name | Description |
|---|---|---|
| EntityQuery | entityQuery | The EntityQuery defining the entities to modify. |
Type Parameters
| Name | Description |
|---|---|
| T | The type of component to add. |
Remarks
Can add any kind of component except chunk components.
Adding a component changes an entity's archetype and results in the entity being moved to a different chunk.
The added components have the default values for the type.
Important: This method creates a sync point, which means that the EntityManager waits for all currently running jobs to complete before adding the component. No additional jobs can start before the method is finished. A sync point can cause a drop in performance because the ECS framework might not be able to use the processing power of all available cores.
AddComponent(NativeArray<Entity>, ComponentType)
Adds a component to a set of entities.
Declaration
public void AddComponent(NativeArray<Entity> entities, ComponentType componentType)Parameters
| Type | Name | Description |
|---|---|---|
| NativeArray<Entity> | entities | An array of Entity objects. |
| ComponentType | componentType | The type of component to add. |
Remarks
Can add any kind of component except chunk components.
Adding a component changes an entity's archetype and results in the entity being moved to a different chunk.
The added components have the default values for the type.
Important: This method creates a sync point, which means that the EntityManager waits for all currently running jobs to complete before creating the chunk. No additional jobs can start before the method is finished. A sync point can cause a drop in performance because the ECS framework might not be able to use the processing power of all available cores.
Exceptions
| Type | Condition |
|---|---|
| ArgumentException | The |
AddComponent(NativeArray<Entity>, in ComponentTypeSet)
Adds components to a specified collection of entities.
Declaration
public void AddComponent(NativeArray<Entity> entities, in ComponentTypeSet componentTypeSet)Parameters
| Type | Name | Description |
|---|---|---|
| NativeArray<Entity> | entities | The collection of entities to modify. |
| ComponentTypeSet | componentTypeSet | The type of components to add. |
Remarks
You can use this method to add a component to an Entity.
The added components have the default values for the type.
Important: This method creates a sync point, which means that the EntityManager waits for all currently running jobs to complete before adding the component. No additional jobs can start before the method is finished. A sync point can cause a drop in performance because the ECS framework might not be able to use the processing power of all available cores.
AddComponent<T>(NativeArray<Entity>)
Adds a component to a set of entities.
Declaration
[GenerateTestsForBurstCompatibility(GenericTypeArguments = new Type[]{typeof(BurstCompatibleComponentData)})]
public void AddComponent<T>(NativeArray<Entity> entities)Parameters
| Type | Name | Description |
|---|---|---|
| NativeArray<Entity> | entities | An array of Entity objects. |
Type Parameters
| Name | Description |
|---|---|
| T | The type of component to add. |
Remarks
Can add any kind of component.
Adding a component changes an entity's archetype and results in the entity being moved to a different chunk.
The added components have the default values for the type.
Important: This method creates a sync point, which means that the EntityManager waits for all currently running jobs to complete before adding the component. No additional jobs can start before the method is finished. A sync point can cause a drop in performance because the ECS framework might not be able to use the processing power of all available cores.
Exceptions
| Type | Condition |
|---|---|
| ArgumentException | The |
AddComponent(SystemHandle, in ComponentTypeSet)
Adds a set of component to an entity associated with a system.
Declaration
public void AddComponent(SystemHandle system, in ComponentTypeSet componentTypeSet)Parameters
| Type | Name | Description |
|---|---|---|
| SystemHandle | system | The system handle. |
| ComponentTypeSet | componentTypeSet | The types of components to add. |
Remarks
You can use this method to add a component to an Entity.
Adding components changes the entity's archetype and results in the entity being moved to a different chunk.
The added components have the default values for the type.
If the Entity object refers to an entity that has been destroyed, this function throws an InvalidOperationException exception.
Important: This method creates a sync point, which means that the EntityManager waits for all currently running jobs to complete before setting the component. No additional jobs can start before the method is finished. A sync point can cause a drop in performance because the ECS framework might not be able to use the processing power of all available cores.
Exceptions
| Type | Condition |
|---|---|
| InvalidOperationException | The Entity does not exist. |
AddComponent(Entity, in ComponentTypeSet)
Adds a set of component to an entity.
Declaration
public void AddComponent(Entity entity, in ComponentTypeSet componentTypeSet)Parameters
| Type | Name | Description |
|---|---|---|
| Entity | entity | The entity to modify. |
| ComponentTypeSet | componentTypeSet | The types of components to add. |
Remarks
You can use this method to add a component to an Entity.
Adding components changes the entity's archetype and results in the entity being moved to a different chunk.
The added components have the default values for the type.
If the Entity object refers to an entity that has been destroyed, this function throws an InvalidOperationException exception.
Important: This method creates a sync point, which means that the EntityManager waits for all currently running jobs to complete before adding the component. No additional jobs can start before the method is finished. A sync point can cause a drop in performance because the ECS framework might not be able to use the processing power of all available cores.
Exceptions
| Type | Condition |
|---|---|
| InvalidOperationException | The Entity does not exist. |