Class ComponentSystemGroup | Entities | 0.13.0-preview.24
docs.unity3d.com
    Show / Hide Table of Contents

    Class ComponentSystemGroup

    Inheritance
    Object
    ComponentSystemBase
    ComponentSystem
    ComponentSystemGroup
    FixedStepSimulationSystemGroup
    InitializationSystemGroup
    LateSimulationSystemGroup
    PresentationSystemGroup
    SimulationSystemGroup
    SceneSystemGroup
    TransformSystemGroup
    Inherited Members
    ComponentSystem.PostUpdateCommands
    ComponentSystem.InitEntityQueryCache(Int32)
    ComponentSystem.Entities
    ComponentSystem.Update()
    ComponentSystemBase.Enabled
    ComponentSystemBase.EntityQueries
    ComponentSystemBase.GlobalSystemVersion
    ComponentSystemBase.LastSystemVersion
    ComponentSystemBase.EntityManager
    ComponentSystemBase.World
    ComponentSystemBase.Time
    ComponentSystemBase.OnCreateForCompiler()
    ComponentSystemBase.OnStartRunning()
    ComponentSystemBase.ShouldRunSystem()
    ComponentSystemBase.GetComponentTypeHandle<T>(Boolean)
    ComponentSystemBase.GetDynamicComponentTypeHandle(ComponentType)
    ComponentSystemBase.GetBufferTypeHandle<T>(Boolean)
    ComponentSystemBase.GetSharedComponentTypeHandle<T>()
    ComponentSystemBase.GetEntityTypeHandle()
    ComponentSystemBase.GetComponentDataFromEntity<T>(Boolean)
    ComponentSystemBase.GetBufferFromEntity<T>(Boolean)
    ComponentSystemBase.RequireForUpdate(EntityQuery)
    ComponentSystemBase.RequireSingletonForUpdate<T>()
    ComponentSystemBase.HasSingleton<T>()
    ComponentSystemBase.GetSingleton<T>()
    ComponentSystemBase.SetSingleton<T>(T)
    ComponentSystemBase.GetSingletonEntity<T>()
    ComponentSystemBase.GetEntityQuery(ComponentType[])
    ComponentSystemBase.GetEntityQuery(NativeArray<ComponentType>)
    ComponentSystemBase.GetEntityQuery(EntityQueryDesc[])
    Namespace: Unity.Entities
    Syntax
    public abstract class ComponentSystemGroup : ComponentSystem

    Fields

    m_systemsToUpdate

    Declaration
    protected List<ComponentSystemBase> m_systemsToUpdate
    Field Value
    Type Description
    List<ComponentSystemBase>

    UpdateCallback

    An optional callback. If set, this group's systems will be updated in a loop while this callback returns true. This can be used to implement custom processing before/after update (first call should return true, second should return false), or to run a group's systems multiple times (return true more than once).

    The group is passed as the first parameter.

    Declaration
    public Func<ComponentSystemGroup, bool> UpdateCallback
    Field Value
    Type Description
    Func<ComponentSystemGroup, Boolean>

    Properties

    Systems

    Declaration
    public virtual IEnumerable<ComponentSystemBase> Systems { get; }
    Property Value
    Type Description
    IEnumerable<ComponentSystemBase>

    UseLegacySortOrder

    Controls if the legacy sort ordering is used.

    Declaration
    public bool UseLegacySortOrder { get; set; }
    Property Value
    Type Description
    Boolean

    Methods

    AddSystemToUpdateList(ComponentSystemBase)

    Declaration
    public void AddSystemToUpdateList(ComponentSystemBase sys)
    Parameters
    Type Name Description
    ComponentSystemBase sys

    OnCreate()

    Declaration
    protected override void OnCreate()
    Overrides
    ComponentSystemBase.OnCreate()

    OnDestroy()

    Declaration
    protected override void OnDestroy()
    Overrides
    ComponentSystemBase.OnDestroy()

    OnStopRunning()

    Declaration
    protected override void OnStopRunning()
    Overrides
    ComponentSystemBase.OnStopRunning()

    OnUpdate()

    Declaration
    protected override void OnUpdate()
    Overrides
    ComponentSystem.OnUpdate()

    RemoveSystemFromUpdateList(ComponentSystemBase)

    Declaration
    public void RemoveSystemFromUpdateList(ComponentSystemBase sys)
    Parameters
    Type Name Description
    ComponentSystemBase sys

    SortSystems()

    Update the component system's sort order.

    Declaration
    public void SortSystems()

    Extension Methods

    ComponentSystemBaseManagedComponentExtensions.HasSingleton<T>(ComponentSystemBase)
    ComponentSystemBaseManagedComponentExtensions.GetSingleton<T>(ComponentSystemBase)
    ComponentSystemBaseManagedComponentExtensions.SetSingleton<T>(ComponentSystemBase, T)
    JobForEachExtensions.GetEntityQueryForIJobForEach(ComponentSystemBase, Type)
    In This Article
    • Fields
      • m_systemsToUpdate
      • UpdateCallback
    • Properties
      • Systems
      • UseLegacySortOrder
    • Methods
      • AddSystemToUpdateList(ComponentSystemBase)
      • OnCreate()
      • OnDestroy()
      • OnStopRunning()
      • OnUpdate()
      • RemoveSystemFromUpdateList(ComponentSystemBase)
      • SortSystems()
    • Extension Methods
    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