Struct EntityCommandBuffer | Package Manager UI website
docs.unity3d.com
    Show / Hide Table of Contents

    Struct EntityCommandBuffer

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

    Inherited Members
    System.ValueType.Equals(System.Object)
    System.ValueType.GetHashCode()
    System.ValueType.ToString()
    System.Object.Equals(System.Object, System.Object)
    System.Object.ReferenceEquals(System.Object, System.Object)
    System.Object.GetType()
    Namespace: Unity.Entities
    Syntax
    public struct EntityCommandBuffer

    Properties

    MinimumChunkSize

    Allows controlling the size of chunks allocated from the temp job allocator to back the command buffer.

    Declaration
    public int MinimumChunkSize { get; set; }
    Property Value
    Type Description
    System.Int32

    Methods

    AddComponent<T>(T)

    Declaration
    public void AddComponent<T>(T component)where T : struct, IComponentData
    Parameters
    Type Name Description
    T component
    Type Parameters
    Name Description
    T

    AddComponent<T>(Entity, T)

    Declaration
    public void AddComponent<T>(Entity e, T component)where T : struct, IComponentData
    Parameters
    Type Name Description
    Entity e
    T component
    Type Parameters
    Name Description
    T

    AddSharedComponent<T>(T)

    Declaration
    public void AddSharedComponent<T>(T component)where T : struct, ISharedComponentData
    Parameters
    Type Name Description
    T component
    Type Parameters
    Name Description
    T

    AddSharedComponent<T>(Entity, T)

    Declaration
    public void AddSharedComponent<T>(Entity e, T component)where T : struct, ISharedComponentData
    Parameters
    Type Name Description
    Entity e
    T component
    Type Parameters
    Name Description
    T

    CreateEntity()

    Declaration
    public void CreateEntity()

    CreateEntity(EntityArchetype)

    Declaration
    public void CreateEntity(EntityArchetype archetype)
    Parameters
    Type Name Description
    EntityArchetype archetype

    DestroyEntity(Entity)

    Declaration
    public void DestroyEntity(Entity e)
    Parameters
    Type Name Description
    Entity e

    Playback(EntityManager)

    Play back all recorded operations against an entity manager.

    Declaration
    public void Playback(EntityManager mgr)
    Parameters
    Type Name Description
    EntityManager mgr

    The entity manager that will receive the operations

    RemoveComponent<T>(Entity)

    Declaration
    public void RemoveComponent<T>(Entity e)
    Parameters
    Type Name Description
    Entity e
    Type Parameters
    Name Description
    T

    RemoveSystemStateComponent<T>(Entity)

    Declaration
    public void RemoveSystemStateComponent<T>(Entity e)
    Parameters
    Type Name Description
    Entity e
    Type Parameters
    Name Description
    T

    SetComponent<T>(T)

    Declaration
    public void SetComponent<T>(T component)where T : struct, IComponentData
    Parameters
    Type Name Description
    T component
    Type Parameters
    Name Description
    T

    SetComponent<T>(Entity, T)

    Declaration
    public void SetComponent<T>(Entity e, T component)where T : struct, IComponentData
    Parameters
    Type Name Description
    Entity e
    T component
    Type Parameters
    Name Description
    T

    SetSharedComponent<T>(T)

    Declaration
    public void SetSharedComponent<T>(T component)where T : struct, ISharedComponentData
    Parameters
    Type Name Description
    T component
    Type Parameters
    Name Description
    T

    SetSharedComponent<T>(Entity, T)

    Declaration
    public void SetSharedComponent<T>(Entity e, T component)where T : struct, ISharedComponentData
    Parameters
    Type Name Description
    Entity e
    T component
    Type Parameters
    Name Description
    T
    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