Method CreateSingleton
CreateSingleton<T>(FixedString64Bytes)
Creates and supports only a single entity with a given unmanaged component.
Declaration
[GenerateTestsForBurstCompatibility(GenericTypeArguments = new Type[] { typeof(BurstCompatibleComponentData) })]
public Entity CreateSingleton<T>(FixedString64Bytes name = default) where T : unmanaged, IComponentDataParameters
| Type | Name | Description |
|---|---|---|
| FixedString64Bytes | name | The debug friendly name associated with the singleton component entity. |
Returns
| Type | Description |
|---|---|
| Entity | The Entity object that you can use to access the singleton component entity. |
Type Parameters
| Name | Description |
|---|---|
| T | The type of component to create. |
Remarks
Note that while zero-size component may be created, they can not be accessed directly in code. They are only usable for situations such as in calling RequireForUpdate<T>().
Exceptions
| Type | Condition |
|---|---|
| InvalidOperationException | Thrown if the component type has no fields, is enableable, or an entity containing it already exists. |
CreateSingleton<T>(T, FixedString64Bytes)
Creates and supports only a single entity with a given unmanaged component.
Declaration
[GenerateTestsForBurstCompatibility(GenericTypeArguments = new Type[] { typeof(BurstCompatibleComponentData) })]
public Entity CreateSingleton<T>(T componentData, FixedString64Bytes name = default) where T : unmanaged, IComponentDataParameters
| Type | Name | Description |
|---|---|---|
| T | componentData | The data to assign to the singleton component. |
| FixedString64Bytes | name | The debug friendly name associated with the singleton component entity. |
Returns
| Type | Description |
|---|---|
| Entity | The Entity object that you can use to access the singleton component entity. |
Type Parameters
| Name | Description |
|---|---|
| T | The type of component to create. |
Remarks
Note that while zero-size component may be created, they can not be accessed directly in code. They are only usable for situations such as in calling RequireForUpdate<T>().
Exceptions
| Type | Condition |
|---|---|
| InvalidOperationException | Thrown if the component type has no fields, is enableable, or an entity containing it already exists. |