Documentation

Unity Engine


Unity Engine


TryGetSingletonEntity<T>(out Entity)

Gets the singleton Entity, and returns whether or not a singleton Entity of the specified type exists in the ComponentSystemBase.World.
Read time 1 minuteLast updated a day ago

Definition

  • Type: Method
  • Namespace: Unity.Entities
  • Assembly: UnityEngine.EntitiesModule

TryGetSingletonEntity<T>(Entity)

Warning
Deprecated. Use SystemAPI.TryGetSingletonEntity instead (RemovedAfter Entities 1.0)
public bool TryGetSingletonEntity<T>(out Entity value)

Parameters

value

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

Returns

Type

Description

boolTrue, if exactly one Entity exists in the ComponentSystemBase.World with the provided component type.