Goals triggers¶
Goal completed¶
Runs when a goal reaches its last step.
| Setting | What to put in |
|---|---|
| Goal | Only for this goal. Leave it empty for every goal. |
Variables you get
| Variable | What it holds |
|---|---|
%goal% |
The goal's name |
%points% |
The goal's points |
%stepCount% |
How many steps there are |
Type id: goals.completed
Goal points added¶
Runs every time points are added to (or taken from) a goal.
| Setting | What to put in |
|---|---|
| Goal | Only for this goal. Leave it empty for every goal. |
Variables you get
| Variable | What it holds |
|---|---|
%goal% |
The goal's name |
%goalId% |
The goal's internal id |
%points% |
The goal's points now |
%added% |
Points added (negative when taken away) |
%user% |
Who added them (empty when added by hand) |
%platform% |
Their platform |
%reason% |
What added them, like Subscription, Cheer or Manual |
%nextStep% |
The name of the next step (empty when every step is reached) |
%nextStepPoints% |
The points the next step needs |
%pointsToNext% |
How many more points the next step needs |
%stepsReached% |
How many steps are reached |
%stepCount% |
How many steps there are |
%multiplier% |
The goal's multiplier |
Type id: goals.pointsAdded
Goal step reached¶
Runs once when a goal reaches one of its steps, like "New emote" at 10 points. Each step runs it only once, even if points go down and up again (until the goal is reset). Good for an alert or a chat message.
| Setting | What to put in |
|---|---|
| Goal | Only for this goal. Leave it empty for every goal. |
Variables you get
| Variable | What it holds |
|---|---|
%goal% |
The goal's name |
%step% |
The step's name, like New emote |
%stepPoints% |
The points the step needed |
%stepNumber% |
Which step it is (1 = the first) |
%stepCount% |
How many steps there are |
%points% |
The goal's points now |
%user% |
Whose purchase reached it |
%platform% |
Their platform |
%nextStep% |
The name of the next step (empty when this was the last) |
%nextStepPoints% |
The points the next step needs |
Type id: goals.stepReached