GetSingletonBuffer<T>(bool)
Gets the value of a singleton buffer component. 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
public DynamicBuffer<T> GetSingletonBuffer<T>(bool isReadOnly = false) where T : unmanaged, IBufferElementData
Parameters
If the caller does not need to modify the buffer contents, pass true here.
Returns
Type | Description |
|---|---|
| DynamicBuffer<T> | The singleton buffer. |
Remarks
A singleton buffer component is a component of which only one instance exists that satisfies this query. There is no SetSingletonBuffer(); to change the contents of a singleton buffer, pass isReadOnly=false to GetSingletonBuffer() and then modify the contents directly.
Additional Resources: EntityQuery.GetSingletonEntity, ComponentSystemBase.GetSingleton