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 > AGameSession

Light Theme

Dark Theme

AGameSession

Acts as a game-specific wrapper around the session interface.

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

AActor

AInfo

AGameSession

References

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

Syntax

class AGameSession : public AInfo

Remarks

Acts as a game-specific wrapper around the session interface. The game code makes calls to this when it needs to interact with the session interface. A game session exists only the server, while running an online game.

Variables

	Name	Description
bool	bRequiresPushToTalk	Is voice enabled always or via a push to talk keybinding
int32	MaxPartySize	Restrictions on the largest party that can join together
int32	MaxPlayers	Maximum number of players allowed by this server.
int32	MaxSpectators	Maximum number of spectators allowed by this server.
uint8	MaxSplitscreensPerConnection	Maximum number of splitscreen players to allow from one connection
FName	SessionName	SessionName local copy from PlayerState class.

Constructors

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

Functions

	Name	Description
void	AddAdmin ( APlayerController* AdminPlayer )	Add a player to the admin list of this session
FString	ApproveLogin ( const FString& Options )	Called from GameMode.PreLogin() and Login().
bool	AtCapacity ( bool bSpectator )
bool	BanPlayer ( APlayerController* BannedPlaye..., const FText& BanReason )	Forcibly remove player from the server and ban them permanently
bool	CanRestartGame()	Called from GameMode.RestartGame().
void	DumpSessionState()	Dump session info to log for debugging.
int32	GetNextPlayerID()
bool	GetSessionJoinability ( FName InSessionName, FJoinabilitySettings& OutSettings )	Get the current joinability settings for a given session
void	HandleMatchHasEnded()	Handle when the match has completed
void	HandleMatchHasStarted()	Handle when the match has started
void	HandleMatchIsWaitingToStart()	Handle when the match enters waiting to start
bool	HandleStartMatchRequest()	True if GameSession handled the request, in case it wants to stall for some reason.
void	InitOptions ( const FString& Options )	Initialize options based on passed in options string
bool	KickPlayer ( APlayerController* KickedPlaye..., const FText& KickReason )	Forcibly remove player from the server
void	NotifyLogout ( FName InSessionName, const FUniqueNetIdRepl& UniqueId )	Called when a player logs out of game.
void	NotifyLogout ( const APlayerController* PC )	Called when a PlayerController logs out of game.
void	OnAutoLoginComplete ( int32 LocalUserNum, bool bWasSuccessful, const FString& Error )	Delegate triggered on auto login completion
void	OnEndSessionComplete ( FName InSessionName, bool bWasSuccessful )	Delegate called when EndSession has completed
void	OnStartSessionComplete ( FName InSessionName, bool bWasSuccessful )	Delegate called when StartSession has completed
void	PostLogin ( APlayerController* NewPlayer )	Called by GameMode::PostLogin to give session code chance to do work after PostLogin
void	PostSeamlessTravel()	Called after a seamless level transition has been completed on the new GameMode used to reinitialize players already in the game as they won't have *Login() called on them
bool	ProcessAutoLogin()	Allow an online service to process a login if specified on the commandline with -auth_login/-auth_password
void	RegisterPlayer ( APlayerController* NewPlayer, const FUniqueNetIdRepl& UniqueId, bool bWasFromInvite )	Register a player with the online service session
void	RegisterServer()	Allow a dedicated server a chance to register itself with an online service
void	RegisterServerFailed()	Callback when autologin was expected but failed
void	RemoveAdmin ( APlayerController* AdminPlayer )	Remove a player from the admin list of this session
bool	RequiresPushToTalk()	Does the session require push to talk
void	Restart()	Restart the session
void	ReturnToMainMenuHost()	Gracefully tell all clients then local players to return to lobby
void	UnregisterPlayer ( const APlayerController* Exiti... )	Unregister a player from the online service session
void	UnregisterPlayer ( FName InSessionName, const FUniqueNetIdRepl& UniqueId )	Unregister a player from the online service session
void	UpdateSessionJoinability ( FName InSessionName, bool bPublicSearchable, bool bAllowInvites, bool bJoinViaPresence, bool bJoinViaPresenceFriendsOnly )	Update session join parameters

Deprecated Functions

	Name	Description
void	RegisterPlayer ( APlayerController* NewPlayer, const FUniqueNetIdPtr& UniqueId, bool bWasFromInvite )	Use RegisterPlayer with FUniqueNetIdRepl
void	UnregisterPlayers ( FName InSessionName, const TArray< FUniqueNetIdRef >& P... )	Use UnregisterPlayers with FUniqueNetIdRepl
void	UnregisterPlayers ( FName InSessionName, const TArray< FUniqueNetIdRepl >& ... )	Use UnregisterPlayers with FUniqueNetIdRepl

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

Take our survey

Cancel