Documentation

Unity Engine

User Manual

Script Reference

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 World.
Read time 1 minuteLast updated a day ago

Definition

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

TryGetSingletonEntity<T>(Entity)

public static bool TryGetSingletonEntity<T>(out Entity value) where T : unmanaged

Parameters

value

Entity
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

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

Remarks

Not working in Entities.ForEach, IJobEntity, and Utility methods