Effects

Last updated 5 months ago
With one pattern
With multiple patterns
Syntax
[local] effect <pattern>:
parse:
# code, optional
trigger:
# code, required
Syntax
[local] effect:
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 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.

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

Section trigger