docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Method TryGetSingletonBuffer

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

    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. Note that if querying a singleton buffer component from a system-associated entity, the query must include either EntityQueryOptions.IncludeSystems or the SystemInstance component.

    Declaration
    [GenerateTestsForBurstCompatibility(GenericTypeArguments = new Type[] { typeof(BurstCompatibleBufferElement) })]
    public bool TryGetSingletonBuffer<T>(out DynamicBuffer<T> value, bool isReadOnly = false) where T : unmanaged, IBufferElementData
    Parameters
    Type Name Description
    DynamicBuffer<T> value

    The buffer. if an Entity with the specified type does not exist in the World, this is assigned a default value

    bool isReadOnly

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

    Returns
    Type Description
    bool

    True, if exactly one Entity matches the EntityQuery 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

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