docs.unity.cn
    Show / Hide Table of Contents

    Method GetSingletonRW

    GetSingletonRW<T>(EntityQuery)

    Gets the value of a singleton component, for read/write access.

    Declaration
    [SkipLocalsInit]
    public static T GetSingletonRW<T>(this EntityQuery query)
        where T : class
    Parameters
    Type Name Description
    EntityQuery query

    The query

    Returns
    Type Description
    T

    A copy of the singleton component.

    Type Parameters
    Name Description
    T

    The component type. This type must not implement IEnableableComponent.

    Remarks

    A singleton component is a component of which only one instance exists that satisfies this query.

    Exceptions
    Type Condition
    InvalidOperationException

    Thrown if the singleton is zero-size, or if it implements an enableable component.

    See Also
    GetSingleton<T>(EntityQuery)
    GetSingletonRW<T>(EntityQuery)
    GetSingleton<T>()
    GetSingletonRW<T>()
    Back to top Copyright © 2023 Unity Technologies — Terms of use
    Generated by DocFX
    on Thursday, August 10, 2023