One rule of a ContextualSituation: a list of conditions
and up to one action of each kind. A rule triggers audio, animation or situation events.
It runs unconditionally when the situation occurs, or only when its mConditions pass.
The conditions are listed on the IContextualCondition
page.
Each action kind picks its own rule from the situation (ContextualSituation describes the choice). For one kind, a rule is valid when all of these hold:
ContextualActionPlayAudio.mMaxOccurences).
Only audio actions have a limit.mConditionRelationship.After the client picks a rule for the audio action, it checks these gates in order. A
rule whose ActiveVoiceOver is false skips all of them.
MarkerTriggeredNearby), the rule fails.CanStompSelf is false and the line of this rule is playing, the rule fails.mOverrideCacCooldown or
CooldownModifications.IgnoreTimer, the rule fails while the unit's timer shows
ContextualActionData.mCooldown seconds or less.If the chosen rule fails a gate, the situation plays no voice line.
mPriority does not choose between rules, and it does not choose between situations. It
decides whether a new voice line may stomp (interrupt) the line that plays on the
unit:
| Case | Result |
|---|---|
mPriority unset, or StompLowerPriority is false |
the rule fails while a line plays on the unit or a line is queued |
a rule's line plays with priority q (unset counts as 0), and mPriority < q |
the rule fails |
a rule's line plays with priority q, and mPriority >= q |
the new line stomps the playing line |
no rule's line plays, and mPriority is negative |
the rule waits as if mPriority were unset |
When the audio action of the chosen rule sets mWaitForAnnouncerQueue, the client first
removes every queued line whose rule priority is not higher than this rule's priority.
A stomped line counts as ended for the situation cooldown.
mOverrideCacCooldown and ContextualActionCooldownModifications
change how the rule interacts with the shared cooldown of
ContextualActionData. A per-rule cooldown is a
condition: ContextualConditionRuleCooldown.
Bool = true Marks the voice line as the unit's active voice line. When it is true, the rule
passes the voice line gates above, its line becomes the line that plays on the unit,
and the end of the line starts the situation cooldown, the rule cooldown and the
shared cooldown timer.
When it is false, the line skips the voice line gates and does not become the
playing line. It starts no cooldown, and other rules do not wait for it.
Bool = false Allows the rule to stomp its own playing line. When it is false, the rule fails while its own line plays.
F32 = 1 Weight of the rule when ContextualSituation.mChooseRandomValidRule is true. The
chance of the rule is its weight divided by the sum of the weights of all valid rules.
A rule with weight 0 is not picked, unless every valid rule has weight 0: then each
has an equal chance. In first-valid mode the client ignores it.
Finer control of the shared cooldown, as a ContextualActionCooldownModifications: skip the check, keep the timer, or both.
The mix state that the rule requests, a ContextualActionNotifyMixAction.
The user fact that the rule records, a ContextualActionUserFactAction.
Bool = true Allows the line to stomp a playing line of lower or equal priority. When it is false, the rule fails while any line plays on the unit or a line is queued.
The announcer event of the rule, a ContextualActionAnnouncerVoEvent.
The champion music event of the rule, a ContextualActionChampionMusicEvent.
The animation of the rule, a ContextualActionPlayAnimation. It runs only from the situations that IContextualAction lists.
The voice line of the rule, a ContextualActionPlayAudio. Shipped data uses ContextualActionPlayVO.
U32 = 0 How the conditions in mConditions combine.
| Value | Name | Passes when | Empty list |
|---|---|---|---|
0 |
And | every condition passes; evaluation stops at the first failure | passes |
| any other value | Or | at least one condition passes; evaluation stops at the first success | fails |
The conditions of the rule, as IContextualCondition objects. A null entry is skipped.
Bool = false Exempts the rule from the shared cooldown (ContextualActionData.mCooldown). The rule
skips the check, and the end of its line does not restart the timer.
Option<I32> = null Priority of the voice line for stomping, as described above. A higher value stomps a lower one. When it is unset, the line never stomps and waits for the playing line and the queue.
The situation that the rule fires, a ContextualActionTriggerEvent. It runs only from the situations that IContextualAction lists.