Documentation

Unity Engine


Unity Engine


TryGetSingletonRW<T>(out RefRW<T>)

Gets a reference to 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 a day ago

Definition

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

TryGetSingletonRW<T>(RefRW<T>)

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

Parameters

The reference of the component

Returns

Type

Description

boolA reference to the singleton component.

Remarks

A singleton component is a component of which only one instance exists that satisfies this query.