AGameModeBase

class Engine Since 4.14

#include "GameFramework/GameModeBase.h"

Access: public Specifiers: UCLASS

Description

Server-only actor that defines the rules of the game: which pawn class to spawn, how players log in and respawn, and game flow. Only one GameMode is active per world and it exists solely on the server (or in single-player). Clients never receive a reference to the GameMode.

Caveats & Gotchas

• Use `AGameMode` (which extends this) if you need match-state transitions (WaitingToStart, InProgress, WaitingPostMatch).
• The GameMode class is set per-level via World Settings or by URL options; blueprint subclasses are the typical customization path.
• Access via `GetWorld()->GetAuthGameMode<AMyGameMode>()` — returns nullptr on clients.

Signature

UCLASS() class AGameModeBase : public AInfo

Examples

Set in project defaults C++

// In DefaultEngine.ini:
// [/Script/EngineSettings.GameMapsSettings]
// GlobalDefaultGameMode=/Game/GameModes/BP_MyGameMode.BP_MyGameMode_C

Access on server C++

AMyGameMode* GM = GetWorld()->GetAuthGameMode<AMyGameMode>();
if (GM) { GM->EndMatch(); }

Functions (58)

Lifecycle 4 Networking 1 Utility 4 Configuration 1 Game 9 Pausing 4 Player Management 15 Player Session 10 Server Travel 2 State 1 Travel 7

Lifecycle

4 ▼

Access	Type	Name	Description
public	function	AGameModeBase::StartPlay	Triggers the transition from initialization to gameplay by calling BeginPlay on all actors.
public	function	AGameModeBase::InitGameState	Initializes the GameState actor with default settings.
public	function	AGameModeBase::PreInitializeComponents	Called before the GameMode's components are initialized.
public	function	AGameModeBase::Reset	Overrides AActor::Reset to reinitialize the game state.

Networking

1 ▼

Access	Type	Name	Description
public	function	AGameModeBase::GetGameNetDriverReplicationSystem	Returns the replication system this GameMode requests for the GameNetDriver.

Utility

4 ▼

Access	Type	Name	Description
public	function	AGameModeBase::GetDefaultPawnClassForController	Returns the pawn class to spawn for a given controller.
public	function	AGameModeBase::InitGame	Called before any actor's `PreInitializeComponents` — the very first GameMode event when a level loads.
public	function	AGameModeBase::RestartPlayer	Finds a player start, spawns the default pawn, and possesses it — the full respawn flow in a single call.
public	function	AGameModeBase::SpawnDefaultPawnFor	Spawns the default pawn class for a controller at the given player start actor.

Configuration

1 ▼

Access	Type	Name	Description
public	function	AGameModeBase::GetGameSessionClass	Returns the AGameSession subclass to spawn for this game mode.

Game

9 ▼

Access	Type	Name	Description
public	function	AGameModeBase::GetNumPlayers	Returns the number of active human players currently in the game, excluding spectators.
public	function	AGameModeBase::HasMatchEnded	Returns true if the match can be considered over.
public	function	AGameModeBase::HasMatchStarted	Returns true once StartPlay has been called and the match-start callbacks have fired.
public	function	AGameModeBase::AllowCheats	Returns true if the given player should have access to cheat commands.
public	function	AGameModeBase::ClearPause	Iterates the list of CanUnpause delegates and removes any that return true.
public	function	AGameModeBase::GetNumSpectators	Returns the number of human players who are currently spectating.
public	function	AGameModeBase::SetPause	Requests the game be paused on behalf of a PlayerController.
public	function	AGameModeBase::ForceClearUnpauseDelegates	Unconditionally removes all CanUnpause delegates belonging to PauseActor and calls ClearPause if any were removed.
public	function	AGameModeBase::IsHandlingReplays	Returns true if the game mode automatically starts and stops replay recording when gameplay begins and ends.

Pausing

4 ▼

Access	Type	Name	Description
public	function	AGameModeBase::AllowPausing	Returns true if the game allows pausing.
public	function	AGameModeBase::IsPaused	Returns true if the game is currently paused.
public	function	AGameModeBase::ResetLevel	Resets the game state while remaining in the same map.
public	function	AGameModeBase::ShouldReset	Called by `ResetLevel()` for each actor to determine whether `Reset()` should be invoked on it.

Player Management

15 ▼

Access	Type	Name	Description
public	function	AGameModeBase::ChangeName	Assigns or changes a player's name on the server, then broadcasts the change via K2_OnChangeName.
public	function	AGameModeBase::ChoosePlayerStart	Selects the best unoccupied PlayerStart actor for a given player.
public	function	AGameModeBase::FindPlayerStart	Returns the PlayerStart actor to use for a player's next spawn.
public	function	AGameModeBase::K2_FindPlayerStart	Blueprint-accessible wrapper for FindPlayerStart.
public	function	AGameModeBase::K2_OnChangeName	Blueprint event fired by ChangeName after a player's name has been updated.
public	function	AGameModeBase::K2_OnRestartPlayer	Blueprint event fired at the end of RestartPlayer and RestartPlayerAtPlayerStart after the pawn has been successfully spawned and possessed.
public	function	AGameModeBase::Login	Creates and returns a new PlayerController for a player joining the server.
public	function	AGameModeBase::PlayerCanRestart	Returns true if a player is currently allowed to respawn.
public	function	AGameModeBase::RestartPlayerAtPlayerStart	Spawns a player's pawn at a specific start spot actor.
public	function	AGameModeBase::RestartPlayerAtTransform	Spawns or respawns a player's pawn at a specific world transform instead of at a player start actor.
public	function	AGameModeBase::SetPlayerDefaults	Called from RestartPlayer after a pawn has been spawned and possessed to apply any game-mode-specific default stats or equipment.
public	function	AGameModeBase::SpawnDefaultPawnAtTransform	Spawns an instance of the default pawn class at the given transform and returns it.
public	function	AGameModeBase::SpawnPlayerController	Spawns and returns the appropriate PlayerController for the joining player, split out from Login() for easier overriding.
public	function	AGameModeBase::InitStartSpot	Called from RestartPlayerAtPlayerStart just before a pawn is spawned, allowing the game mode to initialize or claim the start spot.
public	function	AGameModeBase::SpawnPlayerFromSimulate	Spawns a player into a running PIE session when the editor transitions from Simulate mode to Play mode.

