Documentation

Unity Engine

User Manual

Script Reference

Unity Engine

TryGetSingleton<T>(out T)

Gets the value of a singleton component, and returns whether or not a singleton component of the specified type matches inside the EntityQuery. Note that if querying a singleton component from a system-associated entity, the query must include either EntityQueryOptions.IncludeSystems or the SystemInstance component.
Read time 1 minuteLast updated 3 days ago

Definition

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

TryGetSingleton<T>(T)

public bool TryGetSingleton<T>(out T value) where T : unmanaged, IComponentData

Parameters

value

T
The component. if an Entity with the specified type does not exist in the World, this is assigned a default value

Returns

Type

Description

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