Method TryGetSingleton
TryGetSingleton<T>(EntityQuery, out T)
Gets the value of a singleton component, for read/write access.
Declaration
[SkipLocalsInit]
public static bool TryGetSingleton<T>(this EntityQuery query, out T value)
where T : classParameters
| Type | Name | Description |
|---|---|---|
| EntityQuery | query | The query |
| T | value | The component. |
Returns
| Type | Description |
|---|---|
| Boolean | A copy of the singleton component. |
Type Parameters
| Name | Description |
|---|---|
| T | The component type. This type must not implement IEnableableComponent. |
Remarks
A singleton component is a component of which only one instance exists that satisfies this query.
Exceptions
| Type | Condition |
|---|---|
| InvalidOperationException | Thrown if the singleton is zero-size, or if it implements an enableable component. |