docs.unity.cn
    Show / Hide Table of Contents

    Method SetComponentEnabled

    SetComponentEnabled(SystemHandle, Boolean)

    Enable or disable the IComponentData of type T on the specified system using a SystemHandle. This operation does not cause a structural change (even if it occurs on a worker thread), or affect the value of the component. For the purposes of EntityQuery matching, a system with a disabled component will behave as if it does not have that component. The type T must implement the IEnableableComponent interface.

    Declaration
    public void SetComponentEnabled(SystemHandle systemHandle, bool value)
    Parameters
    Type Name Description
    SystemHandle systemHandle

    The system whose component should be enabled or disabled.

    Boolean value

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

    Exceptions
    Type Condition
    ArgumentException

    The SystemHandle does not exist.

    See Also
    IsComponentEnabled(SystemHandle)

    SetComponentEnabled(Entity, Boolean)

    Enable or disable the IComponentData of type T on the specified Entity. This operation does not cause a structural change (even if it occurs on a worker thread), or affect the value of the component. For the purposes of EntityQuery matching, an entity with a disabled component will behave as if it does not have that component. The type T must implement the IEnableableComponent interface.

    Declaration
    public void SetComponentEnabled(Entity entity, bool value)
    Parameters
    Type Name Description
    Entity entity

    The entity whose component should be enabled or disabled.

    Boolean value

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

    Exceptions
    Type Condition
    ArgumentException

    The Entity does not exist.

    See Also
    IsComponentEnabled(Entity)
    Back to top Copyright © 2023 Unity Technologies — Terms of use
    Generated by DocFX
    on Wednesday, June 21, 2023