docs.unity3d.com
    Show / Hide Table of Contents

    Method SetSharedComponent

    SetSharedComponent<T>(Entity, T)

    Records a command to set a shared component value on an entity.

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

    The entity to set the shared component value of.

    T component

    The shared component value to set.

    Type Parameters
    Name Description
    T

    The type of shared component to set.

    Remarks

    Behavior at Playback: Will throw an error if this entity is destroyed before playback, if this entity is still deferred, or if the entity doesn't have the shared component type.

    Exceptions
    Type Condition
    NullReferenceException

    Throws if an Allocator was not passed in when the EntityCommandBuffer was created.

    InvalidOperationException

    Throws if this EntityCommandBuffer has already been played back.

    SetSharedComponent<T>(NativeArray<Entity>, T)

    Records a command to set a shared component value on a NativeArray of entities.

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

    The NativeArray of entities to set the shared component value of.

    T component

    The shared component value to set.

    Type Parameters
    Name Description
    T

    The type of shared component to set.

    Remarks

    Behavior at Playback: Will throw an error if any entity is destroyed before playback, if any entity is still deferred, or if any entity doesn't have the shared component type.

    Exceptions
    Type Condition
    NullReferenceException

    Throws if an Allocator was not passed in when the EntityCommandBuffer was created.

    InvalidOperationException

    Throws if this EntityCommandBuffer has already been played back.

    Back to top
    Terms of use
    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