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

UpdateInGroupAttribute

class in Unity.Entities

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

Description

The specified Type must be a ComponentSystemGroup. Updating in a group means this system will be automatically updated by the specified ComponentSystemGroup when the group is updated. The system may order itself relative to other systems in the group with UpdateBefore and UpdateAfter. This ordering takes effect when the system group is sorted.

If the optional OrderFirst parameter is set to true, this system will act as if it has an implicit [UpdateBefore] targeting all other systems in the group that do "not" have OrderFirst=true, but it may still order itself relative to other systems with OrderFirst=true.

If the optional OrderLast parameter is set to true, this system will act as if it has an implicit [UpdateAfter] targeting all other systems in the group that do "not" have OrderLast=true, but it may still order itself relative to other systems with OrderLast=true.

An UpdateInGroup attribute with both OrderFirst=true and OrderLast=true is invalid, and will throw an exception.

Properties

Property Description
GroupType Retrieve the ComponentSystemGroup type.
OrderFirst If true, the tagged system will be sorted earlier than all systems in the ComponentSystemGroup which do not have OrderFirst=true.
OrderLast If true, the tagged system will be sorted later than all systems in the ComponentSystemGroup which do not have OrderLast=true.

Constructors

Constructor Description
UpdateInGroupAttribute Specify the ComponentSystemGroup which the tagged system should be added to. The tagged system will be updated as part of this system group's Update() method.