Method GetSingleton
GetSingleton<T>(EntityQuery)
Gets the value of a singleton component.
Declaration
public static T GetSingleton<T>(this EntityQuery query)
where T : class, IComponentData
Parameters
Type | Name | Description |
---|---|---|
EntityQuery | query |
Returns
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 |