Documentation

Unity Engine

Unity Engine

GetComponentTypeHandle<T>(bool)

Manually gets the run-time type information required to access an array of component data in a chunk.
Read time 1 minuteLast updated 6 days ago

Definition

  • Type: Method
  • Namespace: Unity.Entities
  • Assembly: UnityEngine.EntitiesModule
public ComponentTypeHandle<T> GetComponentTypeHandle<T>(bool isReadOnly = false) where T : unmanaged, IComponentData

Parameters

isReadOnly

Whether the component data is only read, not written. Access components as read-only whenever possible.

Returns

Type

Description

ComponentTypeHandle<T>An object representing the type information required to safely access component data stored in a chunk.

Remarks

Pass an ComponentTypeHandle<T> instance to a job that has access to chunk data, such as an IJobChunk job, to access that type of component inside the job.
Prefer using SystemAPI.GetComponentTypeHandle in SystemAPI as it will cache in OnCreate for you and call .Update(this) at the call-site.