GameSession.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "UObject/ObjectMacros.h"
#include "GameFramework/Actor.h"
#include "Online/CoreOnline.h"
#include "GameFramework/Info.h"
#include "GameSession.generated.h"
 
class APlayerController;
class Error;
struct FUniqueNetIdRepl;
 
ENGINE_API DECLARE_LOG_CATEGORY_EXTERN(LogGameSession, Log, All);
 
UCLASS(config=Game, notplaceable, MinimalAPI)
class AGameSession : public AInfo
{
    GENERATED_UCLASS_BODY()
 
    
    UPROPERTY(globalconfig)
    int32 MaxSpectators;
 
    UPROPERTY(globalconfig)
    int32 MaxPlayers;
 
    UPROPERTY()
    int32 MaxPartySize;
 
    UPROPERTY(globalconfig)
    uint8 MaxSplitscreensPerConnection;
 
    UPROPERTY(globalconfig)
    bool bRequiresPushToTalk;
 
    UPROPERTY()
    FName SessionName;
 
    ENGINE_API virtual void InitOptions(const FString& Options);
 
    ENGINE_API int32 GetNextPlayerID();
 
    //=================================================================================
    // LOGIN
 
    ENGINE_API virtual bool ProcessAutoLogin();
 
    ENGINE_API virtual void OnAutoLoginComplete(int32 LocalUserNum, bool bWasSuccessful, const FString& Error);
 
    ENGINE_API virtual FString ApproveLogin(const FString& Options);
 
    ENGINE_API virtual void RegisterPlayer(APlayerController* NewPlayer, const FUniqueNetIdRepl& UniqueId, bool bWasFromInvite);
 
    ENGINE_API virtual void PostLogin(APlayerController* NewPlayer);
 
    ENGINE_API virtual bool AtCapacity(bool bSpectator);
 
    //=================================================================================
    // LOGOUT
 
    ENGINE_API virtual void NotifyLogout(const APlayerController* PC);
 
    ENGINE_API virtual void NotifyLogout(FName InSessionName, const FUniqueNetIdRepl& UniqueId);
 
    ENGINE_API virtual void UnregisterPlayer(FName InSessionName, const FUniqueNetIdRepl& UniqueId);
 
    ENGINE_API virtual void UnregisterPlayers(FName InSessionName, const TArray< FUniqueNetIdRepl >& Players);
    
    ENGINE_API virtual void UnregisterPlayer(const APlayerController* ExitingPlayer);
 
    ENGINE_API virtual void AddAdmin(APlayerController* AdminPlayer);
 
    ENGINE_API virtual void RemoveAdmin(APlayerController* AdminPlayer);
 
    ENGINE_API virtual bool KickPlayer(APlayerController* KickedPlayer, const FText& KickReason);
 
    ENGINE_API virtual bool BanPlayer(APlayerController* BannedPlayer, const FText& BanReason);
 
    ENGINE_API virtual void ReturnToMainMenuHost();
 
    ENGINE_API virtual void PostSeamlessTravel();
 
    //=================================================================================
    // SESSION INFORMATION
 
    virtual void Restart() {}
 
    ENGINE_API virtual void RegisterServer();
 
    ENGINE_API virtual void RegisterServerFailed();
 
    ENGINE_API virtual bool GetSessionJoinability(FName InSessionName, FJoinabilitySettings& OutSettings);
 
    ENGINE_API virtual void UpdateSessionJoinability(FName InSessionName, bool bPublicSearchable, bool bAllowInvites, bool bJoinViaPresence, bool bJoinViaPresenceFriendsOnly);
 
    virtual bool RequiresPushToTalk() const { return bRequiresPushToTalk; }
 
    ENGINE_API virtual void DumpSessionState();
 
    //=================================================================================
    // MATCH INTERFACE
 
    ENGINE_API virtual bool HandleStartMatchRequest();
 
    ENGINE_API virtual void HandleMatchIsWaitingToStart();
 
    ENGINE_API virtual void HandleMatchHasStarted();
 
    ENGINE_API virtual void HandleMatchHasEnded();
 
    ENGINE_API virtual bool CanRestartGame();
 
private:
    // Hidden functions that don't make sense to use on this class.
    HIDE_ACTOR_TRANSFORM_FUNCTIONS();
 
protected:
    ENGINE_API virtual void OnStartSessionComplete(FName InSessionName, bool bWasSuccessful);
 
    ENGINE_API virtual void OnEndSessionComplete(FName InSessionName, bool bWasSuccessful);
 
    ENGINE_API virtual void PostReloadConfig(FProperty* PropertyThatWasLoaded) override;
 
private:
 
    TOptional<int32> MaxPlayersOptionOverride;
 
    TOptional<int32> MaxSpectatorsOptionOverride;
};
 
ENGINE_API APlayerController* GetPlayerControllerFromNetId(UWorld* World, const FUniqueNetIdRepl& PlayerNetId);