class
FMixSnapshotSystem
- Module
- Narrative
- Header
#include "Narrative/MixSnapshotSystem.h"- Namespace
Mowo
Constructors
| Signature | Name | Description |
|---|---|---|
FMixSnapshotSystem() | FMixSnapshotSystem | Both out-of-line: the per-bus filters are Ref<LowPassEffect> and the header only forward-declares the effect. |
~FMixSnapshotSystem() override | ~FMixSnapshotSystem | |
FMixSnapshotSystem(const FMixSnapshotSystem&) = delete | FMixSnapshotSystem |
Public functions
| Returns | Name | Description |
|---|---|---|
FMixSnapshotSystem& | operator= | |
SystemPhase | GetPhase | |
void | Initialize | |
void | Update | |
void | Shutdown | |
void | SetScene | |
int32_t | Push | durationSeconds > 0 makes the entry timed — it pops itself when the timer runs out. |
int32_t | PushAsset | |
bool | Pop | |
bool | PopById | Pops the most recently pushed entry carrying that id. |
void | PopAll | |
int32_t | GetStackSize | |
std::string | GetActiveSnapshotId | |
int32_t | GetActivePriority | |
bool | IsPushed | |
bool | IsHandleLive | |
float | GetRemainingSeconds | |
float | GetBusVolume | |
float | GetBusLowPass | |
float | GetBusTargetVolume | |
float | GetBusTargetLowPass | |
void | SetBaseBusVolume | The player's configured level for a bus — what the mix returns to with an empty stack. |
float | GetBaseBusVolume | |
void | CaptureBaseBusVolumes | |
void | SetDialogueSnapshot | Built-in snapshots. |
void | SetVoiceSnapshot | |
void | SetPauseSnapshot | |
void | NotifyDialogueActive | |
void | NotifyVoiceActive | |
void | NotifyPaused | |
bool | IsDialogueDucking | |
bool | IsVoiceDucking | |
bool | IsPauseSnapshotActive | |
FMixSnapshotSystem* | GetActive | |
bool | ResolveHudSource |
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() overrideFMixSnapshotSystem
C++
FMixSnapshotSystem(const FMixSnapshotSystem&) = deleteoperator=
C++
FMixSnapshotSystem& operator=(const FMixSnapshotSystem&) = deleteGetPhase
C++
SystemPhase GetPhase() const overrideInitialize
C++
void Initialize(World* world) overrideUpdate
C++
void Update(float deltaTime) overrideShutdown
C++
void Shutdown() overrideSetScene
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() constGetActiveSnapshotId
C++
std::string GetActiveSnapshotId() constGetActivePriority
C++
int32_t GetActivePriority() constIsPushed
C++
bool IsPushed(const std::string& snapshotId) constIsHandleLive
C++
bool IsHandleLive(int32_t handle) constGetRemainingSeconds
C++
float GetRemainingSeconds(int32_t handle) constGetBusVolume
C++
float GetBusVolume(AudioBus bus) constGetBusLowPass
C++
float GetBusLowPass(AudioBus bus) constGetBusTargetVolume
C++
float GetBusTargetVolume(AudioBus bus) constGetBusTargetLowPass
C++
float GetBusTargetLowPass(AudioBus bus) constSetBaseBusVolume
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) constCaptureBaseBusVolumes
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() constIsVoiceDucking
C++
bool IsVoiceDucking() constIsPauseSnapshotActive
C++
bool IsPauseSnapshotActive() constGetActive
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