Version: Unity 7.0 Alpha (7000.0)
LanguageEnglish
  • C#

BufferLookup<T0>.TryGetBuffer

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

Cancel

Declaration

public bool TryGetBuffer(Entity entity, out DynamicBuffer`1 bufferData);

Parameters

Parameter Description
entity The entity.
bufferData The buffer component of type T for the given entity, if it exists.

Returns

bool True if the entity has a buffer component of type T, and false if it does not.

Description

Retrieves the buffer components associated with the specified Entity, if it exists. Then reports if the instance still refers to a valid entity and that it has a buffer component of type T.


Declaration

public bool TryGetBuffer(Entity entity, out DynamicBuffer`1 bufferData, out bool entityExists);

Parameters

Parameter Description
entity The entity.
bufferData The buffer component of type T for the given entity, if it exists.
entityExists Denotes whether the given entity exists. Use to distinguish entity non-existence from buffer non-existence.

Returns

bool True if the entity has a buffer component of type T, and false if it does not.

Description

Retrieves the buffer components associated with the specified Entity, if it exists. Then reports if the instance still refers to a valid entity and that it has a buffer component of type T.