Function clearEffect

  • clearEffect(entity, effectType): void

  • Wrapper function for removing effect(s) or effect group.

    Parameters

    • entity: Entity

      The entity to be removed effect.

    • effectType:
          | string
          | string[]
          | EffectType
          | EffectType[]
          | EffectGroups

      The effect(s) to remove, use EffectGroups to remove group effects.

    Returns void

    Throws

    — This function can throw errors.

Settings

Member Visibility