docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Method IsComponentEnabled

    IsComponentEnabled(Entity, ComponentType)

    Checks whether a given ComponentType is enabled on the specified Entity.

    Declaration
    public bool IsComponentEnabled(Entity entity, ComponentType componentType)
    Parameters
    Type Name Description
    Entity entity

    The entity whose component should be checked.

    ComponentType componentType

    The component type to enable or disable. This type must implement the IEnableableComponent interface.

    Returns
    Type Description
    bool

    True if the specified component is enabled, or false if it is disabled.

    Remarks

    An entity with a disabled component will not match an EntityQuery that requires that component, and will match a query that excludes that component.

    Exceptions
    Type Condition
    ArgumentException

    The Entity does not exist.

    See Also
    SetComponentEnabled(Entity, ComponentType, bool)
    IsComponentEnabled(Entity)

    IsComponentEnabled<T>(Entity)

    Checks whether a given ComponentType is enabled on the specified Entity.

    Declaration
    [GenerateTestsForBurstCompatibility(GenericTypeArguments = new Type[] { typeof(BurstCompatibleEnableableComponent) })]
    public bool IsComponentEnabled<T>(Entity entity) where T : IEnableableComponent
    Parameters
    Type Name Description
    Entity entity

    The entity whose component should be checked.

    Returns
    Type Description
    bool

    True if the specified component is enabled, or false if it is disabled.

    Type Parameters
    Name Description
    T

    The component type whose enabled status should be checked. This type must implement the IEnableableComponent interface.

    Remarks

    An entity with a disabled component will not match an EntityQuery that requires that component, and will match a query that excludes that component.

    Exceptions
    Type Condition
    ArgumentException

    The Entity does not exist.

    See Also
    SetComponentEnabled<T>(Entity, bool)
    IsComponentEnabled(Entity)

    Did you find this page useful? Please give it a rating:

    Thanks for rating this page!

    Report a problem on this page

    What kind of problem would you like to report?

    • This page needs code samples
    • Code samples do not work
    • Information is missing
    • Information is incorrect
    • Information is unclear or confusing
    • There is a spelling/grammar error on this page
    • Something else

    Thanks for letting us know! This page has been marked for review based on your feedback.

    If you have time, you can provide more information to help us fix the problem faster.

    Provide more information

    You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:

    You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:

    You've told us there is information missing from this page. Please tell us more about what's missing:

    You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:

    You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:

    You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:

    You've told us this page has a problem. Please tell us more about what's wrong:

    Thank you for helping to make the Unity documentation better!

    Your feedback has been submitted as a ticket for our documentation team to review.

    We are not able to reply to every ticket submitted.

    In This Article
    • IsComponentEnabled(Entity, ComponentType)
    • IsComponentEnabled<T>(Entity)
    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)