docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Namespace Unity.Entities

    Classes

    BakeDerivedTypesAttribute

    Attribute that informs the baking system that bakers of types derived from the current authoring component must be executed.

    Baker<TAuthoringType>

    Inherit this class to bake an authoring component.

    BakingSystem

    Provides methods to control the baking process, and provides access to the BlobAssetStore used during baking.

    BakingSystemGroup

    The group of systems where baking systems run by default.

    BeginFixedStepSimulationEntityCommandBufferSystem

    The EntityCommandBufferSystem at the beginning of the FixedStepSimulationSystemGroup.

    BeginInitializationEntityCommandBufferSystem

    The EntityCommandBufferSystem at the beginning of the InitializationSystemGroup.

    BeginPresentationEntityCommandBufferSystem

    The EntityCommandBufferSystem at the beginning of the PresentationSystemGroup.

    BeginSimulationEntityCommandBufferSystem

    The EntityCommandBufferSystem at the beginning of the SimulationSystemGroup.

    BeginVariableRateSimulationEntityCommandBufferSystem

    The EntityCommandBufferSystem at the beginning of the VariableRateSimulationSystemGroup.

    BindingRegistry

    Builds a static registry of bindings between a runtime field with an authoring field. Multiple different runtime fields can be associated with a same authoring field. Only primitive types of int, bool, and float, in addition to Unity.Mathematics variants of these primitives (e.g. int2, float4) will be added to the BindingRegistry. Other types will be silently ignored.

    BindingRegistryUtility

    Utility class for BindingRegistry.

    ChunkIndexInQuery

    Specifies that this int parameter is used as the chunk index inside the current query. Usage: An int parameter found inside the execute method of an IJobEntity.

    ECBExtensionMethods

    Extension methods for EntityCommandBufferSystem.

    EndFixedStepSimulationEntityCommandBufferSystem

    The EntityCommandBufferSystem at the end of the FixedStepSimulationSystemGroup.

    EndInitializationEntityCommandBufferSystem

    The EntityCommandBufferSystem at the end of the InitializationSystemGroup.

    EndSimulationEntityCommandBufferSystem

    The EntityCommandBufferSystem at the end of the SimulationSystemGroup.

    EndVariableRateSimulationEntityCommandBufferSystem

    The EntityCommandBufferSystem at the end of the VariableRateSimulationSystemGroup.

    EntityCommandBufferSystem

    A system that provides EntityCommandBuffer objects for other systems.

    EntityInQueryIndex

    Obsolete. Use EntityIndexInQuery instead.

    EntityIndexInChunk

    Specifies that this int parameter is used as the entity index inside the current chunk. Usage: An int parameter found inside the execute method of an IJobEntity.

    EntityIndexInQuery

    Specifies that this int parameter is used as a way to get the packed entity index inside the current query. Usage: An int parameter found inside the execute method of an IJobEntity.

    EntityManagerDebugExtensions

    The authoring-object lookups of EntityManager. They take and return Unity objects, which the Entities module, below the Core module, can't name, so they live in the package as extension methods; calls such as entityManager.Debug.GetAuthoringObjectForEntity(entity) read the same.

    EntityManagerExtensions

    EntityPatcher

    Utility class to apply a EntityChangeSet to an EntityManager

    IBaker

    This class contains all the methods to bake a authoring component to an Entity.

    IJobEntityExtensions

    Extension methods for IJobEntity job type

    LayerFieldAttribute

    Attribute used to make an int field display as a layer selector drop-down.

    PostBakingSystemGroup

    The group of systems that runs after BakingSystemGroup.

    PreBakingSystemGroup

    The group of systems that runs before the bakers execute.

    RegisterBindingAttribute

    Creates a table association between the Type specified and the runtime field of an IComponentData, accessible via the BindingRegistry

    SceneSectionComponent

    Component to indicate that a GameObject and its children belong to the specified scene section.

    StaticOptimizeEntity

    Authoring component that indicates that the hierarchy from this point should be considered static and can be optimized.

    SystemAPI

    Giving quick and consistent access to buffers, components, time, enumeration, singletons and more. This includes any IJobEntity, SystemBase, and Unity.Entities.ISystem. Suggested usage is:

      using static Unity.Entities.SystemAPI;
      [...]
      partial struct SomeJob : IJobEntity { void Execute(ref EcsTestData e1) => e1.value += Time.deltaTime; }
    

    TransformBakingSystemGroup

    The group of systems that runs just after the bakers but before BakingSystemGroup.

    UpdateWorldTimeSystem

    A system that updates the Unity.Entities.WorldTime value, based on the elapsed time since the previous frame.

    WithAbsentAttribute

    Specify that an IJobEntity should not include any of the component types specified as part of the attribute.

    WithAllAttribute

    Specifies that this IJobEntity should include all ComponentTypes found as attributes of the IJobEntity

    WithAnyAttribute

    Specifies that this IJobEntity should include any ComponentTypes found as attributes of the IJobEntity

    WithChangeFilterAttribute

    Specifies that this IJobEntity should only process a chunk if any of the ComponentTypes found as attributes of the IJobEntity have changed.

    WithDisabledAttribute

    Specify that an IJobEntity should include all of the component types specified as part of the attribute, but they must all be disabled.

    WithEntityQueryOptionsAttribute

    Obsolete. Use WithOptionsAttribute instead.

    WithNoneAttribute

    Specifies that this IJobEntity should include no ComponentTypes found as attributes of the IJobEntity

    WithOptionsAttribute

    Specifies that this IJobEntity should include a given EntityQueryOption found as attributes of the IJobEntity

    WithPresentAttribute

    Specify that an IJobEntity should include all of the component types specified as part of the attribute, whether or not the components are enabled on individual entities.

    Structs

    AdditionalEntityParent

    Contains information to identify the parent of an additional entity.

    BakedEntity

    This type is used to identify identities that had any baking done on them before the BakingSystems ran

    BakingOnlyEntity

    The entity will be stripped out before it appears in the live game world.

    BeginFixedStepSimulationEntityCommandBufferSystem.Singleton

    Call GetSingleton<T>() to get this component for this system, and then call CreateCommandBuffer(WorldUnmanaged) on this singleton to create an ECB to be played back by this system.

    BeginInitializationEntityCommandBufferSystem.Singleton

    Call GetSingleton<T>() to get this component for this system, and then call CreateCommandBuffer(WorldUnmanaged) on this singleton to create an ECB to be played back by this system.

    BeginPresentationEntityCommandBufferSystem.Singleton

    Call GetSingleton<T>() to get this component for this system, and then call CreateCommandBuffer(WorldUnmanaged) on this singleton to create an ECB to be played back by this system.

    BeginSimulationEntityCommandBufferSystem.Singleton

    Call GetSingleton<T>() to get this component for this system, and then call CreateCommandBuffer(WorldUnmanaged) on this singleton to create an ECB to be played back by this system.

    BeginVariableRateSimulationEntityCommandBufferSystem.Singleton

    Call GetSingleton<T>() to get this component for this system, and then call CreateCommandBuffer(WorldUnmanaged) on this singleton to create an ECB to be played back by this system.

    BindingRegistry.ReverseBinding

    Binds a runtime field property to an authoring field name

    BindingRegistry.RuntimeFieldProperties

    Properties of a runtime field.

    BlobAssetStore

    Purpose of this class is to provide a consistent cache of BlobAsset object in order to avoid rebuilding them when it is not necessary

    EndFixedStepSimulationEntityCommandBufferSystem.Singleton

    Call GetSingleton<T>() to get this component for this system, and then call CreateCommandBuffer(WorldUnmanaged) on this singleton to create an ECB to be played back by this system.

    EndInitializationEntityCommandBufferSystem.Singleton

    Call GetSingleton<T>() to get this component for this system, and then call CreateCommandBuffer(WorldUnmanaged) on this singleton to create an ECB to be played back by this system.

    EndSimulationEntityCommandBufferSystem.Singleton

    Call GetSingleton<T>() to get this component for this system, and then call CreateCommandBuffer(WorldUnmanaged) on this singleton to create an ECB to be played back by this system.

    EndVariableRateSimulationEntityCommandBufferSystem.Singleton

    Call GetSingleton<T>() to get this component for this system, and then call CreateCommandBuffer(WorldUnmanaged) on this singleton to create an ECB to be played back by this system.

    EntityCommandBuffer

    A thread-safe command buffer that can buffer commands that affect entities and components for later playback.

    EntityCommandBuffer.ParallelWriter

    Allows concurrent (deterministic) command buffer recording.

    EntityManagerDiffer

    The EntityManagerDiffer is used to efficiently track changes to a given world over time.

    QueryEnumerableWithEntity<T1>

    An enumeration interface for the entities that match an EntityQuery. This variant includes access the the entity and its component values.

    QueryEnumerableWithEntity<T1, T2>

    An enumeration interface for the entities that match an EntityQuery. This variant includes access the the entity and its component values.

    QueryEnumerableWithEntity<T1, T2, T3>

    An enumeration interface for the entities that match an EntityQuery. This variant includes access the the entity and its component values.

    QueryEnumerableWithEntity<T1, T2, T3, T4>

    An enumeration interface for the entities that match an EntityQuery. This variant includes access the the entity and its component values.

    QueryEnumerableWithEntity<T1, T2, T3, T4, T5>

    An enumeration interface for the entities that match an EntityQuery. This variant includes access the the entity and its component values.

    QueryEnumerableWithEntity<T1, T2, T3, T4, T5, T6>

    An enumeration interface for the entities that match an EntityQuery. This variant includes access the the entity and its component values.

    QueryEnumerableWithEntity<T1, T2, T3, T4, T5, T6, T7>

    An enumeration interface for the entities that match an EntityQuery. This variant includes access the the entity and its component values.

    QueryEnumerable<T1>

    An enumeration interface for the entities that match an EntityQuery.

    QueryEnumerable<T1, T2>

    An enumeration interface for the entities that match an EntityQuery.

    QueryEnumerable<T1, T2, T3>

    An enumeration interface for the entities that match an EntityQuery.

    QueryEnumerable<T1, T2, T3, T4>

    An enumeration interface for the entities that match an EntityQuery.

    QueryEnumerable<T1, T2, T3, T4, T5>

    An enumeration interface for the entities that match an EntityQuery.

    QueryEnumerable<T1, T2, T3, T4, T5, T6>

    An enumeration interface for the entities that match an EntityQuery.

    QueryEnumerable<T1, T2, T3, T4, T5, T6, T7>

    An enumeration interface for the entities that match an EntityQuery.

    SceneReference

    Component that references a scene.

    SceneSectionData

    This component contains data relative to a SceneSection.

    SystemAPIQueryBuilder

    Supports construction of queries matching one or multiple archetypes inside ISystem and SystemBase types. All queried components must be known at compile-time.

    TransformAuthoring

    TransformAuthoring is automatically created for every single entity created during baking. It gives access to the complete data the authoring Transform carries, the components exist only during baking. The TransformAuthoring component is stripped out automatically at runtime.

    This can be used by systems that want to access the original authoring transform data in baking systems, without relying on the runtime transforms existing. In many cases we want to bake our authoring state into more optimal runtime representations. For example Unity.Physics bakes all colliders that may be children in the game object hierarchy into the entity containing the rigidbody. Hence the game objects with those colliders might not be required to be entities at runtime at all, but in baking systems we need to be able to access the TransformAuthoring data to correctly bake the colliders based on their positions relative to the parent rigidbody.

    Interfaces

    IECBSingleton

    Interface for use with EntityCommandBufferSystems to store the list of pending buffers, which can be accessed from a bursted ISystem. You should implement a singleton with this interface every time you inherit from EntityCommandBufferSystem.

    IJobEntity

    Interface for a job type which runs code on each entity that matches an EntityQuery.

    IJobEntityChunkBeginEnd

    When added to an implemented IJobEntity the two functions will be called at the beginning and end of each chunk iteration.

    Enums

    EntityManagerDifferOptions

    Parameters used to configure the the execution of the differ.

    EntityQueryCaptureMode

    Specifies when an EntityQuery passed to an EntityCommandBuffer should be evaluated.

    PlaybackPolicy

    Specifies if the EntityCommandBuffer can be played a single time or multiple times.

    TransformUsageFlags

    Controls how Transform components on GameObjects are converted to entity data.

    In This Article
    Back to top
    Copyright © 2026 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)