Player Session

10 ▼

Access	Type	Name	Description
public	function	AGameModeBase::CanSpectate	Determines whether a player is allowed to spectate another specific player.
public	function	AGameModeBase::HandleStartingNewPlayer	Called at the end of `PostLogin` to signal that the player is ready to enter the game.
public	function	AGameModeBase::K2_OnLogout	Blueprint-implementable event fired near the end of `Logout`.
public	function	AGameModeBase::K2_PostLogin	Blueprint-implementable event fired at the end of `PostLogin`.
public	function	AGameModeBase::Logout	Called when a controller with a `PlayerState` leaves the game or is destroyed.
public	function	AGameModeBase::MustSpectate	Returns true if the given player is only allowed to join as a spectator.
public	function	AGameModeBase::PostLogin	Called after a player has successfully logged in.
public	function	AGameModeBase::PreLogin	Called before `Login` to accept or reject an incoming connection.
public	function	AGameModeBase::GameWelcomePlayer	Called when a client first connects to the server, before `PreLogin`.
public	function	AGameModeBase::PreLoginAsync	Async version of `PreLogin` that allows off-thread backend calls (e.

Server Travel

2 ▼

Access	Type	Name	Description
public	function	AGameModeBase::CanServerTravel	Override to gate server travel to specific maps or under specific conditions.
public	function	AGameModeBase::ProcessServerTravel	Initiates a server-side level transition that brings all connected clients to the new map.

State

1 ▼

Access	Type	Name	Description
public	function	AGameModeBase::GetGameState	Returns the current GameState cast to the requested type.

Travel

7 ▼

Access	Type	Name	Description
public	function	AGameModeBase::ReturnToMainMenuHost	Disconnects all players and returns the server to the main menu map.
public	function	AGameModeBase::GetPlayerControllerClassToSpawnForSeamlessTravel	Returns the PlayerController class to spawn for a seamlessly traveling player.
public	function	AGameModeBase::GetSeamlessTravelActorList	Called on the server during seamless travel to collect actors that should be moved into the next level.
public	function	AGameModeBase::HandleSeamlessTravelPlayer	Called server-side to reinitialize a player who survived seamless travel into the new level.
public	function	AGameModeBase::PostSeamlessTravel	Called on the new GameMode after all seamless-travel players have been reinitialized.
public	function	AGameModeBase::StartToLeaveMap	Called at the beginning of a map transition — either at the start of seamless travel or immediately before a hard (non-seamless) map change.
public	function	AGameModeBase::SwapPlayerControllers	Swaps a player's viewport and network connection from the old PlayerController to a newly spawned one during seamless travel when the controller class has changed between levels.

Properties

Access	Type	Name	Description
public	property	AGameModeBase::DefaultPawnClass	The pawn class spawned when a player joins or restarts.
public	property	AGameModeBase::DefaultPlayerName	The player name assigned to any player who joins without specifying a name in the URL options.
public	property	AGameModeBase::GameSession	The live AGameSession instance spawned by this game mode.
public	property	AGameModeBase::GameSessionClass	The AGameSession subclass this game mode spawns to handle login approval and the online game interface.
public	property	AGameModeBase::GameState	The live AGameStateBase instance for this session.
public	property	AGameModeBase::GameStateClass	The AGameStateBase subclass this game mode spawns and replicates to all clients.
public	property	AGameModeBase::HUDClass	The AHUD subclass spawned for each local player.
public	property	AGameModeBase::OptionsString	Stores the full URL options string from the map load command.
public	property	AGameModeBase::PlayerControllerClass	The APlayerController subclass spawned for every player who joins.
public	property	AGameModeBase::PlayerStateClass	The APlayerState subclass associated with every player and replicated to all clients.
public	property	AGameModeBase::ReplaySpectatorPlayerControllerClass	The PlayerController subclass spawned when watching a network replay.
public	property	AGameModeBase::ServerStatReplicator	The live AServerStatReplicator instance spawned by this GameMode.
public	property	AGameModeBase::ServerStatReplicatorClass	Specifies the class used to spawn the AServerStatReplicator actor, which replicates server performance statistics such as frame time and average ping to connected clients.
public	property	AGameModeBase::SpectatorClass	The pawn class used when a PlayerController is in spectator mode (no possessed pawn).

Version History

Introduced in: 4.14

Version	Status	Notes
5.6	stable	—
5.0	stable	—

Feedback

Was this helpful?