docs.unity3d.com
    Show / Hide Table of Contents

    Method GetSingleton

    GetSingleton<T>()

    Gets the value of a singleton component.

    Declaration
    [BurstCompatible(GenericTypeArguments = new Type[]{typeof(BurstCompatibleComponentData)})]
    public T GetSingleton<T>()
        where T : struct, IComponentData
    Returns
    Type Description
    T

    A copy of the singleton component.

    Type Parameters
    Name Description
    T

    The component type.

    Remarks

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

    Exceptions
    Type Condition
    InvalidOperationException
    See Also
    SetSingleton<T>(T)
    GetSingletonEntity()
    GetSingleton<T>()
    In This Article
    • GetSingleton<T>()
    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