docs.unity.cn
    Show / Hide Table of Contents

    Method HasSingleton

    HasSingleton<T>()

    Checks whether a singelton component of the specified type exists. Note that if querying a singleton component from a system-associated entity, the query must include either EntityQueryOptions.IncludeSystems or the SystemInstance component.

    Declaration
    [GenerateTestsForBurstCompatibility(GenericTypeArguments = new Type[]{typeof(BurstCompatibleComponentData)})]
    public bool HasSingleton<T>()
    Returns
    Type Description
    Boolean

    True, if a singleton is found to match exactly once with the specified typeEntityQuery.

    Type Parameters
    Name Description
    T

    The IComponentData subtype of the singleton component. This component type must not implement IEnableableComponent

    Exceptions
    Type Condition
    InvalidOperationException

    Thrown if the number of entities that match this query is greater than one.

    Back to top Copyright © 2023 Unity Technologies — Terms of use
    Generated by DocFX
    on Wednesday, September 20, 2023