Skip to content

UGantryExperienceStage_SettingsPages

ClassGantrySettingsBlueprint-visibleshown as “Add Settings Pages”
#include "GantryExperienceStage_SettingsPages.h"

Gives every local player these settings pages while the experience is active.

This is how a game mode or a DLC pack brings settings of its own without the game listing them. Add the stage to the experience and list the page assets under Pages, and any settings providers under Providers. Players who join later, such as a second split-screen player, get the pages too. Players who leave lose them.

The stage is Client Only by default, since a dedicated server has no players. The pages and provider classes load as a tracked load, so a loading screen can show them.

Inherits
UGantryExperienceStage_LocalPlayers

Properties

PropertyTypeDefaultDescription
Pages read-onlyTArray<TSoftObjectPtr<UGantrySettingsPage> >

Settings page assets every local player has while the experience is active.

Providers read-onlyTArray<TSoftClassPtr<UGantrySettingsProvider> >

Settings providers that build pages in code for every local player while the experience is active.

C++

Public C++ members that Blueprint does not see.

GetStageDisplayName_Implementation

virtual FString UGantryExperienceStage_SettingsPages::GetStageDisplayName_Implementation() const override

"Settings pages".

BeginStage

virtual void UGantryExperienceStage_SettingsPages::BeginStage(const FGantryExperienceStageContext &Context, FOnStageFinished OnFinished) override

Loads the pages and providers, then adds them for every local player.

EndStage

virtual void UGantryExperienceStage_SettingsPages::EndStage(const FGantryExperienceStageContext &Context) override

Removes them from every player it added them for.