Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Engine > GameFramework > AGameMode

Light Theme

Dark Theme

AGameMode

GameMode is a subclass of GameModeBase that behaves like a multiplayer match-based game.

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

AActor

AInfo

AGameModeBase

AGameMode

	AARSharedWorldGameMode
	AMagicLeapSharedWorldGameMode
	AVPGameMode

References

Module	Engine
Header	/Engine/Source/Runtime/Engine/Classes/GameFramework/GameMode.h
Include	#include "GameFramework/GameMode.h"

Syntax

class AGameMode : public AGameModeBase

Remarks

GameMode is a subclass of GameModeBase that behaves like a multiplayer match-based game. It has default behavior for picking spawn points and match state. If you want a simpler base, inherit from GameModeBase instead.

Variables

	Name	Description
uint32: 1	bDelayedStart	Whether the game should immediately start when the first player logs in.
bool	bHandleDedicatedServerReplays	If true, dedicated servers will record replays when HandleMatchHasStarted/HandleMatchHasStopped is called
TSubclassOf< cl...	EngineMessageClass	Contains strings describing localized game agnostic messages.
TArray< class A...	InactivePlayerArray	PlayerStates of players who have disconnected from the server (saved in case they reconnect)
float	InactivePlayerStateLifeSpan	Time a playerstate will stick around in an inactive state after a player logout
FName	MatchState	What match state we are currently in
int32	MaxInactivePlayers	The maximum number of inactive players before we kick the oldest ones out
float	MinRespawnDelay	Minimum time before player can respawn after dying.
int32	NumBots	Number of non-human players (AI controlled but participating as a player).
int32	NumPlayers	Current number of human players.
int32	NumSpectators	Current number of spectators.
int32	NumTravellingPlayers	Number of players that are still traveling from a previous map

Constructors

	Name	Description
	AGameMode ( const FObjectInitializer& ObjectIn... )

Functions

	Name	Description
void	AbortMatch()	Report that a match has failed due to unrecoverable error
void	AddInactivePlayer ( APlayerState* PlayerState, APlayerController* PC )	Add PlayerState to the inactive list, remove from the active list
void	Broadcast ( AActor* Sender, const FString& Msg, FName Type )	Broadcast a string to all players.
void	BroadcastLocalized ( AActor* Sender, TSubclassOf< ULocalMessage > Messag..., int32 Switch, APlayerState* RelatedPlayerSta..., APlayerState* RelatedPlayerSta..., UObject* OptionalObject )	Broadcast a localized message to all players.
void	EndMatch()	Transition from InProgress to WaitingPostMatch.
bool	FindInactivePlayer ( APlayerController* PC )	Attempt to find and associate an inactive PlayerState with entering PC.
FName	GetMatchState()	Returns the current match state, this is an accessor to protect the state machine flow
FString	GetNetworkNumber()	Get local address
bool	GetTravelType()	Return true if we want to travel_absolute, used by RestartGame by default
void	HandleDisconnect ( UWorld* InWorld, UNetDriver* NetDriver )	Handles when a player is disconnected, before the session does
void	HandleLeavingMap()	Called when the match transitions to LeavingMap
void	HandleMatchAborted()	Called when the match transitions to Aborted
void	HandleMatchHasEnded()	Called when the map transitions to WaitingPostMatch
void	HandleMatchHasStarted()	Called when the state transitions to InProgress
void	HandleMatchIsWaitingToStart()	Called when the state transitions to WaitingToStart
void	HandleStartingNewPlayer_Implementation ( APlayerController* NewPlayer )
bool	IsMatchInProgress()	Returns true if the match state is InProgress or other gameplay state
void	K2_OnSetMatchState ( FName NewState )	Implementable event to respond to match state changes
void	MatineeCancelled()	Called when this PC is in cinematic mode, and its matinee is canceled by the user.
void	NotifyPendingConnectionLost ( const FUniqueNetIdRepl& Connection... )	Called when a connection closes before getting to PostLogin()
void	OnMatchStateSet()	Overridable virtual function to dispatch the appropriate transition functions before GameState and Blueprints get SetMatchState calls.
void	OverridePlayerState ( APlayerController* PC, APlayerState* OldPlayerState )	Override PC's PlayerState with the values in OldPlayerState as part of the inactive player handling
bool	PlayerCanRestart_Implementation ( APlayerController* Player )
void	PlayerSwitchedToSpectatorOnly ( APlayerController* PC )	Will remove the controller from the correct count then add them to the spectator count.
void	PostCommitMapChange()	Called from CommitMapChange after unloading previous level and loading new level+sublevels.
void	PreCommitMapChange ( const FString& PreviousMapName, const FString& NextMapName )	Called from CommitMapChange before unloading previous level. Used for asynchronous level streaming
bool	ReadyToEndMatch()	Returns true if ready to End Match. Games should override this
bool	ReadyToStartMatch()	Returns true if ready to Start Match. Games should override this
void	RemovePlayerControllerFromPlayerCount ( APlayerController* PC )	Removes the passed in player controller from the correct count for player/spectator/tranistioning
void	RestartGame()	Restart the game, by default travel to the current map
void	Say ( const FString& Msg )	Exec command to broadcast a string to all players
void	SetMatchState ( FName NewState )	Updates the match state and calls the appropriate transition functions
void	SetSeamlessTravelViewTarget ( APlayerController* PC )	SetViewTarget of player control on server change
void	StartMatch()	Transition from WaitingToStart to InProgress.

