Effects

With one pattern

[local] effect <pattern>:
  usable in:
    # events, optional
  parse:
    # code, optional
  trigger:
    # code, required

With multiple patterns

[local] effect:
  usable in:
    # events, optional
  patterns:
    # patterns, one per line
  parse:
    # code, optional
  trigger:
    # code, required

Flag local

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

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

Section usable in

Each entry in this section should be either an imported class or a custom event (syntax: custom event %string%).

This condition will error if it is used outside of all the given events.

Section parse

Code in this section is executed whenever the effect is parsed. This section may be used to emit errors if the effect 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.

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

Section trigger

The code in this section is executed whenever the effect is run. You can delay the execution of this effect with the following syntax:

delay [the] [current] effect

After the delay effect has been run, you can use delays in this section. If you're done using delays, you can use the continue effect to continue the execution.