1. Epic GamesDeveloper
  3. AGameSession

AGameSession

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

API > API/Runtime > API/Runtime/Engine > API/Runtime/Engine/GameFramework

Inheritance Hierarchy

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

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

Constructors

  Type Name Description
Public function  

AGameSession ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Virtual void

AddAdmin ( APlayerController* AdminPlayer
)

 Add a player to the admin list of this session
Public function Virtual FString

ApproveLogin ( const FString& Options
)

 Called from GameMode.PreLogin() and Login().
Public function Virtual bool

AtCapacity ( bool bSpectator
)

  
Public function Virtual bool

BanPlayer ( APlayerController* BannedPlayer,
const FText& BanReason
)

 Forcibly remove player from the server and ban them permanently
Public function Virtual bool Called from GameMode.RestartGame().
Public function Virtual void Dump session info to log for debugging.
Public function int32  
Public function Virtual bool

GetSessionJoinability ( FName InSessionName,
FJoinabilitySettings& OutSettings
)

 Get the current joinability settings for a given session
Public function Virtual void Handle when the match has completed
Public function Virtual void Handle when the match has started
Public function Virtual void Handle when the match enters waiting to start
Public function Virtual bool True if GameSession handled the request, in case it wants to stall for some reason.
Public function Virtual void

InitOptions ( const FString& Options
)

 Initialize options based on passed in options string
Public function Virtual bool

KickPlayer ( APlayerController* KickedPlayer,
const FText& KickReason
)

 Forcibly remove player from the server
Public function Virtual void

NotifyLogout ( FName InSessionName,
const FUniqueNetIdRepl& UniqueId
)

 Called when a player logs out of game.
Public function Virtual void Called when a PlayerController logs out of game.
Public function Virtual void

OnAutoLoginComplete ( int32 LocalUserNum,
bool bWasSuccessful,
const FString& Error
)

 Delegate triggered on auto login completion
Protected function Virtual void

OnEndSessionComplete ( FName InSessionName,
bool bWasSuccessful
)

 Delegate called when EndSession has completed
Protected function Virtual void

OnStartSessionComplete ( FName InSessionName,
bool bWasSuccessful
)

 Delegate called when StartSession has completed
Public function Virtual void

PostLogin ( APlayerController* NewPlayer
)

 Called by GameMode::PostLogin to give session code chance to do work after PostLogin
Public function Virtual void 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
Public function Virtual bool Allow an online service to process a login if specified on the commandline with -auth_login/-auth_password
Public function Virtual void

RegisterPlayer ( APlayerController* NewPlayer,
const FUniqueNetIdRepl& UniqueId,
bool bWasFromInvite
)

 Register a player with the online service session
Public function Virtual void Allow a dedicated server a chance to register itself with an online service
Public function Virtual void Callback when autologin was expected but failed
Public function Virtual void

RemoveAdmin ( APlayerController* AdminPlayer
)

 Remove a player from the admin list of this session
Public function Virtual Const bool Does the session require push to talk
Public function Virtual void

Restart ()

 Restart the session
Public function Virtual void Gracefully tell all clients then local players to return to lobby
Public function Virtual void

UnregisterPlayer ( const APlayerController* ExitingPlayer
)

 Unregister a player from the online service session
Public function Virtual void

UnregisterPlayer ( FName InSessionName,
const FUniqueNetIdRepl& UniqueId
)

 Unregister a player from the online service session
Public function Virtual void

UpdateSessionJoinability ( FName InSessionName,
bool bPublicSearchable,
bool bAllowInvites,
bool bJoinViaPresence,
bool bJoinViaPresenceFriendsOnly
)

 Update session join parameters

Deprecated Functions

  Type Name Description
Public function Virtual void

RegisterPlayer ( APlayerController* NewPlayer,
const FUniqueNetIdPtr& UniqueId,
bool bWasFromInvite
)

 Use RegisterPlayer with FUniqueNetIdRepl
Public function Virtual void

UnregisterPlayers ( FName InSessionName,
const TArray< FUniqueNetIdRef >& Players
)

 Use UnregisterPlayers with FUniqueNetIdRepl
Public function Virtual void

UnregisterPlayers ( FName InSessionName,
const TArray< FUniqueNetIdRepl >& Players
)

 Use UnregisterPlayers with FUniqueNetIdRepl

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page