WaitForShopkeeperVo
Bool 15.14
Queues the line while any shopkeeper plays a voice line.
ContextualActionPlayAudio
Interface
Inheritance 1 ancestor · 6 siblings · 1 descendant
Class Documentation
Edit documentationA voice line action: the audio action of a ContextualRule. It chooses an audio event name for the viewer and plays it on the unit. Only ContextualActionPlayVO plays a line: shipped data uses that class for every audio action.
Event name
Each client chooses the name for its own player:
| Viewer | Name used |
|---|---|
| no champion (a spectator) | mSpectatorEventName |
| the viewer's champion is the unit | mSelfEventName |
| the viewer's champion is on the unit's team | mAllyEventName |
| the viewer's champion is on another team | mEnemyEventName |
If the chosen name is empty, the action fails and this viewer hears no line.
Queue
A line can wait in the unit's queue instead of playing at once. The component checks the
queue every second and plays a queued line when it can. A queued line expires
mWaitTimeout seconds after it was queued.
Properties
mAllyEventName
String The audio event name for players on the unit's team.
mAuxBusName
String The name of an auxiliary audio bus that the client passes with the line.
mEnemyEventName
String The audio event name for players on another team.
mMaxOccurences
U32 16.10
Maximum number of successful plays of this action per unit per game. When the count
reaches the value, the rule is no longer valid for the audio action, so the next valid
rule of the situation can play. 0 means no limit. The count is not reset during the game.
mResolveEventAsTarget
Bool Plays the line through the voice state of the other unit of the situation instead of the owner's (see ICharacterSubcondition for the other unit). If the situation has no other unit, the action fails.
mResolveEventUsingStolenLines
Bool Plays the line through the owner's voice state for lines taken from another champion. If the owner has no such state, the action fails.
mSelfEventName
String The audio event name for the player whose champion is the unit.
mSpectatorEventName
String The audio event name for a viewer without a champion.
mWaitForAnnouncerQueue
Bool Queues the line instead of playing it when the game has no announcer, when the
announcer is speaking, or when the situation is one of OwnerDeath, KillChampion,
NearbyChampionDeath, NearbyEnemyKilledChampion, GotFirstBlood and
OnFirstBlood.
When the rule of this action is chosen, the client also removes every queued line whose rule priority is not higher than the priority of this rule.
mWaitTimeout
F32 Time, in seconds, that a queued line waits before it expires. A value of 0 or less
makes the line wait without limit.