class

FMixSnapshotSystem

Module
Narrative
Header
#include "Narrative/MixSnapshotSystem.h"
Namespace
Mowo

Constructors

SignatureNameDescription
FMixSnapshotSystem()FMixSnapshotSystemBoth out-of-line: the per-bus filters are Ref<LowPassEffect> and the header only forward-declares the effect.
~FMixSnapshotSystem() override~FMixSnapshotSystem
FMixSnapshotSystem(const FMixSnapshotSystem&) = deleteFMixSnapshotSystem

Public functions

ReturnsNameDescription
FMixSnapshotSystem&operator=
SystemPhaseGetPhase
voidInitialize
voidUpdate
voidShutdown
voidSetScene
int32_tPushdurationSeconds > 0 makes the entry timed — it pops itself when the timer runs out.
int32_tPushAsset
boolPop
boolPopByIdPops the most recently pushed entry carrying that id.
voidPopAll
int32_tGetStackSize
std::stringGetActiveSnapshotId
int32_tGetActivePriority
boolIsPushed
boolIsHandleLive
floatGetRemainingSeconds
floatGetBusVolume
floatGetBusLowPass
floatGetBusTargetVolume
floatGetBusTargetLowPass
voidSetBaseBusVolumeThe player's configured level for a bus — what the mix returns to with an empty stack.
floatGetBaseBusVolume
voidCaptureBaseBusVolumes
voidSetDialogueSnapshotBuilt-in snapshots.
voidSetVoiceSnapshot
voidSetPauseSnapshot
voidNotifyDialogueActive
voidNotifyVoiceActive
voidNotifyPaused
boolIsDialogueDucking
boolIsVoiceDucking
boolIsPauseSnapshotActive
FMixSnapshotSystem*GetActive
boolResolveHudSource

Function details

FMixSnapshotSystem

C++
FMixSnapshotSystem()

Both out-of-line: the per-bus filters are Ref<LowPassEffect> and the header only forward-declares the effect.

~FMixSnapshotSystem

C++
~FMixSnapshotSystem() override

FMixSnapshotSystem

C++
FMixSnapshotSystem(const FMixSnapshotSystem&) = delete

operator=

C++
FMixSnapshotSystem& operator=(const FMixSnapshotSystem&) = delete

GetPhase

C++
SystemPhase GetPhase() const override

Initialize

C++
void Initialize(World* world) override

Update

C++
void Update(float deltaTime) override

Shutdown

C++
void Shutdown() override

SetScene

C++
void SetScene(Scene* scene)

Push

C++
int32_t Push(const std::string& idOrPath, float durationSeconds = 0.0f)

durationSeconds > 0 makes the entry timed — it pops itself when the timer runs out. Returns 0 when the snapshot could not be resolved.

PushAsset

C++
int32_t PushAsset(const Ref<MixSnapshotAsset>& asset, float durationSeconds = 0.0f)

Pop

C++
bool Pop(int32_t handle)

PopById

C++
bool PopById(const std::string& snapshotId)

Pops the most recently pushed entry carrying that id.

PopAll

C++
void PopAll()

GetStackSize

C++
int32_t GetStackSize() const

GetActiveSnapshotId

C++
std::string GetActiveSnapshotId() const

GetActivePriority

C++
int32_t GetActivePriority() const

IsPushed

C++
bool IsPushed(const std::string& snapshotId) const

IsHandleLive

C++
bool IsHandleLive(int32_t handle) const

GetRemainingSeconds

C++
float GetRemainingSeconds(int32_t handle) const

GetBusVolume

C++
float GetBusVolume(AudioBus bus) const

GetBusLowPass

C++
float GetBusLowPass(AudioBus bus) const

GetBusTargetVolume

C++
float GetBusTargetVolume(AudioBus bus) const

GetBusTargetLowPass

C++
float GetBusTargetLowPass(AudioBus bus) const

SetBaseBusVolume

C++
void SetBaseBusVolume(AudioBus bus, float volume)

The player's configured level for a bus — what the mix returns to with an empty stack.

GetBaseBusVolume

C++
float GetBaseBusVolume(AudioBus bus) const

CaptureBaseBusVolumes

C++
void CaptureBaseBusVolumes()

SetDialogueSnapshot

C++
void SetDialogueSnapshot(const std::string& idOrPath)

Built-in snapshots. Assigning an empty id disables that hook.

SetVoiceSnapshot

C++
void SetVoiceSnapshot(const std::string& idOrPath)

SetPauseSnapshot

C++
void SetPauseSnapshot(const std::string& idOrPath)

NotifyDialogueActive

C++
void NotifyDialogueActive(bool active)

NotifyVoiceActive

C++
void NotifyVoiceActive(bool active)

NotifyPaused

C++
void NotifyPaused(bool paused)

IsDialogueDucking

C++
bool IsDialogueDucking() const

IsVoiceDucking

C++
bool IsVoiceDucking() const

IsPauseSnapshotActive

C++
bool IsPauseSnapshotActive() const

GetActive

C++
static FMixSnapshotSystem* GetActive()

ResolveHudSource

C++
static bool ResolveHudSource(const std::string& source, std::string& outText, double& outNumber, bool& outIsNumber)
Generated from Narrative/MixSnapshotSystem.h via narrative.json · Oct 26, 2026Version 1.0.0