The conditional tweet functionality works by specifying a condition to generate
a tweet, and the tweet text. Both the condition and tweet can contain "format
specifiers" (similar to
printf's
format specifiers).
The condition format must be:
<format specifier>[comparator][value] [...repeat...]
The initial format specifier is required, and it indicates which event to trigger
on. You can optionally also specify a comparator from the comparator list below,
and a value to compare to. You can also specify more format specifiers and values
to further restrict when a conditional tweet is triggered. The condition is only
checked when the event occurs for the initial format specifier, and the tweet
is only sent when the condition evaluates as true. If a format specifier is
provided without any comparator (and value), it is considered true for the
purposes of verifying the condition.
The
comparator can be one of:
- = : True if the event value equals the provided value
- != : True if the event value is not equal to the provided value
- < : True if the event value is less than the provided value
- <= : True if the event value is less than or equal to the provided value
- > : True if the event value is greater than the provided value
- >= : True if the event value is greater than or equal to the provided value
- % : True if the event value mod the provided value is zero
Note that the % comparator is essentially an "every Nth" operator;
for example if you use %5 then the condition will be true only when the
event value is 5, 10, 15, 20, 25, etc.
The tweet format has no restrictions. You can provide format specifiers
in the tweet, which will be replaced by the actual current scoreboard values
before sending the tweet.
Here is the current list of format specifiers that you can use: