SystemAPI.TryGetSingletonBuffer
Suggest a change
Success!
Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.
Close
Submission failed
For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.
Close
Declaration
public static bool TryGetSingletonBuffer(out DynamicBuffer`1 value,
bool isReadOnly);
Parameters
| Parameter |
Description |
| value |
The buffer. If an Entity with the specified type doesn't 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
bool
True, if exactly one Entity exists in the World with the provided component type.
Description
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.
Not working in Entities.ForEach, IJobEntity, and Utility methods