docs.unity3d.com
    Show / Hide Table of Contents

    Method TryGetSingleton

    TryGetSingleton<T>(out T)

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

    Declaration
    public bool TryGetSingleton<T>(out T value)
        where T : struct, IComponentData
    Parameters
    Type Name Description
    T value
    Returns
    Type Description
    Boolean

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

    Type Parameters
    Name Description
    T

    The IComponentData subtype of the singleton component.

    In This Article
    • TryGetSingleton<T>(out T)
    Back to top
    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