Conditions

With one pattern

Syntax

[local] condition <pattern>:
  parse:
    # code, optional
  check:
    # code, required

With multiple patterns

Property condition

Flag local

Specifying that a condition is local makes the condition only usable from within the script that it is defined in. This allows you to create condition that do not interfere with conditions from other addons or scripts.

Local conditions are guaranteed to be parsed before other custom conditions, but not necessarily before conditions from other addons.

Section parse

Code in this section is executed whenever the condition is parsed. This section may be used to emit errors if the condition is used in an improper context.

If this section is included, you must also continue if the effect was parsed successfully.

Local variables created in this section are copied by-value to other sections.

example.sk

condition example:
  parse:
    set {_test} to 1
  check:
    # {_test} always starts at 1 here
    add 1 to {_test}
    # 2 is always broadcast
    broadcast "%{_test}%"

Section check

Code in this section is executed whenever the condition is checked. This section must continue if the condition is met. The section may exit without continuing if the condition fails.