Method TryGetSingletonEntity

TryGetSingletonEntity<T>(out Entity)

Gets the singleton Entity, and returns whether or not a singleton Entity of the specified type exists in the World.

Declaration

public bool TryGetSingletonEntity<T>(out Entity value)

Parameters

Type	Name	Description
Entity	value	The Entity associated with the specified singleton component. If a singleton of the specified types does not exist in the current World, this is set to Entity.Null

Returns

Type	Description
bool	True, if exactly one Entity matches the EntityQuery 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.
InvalidOperationException	Thrown the query references any enableable components.