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

EntityManager.GetComponentOrderVersion

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 int GetComponentOrderVersion();

Returns

int The current version number.

Description

Gets the version number of the specified component type.

This version number is incremented each time there is a structural change involving the specified type of component. Such changes include creating or destroying entities that have this component and adding or removing the component type from an entity. Shared components are not covered by this version; see EntityManager.GetSharedComponentOrderVersion.

Version numbers can overflow. To compare if one version is more recent than another, directly checking if VersionB is greater than VersionA is not sufficient. Instead, use the helper function:

bool VersionBisNewer = ChangeVersionUtility.DidChange(VersionB, VersionA);


Declaration

public int GetComponentOrderVersion(ComponentType componentType);

Parameters

Parameter Description
componentType The component type.

Returns

int The current version number.

Description

Gets the version number of the specified component type.


This version number is incremented each time there is a structural change involving the specified type of component. Such changes include creating or destroying entities that have this component and adding or removing the component type from an entity. Shared components are not covered by this version. EntityManager.GetSharedComponentOrderVersion.

Version numbers can overflow. To compare if one version is more recent than another, directly checking if VersionB is greater than VersionA is not sufficient. Instead, use the helper function:
bool VersionBisNewer = ChangeVersionUtility.DidChange(VersionB, VersionA);