AudioDynamicMixState

Class Documentation

A mix state: one state of a state group of the audio engine, which the client can switch to while the game runs. Every loaded object registers itself with the client's mix state manager. Once per frame the manager picks one object and applies it: it sets the state group named MixGroup to the state named MixState.

A contextual action, ContextualActionNotifyMixAction, requests a mix state. The request records the game time and a duration in seconds.

The manager picks the state in this order:

While the current state has been applied for less than 0x2763e30e seconds, the manager changes nothing.
A state is a candidate when isDefault is set, or when it has a request whose time is not over. A request is over max(duration, 0x2763e30e) seconds after it was made.
The candidate with the highest priority wins. If it is the current state, nothing happens. Otherwise the manager applies it and clears the requests of all states, the new state's own request included.

Two consequences follow from the last step:

A state that is not the current state stays applied for only 0x2763e30e seconds after its request, because applying it clears the request. Then the manager goes back to the best default state.
A request for the state that is already current keeps it for the whole duration of the request.

The manager keeps one current state for all state groups together, not one per group. It never resets a state group. If no state has isDefault, the last applied state stays set in the audio engine.

Properties

0x2763e30e

F32 = 1

Documentation Edit documentation

Minimum hold, in seconds of game time. After the client applies this state, it does not pick another state for this long. It is also the minimum duration of a request for this state.

0x5cf98a21

String = ""

Removed in 16.20

Documentation Edit documentation

Removed from current builds.

0xea42217

F32 = -3.4028234663852886e+38

16.20

Documentation Edit documentation

Read-only value that the client computes: the time left on the state's request, in seconds. It is 0 when the state has no live request. A value written in a bin is not stored.

DefaultLingerTime

F32 = 3

16.20

Documentation Edit documentation

Duration of a request, in seconds of game time, when the requesting action sets no OverrideLingerTime.

LingerTime

F32 = 3

Removed in 16.20

Documentation Edit documentation

Removed from current builds. DefaultLingerTime has its role.

MixGroup

String = ""

16.20

Documentation Edit documentation

The name of the state group in the audio engine.

MixState

String = ""

16.20

Documentation Edit documentation

The name of the state, inside MixGroup, that the client sets when it applies this object.

RtpcValue

F32 = 0

Removed in 16.20

Documentation Edit documentation

Removed from current builds.

isDefault

Bool = false

Documentation Edit documentation

Makes the state a candidate at all times, without a request. The client applies the default state with the highest priority when no request is live, starting with the first update after load.

objectPath

Hash = "0x0"

Documentation Add documentation

No documentation available yet. Click "Add documentation" to contribute!

priority

U32 = 50

Documentation Edit documentation

Rank among the candidates. The highest value wins.

Referenced by 1 class · 1 property

ContextualActionNotifyMixAction MixState Link<AudioDynamicMixState>