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

SystemAPI.GetComponent

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 static T GetComponent(Entity entity);

Parameters

Parameter Description
entity The entity.

Returns

T A struct of type T containing the component value.

Description

Look up the value of a component for an entity.

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.

When iterating over a set of entities with an idomatic foreach query, don't use this method to access the data of the current entity in the set. It's faster to access the data by requesting it as an argument of a query.

When you call this method it gets replaced with component access methods through ComponentLookup<T0>.

This lookup method results in a slower, indirect memory access. When possible, organize your data to minimize the need for indirect lookups.

Not working in IJobEntity, and Utility methods


Declaration

public static T GetComponent(SystemHandle systemHandle);

Parameters

Parameter Description
systemHandle The system handle.

Returns

T A struct of type T containing the component value.

Description

Gets the value of a component for an entity associated with a system.

Use this method to look up data in another system owned entity using its SystemHandle object.

When you call this method it gets replaced with component access methods through ComponentLookup<T0>.

Not working in IJobEntity, and Utility methods