Class UpdateInGroupAttribute | Entities | 0.16.0-preview.21
docs.unity3d.com
    Show / Hide Table of Contents

    Class UpdateInGroupAttribute

    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.

    Inheritance
    Object
    Attribute
    UpdateInGroupAttribute
    Namespace: Unity.Entities
    Syntax
    [AttributeUsage(AttributeTargets.Class | AttributeTargets.Struct)]
    public class UpdateInGroupAttribute : Attribute, _Attribute

    Constructors

    UpdateInGroupAttribute(Type)

    Declaration
    public UpdateInGroupAttribute(Type groupType)
    Parameters
    Type Name Description
    Type groupType

    Fields

    OrderFirst

    Declaration
    public bool OrderFirst
    Field Value
    Type Description
    Boolean

    OrderLast

    Declaration
    public bool OrderLast
    Field Value
    Type Description
    Boolean

    Properties

    GroupType

    Declaration
    public Type GroupType { get; }
    Property Value
    Type Description
    Type
    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023