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

TransformLookup.TryGetTransform

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 TryGetTransform(Entity entity, out TransformRef transform);

Parameters

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

Returns

bool True if the entity has a TransformRef component, and false if it does not. Also returns false if the Entity instance refers to an entity that has been destroyed (or never existed).

Description

Retrieves the transform components associated with the specified Entity, if it exists. The return value indicates whether the component was successfully retrieved.


Declaration

public bool TryGetTransform(Entity entity, out TransformRef transform, out bool entityExists);

Parameters

Parameter Description
entity The entity.
transform The transform 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 TransformRef non-existence.

Returns

bool True if the entity has a TransformRef component, and false if it does not. Also returns false if the Entity instance refers to an entity that has been destroyed (or never existed).

Description

Retrieves the transform components associated with the specified Entity, if it exists. The return value indicates whether the component was successfully retrieved.