Method GetSingleton
GetSingleton<T>()
Gets the value of a singleton component. Note that if querying a singleton component from a system-associated entity, the query must include either EntityQueryOptions.IncludeSystems or the SystemInstance component.
Declaration
[GenerateTestsForBurstCompatibility(GenericTypeArguments = new Type[] { typeof(BurstCompatibleComponentData) })]
public T GetSingleton<T>() where T : unmanaged, IComponentDataReturns
| Type | Description |
|---|---|
| T | A copy of the singleton component. |
Type Parameters
| Name | Description |
|---|---|
| T | The component type. |
Remarks
A singleton component is a component of which only one instance exists that satisfies this query.
Exceptions
| Type | Condition |
|---|---|
| InvalidOperationException |