Documentation

Unity Engine

User Manual

Script Reference

Unity Engine

TryGetComponent

Retrieves the component associated with the specified Entity, if it exists. Then reports if the instance still refers to a valid entity and that it has a component of type T.
Read time 1 minuteLast updated 5 days ago

Definition

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

TryGetComponent(Entity, T, bool)

Retrieves the component associated with the specified Entity, if it exists. Then reports if the instance still refers to a valid entity and that it has a component of type T.
public bool TryGetComponent(Entity entity, out T componentData, out bool entityExists)

Parameters

entity

Entity
The entity.

componentData

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

entityExists

bool
Denotes whether the given entity exists. Use to differentiate an invalid entity from the entity not having the given buffer.

Returns

Type

Description

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

TryGetComponent(Entity, T)

Retrieves the component associated with the specified Entity, if it exists. Then reports if the instance still refers to a valid entity and that it has a component of type T.
public bool TryGetComponent(Entity entity, out T componentData)

Parameters

entity

Entity
The entity.

componentData

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

Returns

Type

Description

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