Documentation

Unity Engine


Unity Engine


TryGetSingletonBuffer<T>(out DynamicBuffer<T>, bool)

Gets the value of a singleton buffer component, and returns whether or not a singleton buffer component of the specified type exists in the World. Note that if querying a singleton buffer 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

TryGetSingletonBuffer<T>(DynamicBuffer<T>, bool)

public bool TryGetSingletonBuffer<T>(out DynamicBuffer<T> value, bool isReadOnly = false) where T : unmanaged, IBufferElementData

Parameters

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

isReadOnly

Whether the buffer data is read-only or not. Set to false by default.

Returns

Type

Description

boolTrue, if exactly one Entity matches the EntityQuery with the provided component type.