docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class SystemBase

    Inheritance
    object
    ComponentSystemBase
    SystemBase
    BakingSystem
    ComponentSystemGroup
    EntityCommandBufferSystem
    UpdateWorldTimeSystem
    SceneSectionStreamingSystem
    Inherited Members
    ComponentSystemBase.Enabled
    ComponentSystemBase.EntityQueries
    ComponentSystemBase.GlobalSystemVersion
    ComponentSystemBase.LastSystemVersion
    ComponentSystemBase.EntityManager
    ComponentSystemBase.World
    ComponentSystemBase.SystemHandle
    ComponentSystemBase.SystemHandleUntyped
    ComponentSystemBase.Time
    ComponentSystemBase.WorldUpdateAllocator
    ComponentSystemBase.OnCreate()
    ComponentSystemBase.OnStartRunning()
    ComponentSystemBase.OnStopRunning()
    ComponentSystemBase.OnDestroy()
    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
    [RequireDerived]
    public abstract class SystemBase : ComponentSystemBase

    Properties

    Name Description
    CheckedStateRef

    The SystemState for this SystemBase.

    Dependency

    The ECS-related data dependencies of the system.

    Methods

    Name Description
    CompleteDependency()

    Completes job handles registered with this system. See Dependency for more information.

    Exists(Entity)

    Checks if the entity exists inside this system's EntityManager.

    GetBufferFromEntity<T>(bool)

    Obsolete. Use GetBufferLookup<T>(bool) instead.

    GetBufferLookup<T>(bool)

    Manually gets a BufferLookup<T> object that can access a DynamicBuffer<T>.

    GetBuffer<T>(Entity, bool)

    Gets the dynamic buffer of an entity.

    GetComponentDataFromEntity<T>(bool)

    Obsolete. Use GetComponentLookup<T>(bool) instead.

    GetComponentLookup<T>(bool)

    Manually gets a dictionary-like container containing all components of type T, keyed by Entity.

    GetComponent<T>(Entity)

    Look up the value of a component for an entity.

    GetEntityStorageInfoLookup()

    Manually gets an EntityStorageInfoLookup object that can access a EntityStorageInfo.

    GetStorageInfoFromEntity()

    Obsolete. Use GetEntityStorageInfoLookup() instead.

    HasBuffer<T>(Entity)

    Checks whether an entity has a dynamic buffer of a specific IBufferElementData type.

    HasComponent<T>(Entity)

    Checks whether an entity has a specific type of component.

    OnUpdate()

    Implement OnUpdate() to perform the major work of this system.

    SetComponent<T>(Entity, T)

    Sets the value of a component of an entity.

    Update()

    Update the system manually.

    Extension Methods

    ComponentSystemBaseManagedComponentExtensions.GetSingletonRW<T>(ComponentSystemBase)
    ComponentSystemBaseManagedComponentExtensions.GetSingleton<T>(ComponentSystemBase)
    ComponentSystemBaseManagedComponentExtensions.SetSingleton<T>(ComponentSystemBase, T)
    In This Article
    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)