AGameStateBase

class Engine Since 4.14

#include "GameFramework/GameStateBase.h"

Access: public Specifiers: UCLASS

Description

Replicated actor that holds authoritative game state visible to all clients — the client-accessible counterpart to `AGameModeBase`. Contains `PlayerArray` (all connected `APlayerState` objects) and exposes server time. Subclass to add replicated match score, round number, team data, or any state clients need to read.

Caveats & Gotchas

• Unlike GameMode (server-only), GameState is replicated to all clients — avoid server-only logic here.
• `PlayerArray` is populated automatically as players join and leave; do not manually add or remove entries.
• Access via `GetWorld()->GetGameState<AMyGameState>()` on any machine.

Signature

UCLASS() class AGameStateBase : public AInfo

Examples

Add replicated score to a subclass C++

UPROPERTY(Replicated, BlueprintReadOnly)
int32 TeamAScore = 0;

// Access on any machine
AMyGameState* GS = GetWorld()->GetGameState<AMyGameState>();
if (GS) { int32 Score = GS->TeamAScore; }

Iterate all connected players C++

for (APlayerState* PS : GetWorld()->GetGameState()->PlayerArray)
{
    UE_LOG(LogGame, Log, TEXT("Player: %s"), *PS->GetPlayerName());
}

Functions (17)

Lifecycle 5 Networking 3 State 9

Lifecycle

5 ▼

Access	Type	Name	Description
public	function	AGameStateBase::HandleBeginPlay	Called by the GameMode when gameplay officially begins (after StartPlay is called).
public	function	AGameStateBase::PostInitializeComponents	Called after all components have been initialized.
public	function	AGameStateBase::AsyncPackageLoaded	Called by the engine when an async package load completes.
public	function	AGameStateBase::ReceivedGameModeClass	Called when the `GameModeClass` property becomes valid — immediately on the server during initialization, and on clients once the replicated value arrives.
public	function	AGameStateBase::ReceivedSpectatorClass	Called when the `SpectatorClass` property becomes valid — on the server during init and on clients after replication.

Networking

3 ▼

Access	Type	Name	Description
public	function	AGameStateBase::GetLifetimeReplicatedProps	Registers which UPROPERTY members are replicated and under what conditions.
public	function	AGameStateBase::GetServerWorldTimeSeconds	Returns an approximation of the server's current WorldTimeSeconds, synchronized across server and clients via periodic replication.
public	function	AGameStateBase::SeamlessTravelTransitionCheckpoint	Called twice during a seamless travel: once when loading the transition map and once when loading the destination map.

State

9 ▼

Access	Type	Name	Description
public	function	AGameStateBase::HasBegunPlay	Returns true once the world has called `BeginPlay` on all actors.
public	function	AGameStateBase::HasMatchStarted	Returns true once the game mode has called its match-started callbacks.
public	function	AGameStateBase::AddPlayerState	Adds the given `APlayerState` to `PlayerArray`.
public	function	AGameStateBase::GetDefaultGameMode	Returns the CDO (class default object) of the game mode class associated with this game state.
public	function	AGameStateBase::GetPlayerRespawnDelay	Returns how many seconds a player must wait before being allowed to respawn.
public	function	AGameStateBase::GetPlayerStateFromUniqueNetId	Searches `PlayerArray` for the `APlayerState` matching the given unique net ID.
public	function	AGameStateBase::HasMatchEnded	Returns true if the match can be considered over.
public	function	AGameStateBase::RemovePlayerState	Removes the given `APlayerState` from `PlayerArray`.
public	function	AGameStateBase::GetPlayerStartTime	Returns the world time at which the given player started (or should be considered to have started).

Properties

Access	Type	Name	Description
public	property	AGameStateBase::AuthorityGameMode	Reference to the active GameMode instance.
public	property	AGameStateBase::GameModeClass	The class of the server's game mode, assigned by GameModeBase during initialization.
public	property	AGameStateBase::PlayerArray	The authoritative list of all connected PlayerStates, maintained on both server and clients.
public	property	AGameStateBase::SpectatorClass	The pawn class used for spectating, assigned by GameModeBase and replicated to all clients so they can spawn the correct spectator pawn when entering spectator mode.

Version History

Introduced in: 4.14

Version	Status	Notes
5.6	stable	—
5.0	stable	—

Feedback

Was this helpful?