docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class ComponentSystemGroup

    A special-case system that encapsulates an ordered list of other systems. When the group is updated, the group's member systems are updated in order.

    Inheritance
    object
    ComponentSystemBase
    SystemBase
    ComponentSystemGroup
    BakingSystemGroup
    FixedStepSimulationSystemGroup
    InitializationSystemGroup
    LateSimulationSystemGroup
    PostBakingSystemGroup
    PreBakingSystemGroup
    PresentationSystemGroup
    SimulationSystemGroup
    TransformBakingSystemGroup
    VariableRateSimulationSystemGroup
    ProcessAfterLoadGroup
    SceneSystemGroup
    TransformSystemGroup
    Inherited Members
    SystemBase.Dependency
    SystemBase.CheckedStateRef
    SystemBase.CompleteDependency()
    SystemBase.Entities
    SystemBase.Job
    SystemBase.Update()
    SystemBase.GetComponent<T>(Entity)
    SystemBase.SetComponent<T>(Entity, T)
    SystemBase.HasComponent<T>(Entity)
    SystemBase.HasBuffer<T>(Entity)
    SystemBase.GetComponentLookup<T>(bool)
    SystemBase.GetComponentDataFromEntity<T>(bool)
    SystemBase.GetBuffer<T>(Entity, bool)
    SystemBase.GetBufferLookup<T>(bool)
    SystemBase.GetBufferFromEntity<T>(bool)
    SystemBase.GetEntityStorageInfoLookup()
    SystemBase.GetStorageInfoFromEntity()
    SystemBase.Exists(Entity)
    ComponentSystemBase.Enabled
    ComponentSystemBase.EntityQueries
    ComponentSystemBase.GlobalSystemVersion
    ComponentSystemBase.LastSystemVersion
    ComponentSystemBase.EntityManager
    ComponentSystemBase.World
    ComponentSystemBase.SystemHandle
    ComponentSystemBase.SystemHandleUntyped
    ComponentSystemBase.Time
    ComponentSystemBase.WorldUpdateAllocator
    ComponentSystemBase.OnStartRunning()
    ComponentSystemBase.OnStopRunning()
    ComponentSystemBase.ShouldRunSystem()
    ComponentSystemBase.GetComponentTypeHandle<T>(bool)
    ComponentSystemBase.GetDynamicComponentTypeHandle(ComponentType)
    ComponentSystemBase.GetBufferTypeHandle<T>(bool)
    ComponentSystemBase.GetSharedComponentTypeHandle<T>()
    ComponentSystemBase.GetDynamicSharedComponentTypeHandle(ComponentType)
    ComponentSystemBase.GetEntityTypeHandle()
    ComponentSystemBase.RequireForUpdate(EntityQuery)
    ComponentSystemBase.RequireAnyForUpdate(params EntityQuery[])
    ComponentSystemBase.RequireAnyForUpdate(NativeArray<EntityQuery>)
    ComponentSystemBase.RequireForUpdate<T>()
    ComponentSystemBase.RequireSingletonForUpdate<T>()
    ComponentSystemBase.HasSingleton<T>()
    ComponentSystemBase.GetSingleton<T>()
    ComponentSystemBase.GetSingletonRW<T>()
    ComponentSystemBase.GetSingletonBuffer<T>(bool)
    ComponentSystemBase.TryGetSingleton<T>(out T)
    ComponentSystemBase.TryGetSingletonBuffer<T>(out DynamicBuffer<T>)
    ComponentSystemBase.SetSingleton<T>(T)
    ComponentSystemBase.GetSingletonEntity<T>()
    ComponentSystemBase.TryGetSingletonEntity<T>(out Entity)
    ComponentSystemBase.GetEntityQuery(params ComponentType[])
    ComponentSystemBase.GetEntityQuery(NativeArray<ComponentType>)
    ComponentSystemBase.GetEntityQuery(params EntityQueryDesc[])
    ComponentSystemBase.GetEntityQuery(in EntityQueryBuilder)
    Namespace: Unity.Entities
    Assembly: Unity.Entities.dll
    Syntax
    public abstract class ComponentSystemGroup : SystemBase

    Properties

    Name Description
    Created

    Checks if the system group is in a fully initialized and valid state

    EnableSystemSorting

    If true (the default), calling SortSystems() will sort the system update list, respecting the constraints imposed by [UpdateBefore] and [UpdateAfter] attributes.

    FixedRateManager

    Obsolete. Use RateManager instead.

    ManagedSystems

    The list of managed systems in this group, sorted by update order.

    RateGroupAllocators

    Retrieve double rewindable allocators of this rate system group.

    RateManager

    Optional field to control the update rate of this system group.

    Methods

    Name Description
    AddSystemToUpdateList(ComponentSystemBase)

    Appends a managed system to the group's update list. The list will be sorted the next time the group is updated.

    AddSystemToUpdateList(SystemHandle)

    Appends an unmanaged system to the group's update list. The list will be sorted the next time the group is updated.

    GetAllSystems(Allocator)

    Get the list of all systems in this group, managed and unmanaged alike, sorted by update order.

    GetUnmanagedSystems(Allocator)

    Get the list of unmanaged systems in this group, sorted by update order.

    OnCreate()
    OnDestroy()
    OnUpdate()

    Updates the group's systems

    RemoveSystemFromUpdateList(ComponentSystemBase)

    Requests that a managed system be removed from the group's update list. The system will be removed the next time the group is sorted.

    RemoveSystemFromUpdateList(SystemHandle)

    Requests that an unmanaged system be removed from the group's update list. The system will be removed the next time the group is sorted.

    SetRateManagerCreateAllocator(IRateManager)

    Set optional rate manager for the system group and create group allocator.

    SortSystems()

    Update the component system's sort order.

    Extension Methods

    ComponentSystemBaseManagedComponentExtensions.GetSingletonRW<T>(ComponentSystemBase)
    ComponentSystemBaseManagedComponentExtensions.GetSingleton<T>(ComponentSystemBase)
    ComponentSystemBaseManagedComponentExtensions.SetSingleton<T>(ComponentSystemBase, T)
    ComponentSystemGroupExtensions.AddUnmanagedSystemToUpdateList(ComponentSystemGroup, SystemHandle)
    ComponentSystemGroupExtensions.RemoveUnmanagedSystemFromUpdateList(ComponentSystemGroup, SystemHandle)

    Did you find this page useful? Please give it a rating:

    Thanks for rating this page!

    Report a problem on this page

    What kind of problem would you like to report?

    • This page needs code samples
    • Code samples do not work
    • Information is missing
    • Information is incorrect
    • Information is unclear or confusing
    • There is a spelling/grammar error on this page
    • Something else

    Thanks for letting us know! This page has been marked for review based on your feedback.

    If you have time, you can provide more information to help us fix the problem faster.

    Provide more information

    You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:

    You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:

    You've told us there is information missing from this page. Please tell us more about what's missing:

    You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:

    You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:

    You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:

    You've told us this page has a problem. Please tell us more about what's wrong:

    Thank you for helping to make the Unity documentation better!

    Your feedback has been submitted as a ticket for our documentation team to review.

    We are not able to reply to every ticket submitted.

    In This Article
    • Properties
    • Methods
    • Extension Methods
    Back to top
    Copyright © 2025 Unity Technologies — Trademarks and terms of use
    • Legal
    • Privacy Policy
    • Cookie Policy
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)