docs.unity.cn
    Show / Hide Table of Contents

    Method TryGetSingletonBuffer

    TryGetSingletonBuffer<T>(out DynamicBuffer<T>, Boolean)

    Gets the value of a singleton buffer component, and returns whether or not a singleton buffer component of the specified type exists in the World.

    Declaration
    public static bool TryGetSingletonBuffer<T>(out DynamicBuffer<T> value, bool isReadOnly = false)
        where T : struct, IBufferElementData
    Parameters
    Type Name Description
    DynamicBuffer<T> value

    The buffer. If an Entity with the specified type doesn't exist in the World, this is assigned a default value

    Boolean isReadOnly

    Whether the buffer data is read-only or not. Set to false by default.

    Returns
    Type Description
    Boolean

    True, if exactly one Entity exists in the World with the provided component type.

    Type Parameters
    Name Description
    T

    The IBufferElementData subtype of the singleton buffer component. This component type must not implement IEnableableComponent

    Remarks

    Not working in Entities.ForEach, IJobEntity, Utility methods, and Aspects

    Back to top Copyright © 2023 Unity Technologies — Terms of use
    Generated by DocFX
    on Wednesday, June 21, 2023