UGameplayStatics::SetSubtitlesEnabled
#include "Kismet/GameplayStatics.h"
Access: public
Specifiers: staticUFUNCTIONBlueprintCallable
Description
Globally enables or disables subtitle rendering for all dialogue and sound waves that carry subtitle data. Affects all players in the session.
Caveats & Gotchas
- • This is a global flag affecting all local players simultaneously; it is not per-player and is not replicated to other machines in a multiplayer session.
- • The setting is not persisted between sessions by default — you must save and restore it from your game's settings save object if you want it to survive restarts.
- • Subtitles are only shown for sounds that have subtitle data authored in their SoundWave asset; calling this function has no effect on sounds without subtitle tracks.
Signature
static ENGINE_API void SetSubtitlesEnabled(bool bEnabled) Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| bEnabled | bool | Pass true to enable subtitle display, false to disable it. | — |
Return Type
void Example
Apply subtitle setting from game settings C++
UMyGameUserSettings* Settings = Cast<UMyGameUserSettings>(GEngine->GetGameUserSettings());
if (Settings)
{
UGameplayStatics::SetSubtitlesEnabled(Settings->bSubtitlesEnabled);
} Tags
Version History
Introduced in: 4.0
| Version | Status | Notes |
|---|---|---|
| 5.6 | stable | — |
Feedback
Was this helpful?