Documentation

Unity Engine


Unity Engine


TryGetComponent<T>(Entity, out T)

Try to look up the value of a component for an entity.
Read time 1 minuteLast updated a day ago

Definition

  • Type: Method
  • Namespace: Unity.Entities
  • Assembly: UnityEngine.EntitiesModule

TryGetComponent<T>(Entity, T)

public static bool TryGetComponent<T>(Entity entity, out T result) where T : unmanaged, IComponentData

Parameters

entity

The entity.

result

T
A struct of type T containing the component value, or default if the entity does not have the component.

Returns

Type

Description

boolTrue if the entity has the component, false otherwise.

Remarks

Use this method to look up data in another entity using its Entity object. For example, if you have a component that contains an Entity field, you can look up the component data for the referenced entity using this method.
Not working in Entities.ForEach, IJobEntity, and Utility methods