class

FPlatformOverlay

Applies that policy to the online-service seam's overlay notification.

Module
Game
Header
#include "Game/PlatformOverlay.h"
Namespace
Mowo

Every effect goes through an injected hook. The pause target is not the same object in a packaged runtime and in a PIE session, and the part that can actually be wrong is the state machine — it has to survive a repeated open, a close with no matching open, and a close after the player paused the game themselves, without ever restoring state the game has since taken over.

Type aliases

AliasDescription
using FBoolQuery = std::function<bool()>
using FBoolSink = std::function<void(bool)>
using FFloatQuery = std::function<float()>
using FFloatSink = std::function<void(float)>

Constructors

SignatureNameDescription
FPlatformOverlay(const FPlatformOverlay&) = deleteFPlatformOverlay

Public functions

ReturnsNameDescription
FPlatformOverlay&Get
FPlatformOverlay&operator=
voidInstallBinds the handler to FOnlineServices and installs the default hooks (FTime pause, InputManager cursor, AudioEngine master volume) for any hook the host has not already replaced.
boolIsInstalled
voidSetPolicy
const FPlatformOverlayPolicy&GetPolicy
voidSetPauseHooks
voidSetMouseCaptureHooks
voidSetAudioHooks
voidSetMultiplayerQueryTrue while the session has remote peers.
voidOnOverlayActivatedThe transition.
boolIsOverlayActive
boolDidPauseWorldWhat the handler is currently holding, so a host (and the self-test) can tell an overlay-driven pause from a game-driven one.
boolDidReleaseMouse
boolDidChangeAudio
floatGetRestoreVolume
voidResetDrops every hook and clears the held state without restoring it — for a test that wants a clean handler, and for a host tearing its world down under an open overlay.

Function details

FPlatformOverlay

C++
FPlatformOverlay(const FPlatformOverlay&) = delete

Get

C++
static FPlatformOverlay& Get()

operator=

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

Install

C++
void Install()

Binds the handler to FOnlineServices and installs the default hooks (FTime pause, InputManager cursor, AudioEngine master volume) for any hook the host has not already replaced. Safe with no platform up: the seam's default is a no-op and nothing ever fires.

IsInstalled

C++
bool IsInstalled() const

SetPolicy

C++
void SetPolicy(const FPlatformOverlayPolicy& policy)

GetPolicy

C++
const FPlatformOverlayPolicy& GetPolicy() const

SetPauseHooks

C++
void SetPauseHooks(FBoolQuery isPaused, FBoolSink setPaused)

SetMouseCaptureHooks

C++
void SetMouseCaptureHooks(FBoolQuery isCaptured, FBoolSink setCaptured)

SetAudioHooks

C++
void SetAudioHooks(FFloatQuery getMasterVolume, FFloatSink setMasterVolume)

SetMultiplayerQuery

C++
void SetMultiplayerQuery(FBoolQuery isMultiplayer)

True while the session has remote peers. A networked world keeps running with the overlay up — the other players are still in it and there is no pause to hand them.

OnOverlayActivated

C++
void OnOverlayActivated(bool active)

The transition. Idempotent per edge: a second true changes nothing, and a false with no open before it restores nothing.

IsOverlayActive

C++
bool IsOverlayActive() const

DidPauseWorld

C++
bool DidPauseWorld() const

What the handler is currently holding, so a host (and the self-test) can tell an overlay-driven pause from a game-driven one.

DidReleaseMouse

C++
bool DidReleaseMouse() const

DidChangeAudio

C++
bool DidChangeAudio() const

GetRestoreVolume

C++
float GetRestoreVolume() const

Reset

C++
void Reset()

Drops every hook and clears the held state without restoring it — for a test that wants a clean handler, and for a host tearing its world down under an open overlay.

Generated from Game/PlatformOverlay.h via game.json · Nov 5, 2026Version 1.0.0