docs.unity3d.com
Search Results for

    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
    [Obsolete("Use SystemAPI.TryGetSingleton instead (RemovedAfter Entities 1.0)")]
    public bool TryGetSingleton<T>(out T value) where T : unmanaged, IComponentData
    Parameters
    Type Name Description
    T value

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

    Returns
    Type Description
    bool

    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. 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)