Method TryGetSingleton
TryGetSingleton<T>(out T)
Gets the value of a singleton component, and returns whether or not a singleton component of the specified type matches inside the EntityQuery. 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 bool TryGetSingleton<T>(out T value)
where T : struct, IComponentDataParameters
| Type | Name | Description |
|---|---|---|
| T | value | The component. if an Entity with the specified type does not exist in the World, this is assigned a default value |
Returns
| Type | Description |
|---|---|
| Boolean | True, if exactly one Entity exists in the World with the provided component type. |
Type Parameters
| Name | Description |
|---|---|
| T | The IComponentData subtype of the singleton component. This component type must not implement IEnableableComponent |
Exceptions
| Type | Condition |
|---|---|
| InvalidOperationException | Thrown if the number of entities that match this query is greater than one. |