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 exists in the World.
Declaration
public static bool TryGetSingleton<T>(out T value)
where T : struct, IComponentData
Parameters
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 |
Remarks
Not working in Entities.ForEach, IJobEntity, Utility methods, and Aspects