Method TryGetSingletonRW
TryGetSingletonRW<T>(out RefRW<T>)
Gets a reference to 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 TryGetSingletonRW<T>(out RefRW<T> value)
where T : struct, IComponentDataParameters
| Type | Name | Description |
|---|---|---|
| RefRW<T> | value | The reference of the component |
Returns
| Type | Description |
|---|---|
| Boolean | A reference to 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 | Thrown if the number of entities that match this query is greater than one. |