Documentation

Unity Engine


Unity Engine


GetSharedComponentOrderVersion<T>(T)

Gets the version number of the specified shared component.
Read time 1 minuteLast updated a day ago

Definition

  • Type: Method
  • Namespace: Unity.Entities
  • Assembly: UnityEngine.EntitiesModule
public int GetSharedComponentOrderVersion<T>(T sharedComponent) where T : unmanaged, ISharedComponentData

Parameters

sharedComponent

T
The unmanaged shared component instance.

Returns

Type

Description

intThe current version number.

Remarks

This version number is incremented each time there is a structural change involving entities in the chunk of the specified shared component. Such changes include creating or destroying entities or anything that changes the archetype of an entity.
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);