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

Light Theme

Dark Theme

AGameState

GameState is a subclass of GameStateBase that behaves like a multiplayer match-based game.

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

AActor

AInfo

AGameStateBase

AGameState

	AARSharedWorldGameState
	AMagicLeapSharedWorldGameState

References

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

Syntax

class AGameState : public AGameStateBase

Remarks

GameState is a subclass of GameStateBase that behaves like a multiplayer match-based game. It is tied to functionality in GameMode.

Variables

	Name	Description
int32	ElapsedTime	Elapsed game time since match has started.
FName	MatchState	What match state we are currently in
FName	PreviousMatchState	Previous map state, used to handle if multiple transitions happen per frame
FTimerHandle	TimerHandle_DefaultTimer	Handle for efficient management of DefaultTimer timer

Constructors

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

Functions

	Name	Description
void	DefaultTimer()	Called periodically, overridden by subclasses
FName	GetMatchState()	Returns the current match state, this is an accessor to protect the state machine flow
void	HandleLeavingMap()	Called when the match transitions to LeavingMap
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
bool	HasMatchEnded()	Returns true if match is WaitingPostMatch or later
bool	IsMatchInProgress()	Returns true if we're in progress
void	OnRep_ElapsedTime()	Gives clients the chance to do something when time gets updates
void	OnRep_MatchState()	Match state has changed
void	SetMatchState ( FName NewState )	Updates the match state and calls the appropriate transition functions, only valid on server

Overridden from AGameStateBase

	Name	Description
float	GetPlayerRespawnDelay ( AController* Controller )	Returns how much time needs to be spent before a player can respawn
float	GetPlayerStartTime ( AController* Controller )	Returns the time that should be used as when a player started
void	HandleBeginPlay()	Called by game mode to set the started play bool
bool	HasMatchStarted()	Returns true if the world has started match (called MatchStarted callbacks)
void	ReceivedGameModeClass()	Called when the GameClass property is set (at startup for the server, after the variable has been replicated on clients)

Overridden from AActor

		Name	Description
	void	PostInitializeComponents()	Allow actors to initialize themselves on the C++ side after all of their components have been initialized, only called during gameplay

Deprecated Functions

		Name	Description
	bool	ShouldShowGore()	ShouldShowGore is deprecated, it is not supported by newer assets

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

Take our survey

Dismiss