Skip to content

Rule

Written by: Alian713, Kramb


1. xsDisableRule

Returning Type: void

Prototype: void xsDisableRule(string ruleName)

Parameters:

  1. string ruleName: The name of the rule to disable

Disables the given rule.

2. xsDisableSelf

Returning Type: void

Prototype: void xsDisableSelf()

Disables the rule this function is called inside. Cannot be used outside of a rule's body!

3. xsEnableRule

Returning Type: void

Prototype: void xsEnableRule(string ruleName)

Parameters:

  1. string ruleName: The name of the rule to enable

Enables the given rule.

4. xsIsRuleEnabled

Returning Type: bool

Prototype: bool xsIsRuleEnabled(string ruleName)

Parameters:

  1. string ruleName: The name of the rule to check

Returns true if the rule is enabled, else returns false.

5. xsSetRulePriority

Returning Type: void

Prototype: void xsSetRulePriority(string ruleName, int rulePriority)

Parameters:

  1. string ruleName: The name of the rule to set the priority of
  2. int rulePriority: The new priority of the rule

Sets the priority of the given rule.

6. xsSetRulePrioritySelf

Returning Type: void

Prototype: void xsSetRulePrioritySelf(int rulePriority)

Parameters:

  1. int rulePriority: The new priority of the rule

Sets the priority of the rule this function is called inside. Cannot be used outside of a rule's body!

7. xsSetRuleMinInterval

Returning Type: void

Prototype: void xsSetRuleMinInterval(string ruleName, int interval)

Parameters:

  1. string ruleName: The name of the rule to set the min interval of
  2. int interval: The new min interval of the rule

Sets the min interval of the given rule.

8. xsSetRuleMinIntervalSelf

Returning Type: void

Prototype: void xsSetRuleMinIntervalSelf(int interval)

Parameters:

  1. int interval: The new min interval of the rule

Sets the min interval of the rule this function is called inside. Cannot be used outside of a rule's body!

9. xsSetRuleMaxInterval

Returning Type: void

Prototype: void xsSetRuleMaxInterval(string ruleName, int interval)

Parameters:

  1. string ruleName: The name of the rule to set the max interval of
  2. int interval: The new max interval of the rule

Sets the max interval of the given rule.

10. xsSetRuleMaxIntervalSelf

Returning Type: void

Prototype: void xsSetRuleMaxIntervalSelf(int interval)

Parameters:

  1. int interval: The new max interval of the rule

Sets the max interval of the rule this function is called inside. Cannot be used outside of a rule's body!

11. xsEnableRuleGroup

Returning Type: void

Prototype: void xsEnableRuleGroup(string ruleGroupName)

Parameters:

  1. string ruleGroupName: The name of the rule group to enable

Enables all the rules in the given rule group

12. xsDisableRuleGroup

Returning Type: void

Prototype: void xsDisableRuleGroup(string ruleGroupName)

Parameters:

  1. string ruleGroupName: The name of the rule group to disable

Disables all the rules in the given rule group

13. xsIsRuleGroupEnabled

Returning Type: bool

Prototype: bool xsIsRuleGroupEnabled(string ruleGroupName)

Parameters:

  1. string ruleGroupName: The name of the rule group to check

Returns true, if all the rules in the given rule group are enabled