Overridden from AGameModeBase

	Name	Description
bool	CanServerTravel ( const FString& URL, bool bAbsolute )	Returns true if allowed to server travel
int32	GetNumPlayers()	Returns number of active human players, excluding spectators
int32	GetNumSpectators()	Returns number of human players currently spectating
void	HandleSeamlessTravelPlayer ( AController*& C )	Handles reinitializing players that remained through a seamless level transition called from C++ for players that finished loading after the server
bool	HasMatchEnded()	Returns true if the match state is WaitingPostMatch or later
bool	HasMatchStarted()	Returns true if the match start callbacks have been called
void	InitGame ( const FString& MapName, const FString& Options, FString& ErrorMessage )	Initialize the game.
void	InitSeamlessTravelPlayer ( AController* NewController )	Handles initializing a seamless travel player, handles logic similar to InitNewPlayer
bool	IsHandlingReplays()	Returns true if replays will start/stop during gameplay starting/stopping
void	Logout ( AController* Exiting )	Called when a Controller with a PlayerState leaves the game or is destroyed
void	PostLogin ( APlayerController* NewPlayer )	Called after a successful login.
void	PostSeamlessTravel()	Called after a seamless level transition has been completed on the new GameMode.
bool	SpawnPlayerFromSimulate ( const FVector& NewLocation, const FRotator& NewRotation )	Used in the editor to spawn a PIE player after the game has already started
void	StartPlay()	Transitions to calls BeginPlay on actors.
void	StartToLeaveMap()	Start the transition out of the current map.

Overridden from AActor

		Name	Description
	void	Tick ( float DeltaSeconds )	Function called every frame on this Actor.

Deprecated Functions

	Name	Description
FString	GetDefaultGameClassPath ( const FString& MapName, const FString& Options, const FString& Portal )	Deprecated in favor of PreloadContentForURL on GameInstance
TSubclassOf<...	GetGameModeClass ( const FString& MapName, const FString& Options, const FString& Portal )	Deprecated in favor of OverrideGameModeClass on GameInstance
void	SendPlayer ( APlayerController* aPlayer, const FString& URL )	SendPlayer is not in use, call ClientTravel directly instead
void	SetBandwidthLimit ( float AsyncIOBandwidthLimit )	AsyncIOBandwidthLimit is no longer configurable
void	StartNewPlayer ( APlayerController* NewPlayer )	StartNewPlayer has been split into InitializeHUDForPlayer and HandleStartingNewPlayer
FString	StaticGetFullGameClassName ( FString const& Str )	Deprecated in favor of GetGameModeForName on GameMapsSettings

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss