OnlineEngineInterface.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 "UObject/Object.h"
#include "Online/CoreOnline.h"
#include "OnlineEngineInterface.generated.h"
 
class FVoicePacket;
class UNetConnection;
struct FWorldContext;
 
DECLARE_DELEGATE_ThreeParams(FOnlineAutoLoginComplete, int32 /*LocalUserNum*/, bool /*bWasSuccessful*/, const FString& /*Error*/);
DECLARE_DELEGATE_TwoParams(FOnlineSessionStartComplete, FName /*InSessionName*/, bool /*bWasSuccessful*/);
DECLARE_DELEGATE_TwoParams(FOnlineSessionEndComplete, FName /*InSessionName*/, bool /*bWasSuccessful*/);
DECLARE_DELEGATE_OneParam(FOnlineExternalUIChanged, bool /*bInIsOpening*/);
DECLARE_DELEGATE_OneParam(FOnlineShowWebUrlClosed, const FString& /*FinalUrl*/);
DECLARE_DELEGATE_ThreeParams(FOnPIELoginComplete, int32 /*LocalUserNum*/, bool /*bWasSuccessful*/, const FString& /*Error*/);
 
UCLASS(config = Engine, MinimalAPI)
class UOnlineEngineInterface : public UObject
{
    GENERATED_UCLASS_BODY()
 
public:
 
    static ENGINE_API UOnlineEngineInterface* Get();
 
    virtual bool IsLoaded(FName OnlineIdentifier = NAME_None) { return false; }
    virtual FName GetOnlineIdentifier(FWorldContext& WorldContext) { return NAME_None; }
    virtual bool DoesInstanceExist(FName OnlineIdentifier) { return false; }
    virtual void ShutdownOnlineSubsystem(FName OnlineIdentifier) {}
    virtual void DestroyOnlineSubsystem(FName OnlineIdentifier) {}
    virtual FName GetDefaultOnlineSubsystemName() const { return NAME_None; }
    virtual bool IsCompatibleUniqueNetId(const FUniqueNetIdWrapper& InUniqueNetId) const { return (InUniqueNetId.IsV1() && InUniqueNetId.GetType() == GetDefaultOnlineSubsystemName()); }
 
    virtual uint8 GetReplicationHashForSubsystem(FName InSubsystemName) const { return 0; }
 
    virtual FName GetSubsystemFromReplicationHash(uint8 InHash) const { return NAME_None; }
 
    virtual FUniqueNetIdWrapper CreateUniquePlayerIdWrapper(const FString& Str, FName Type = NAME_None) { return FUniqueNetIdWrapper(); }
    virtual FUniqueNetIdWrapper GetUniquePlayerIdWrapper(UWorld* World, int32 LocalUserNum, FName Type = NAME_None) { return FUniqueNetIdWrapper(); }
 
    virtual FString GetPlayerNickname(UWorld* World, const FUniqueNetIdWrapper& UniqueId) { return TEXT("INVALID"); }
    virtual bool GetPlayerPlatformNickname(UWorld* World, int32 LocalUserNum, FString& OutNickname) { return false; }
    
    virtual bool AutoLogin(UWorld* World, int32 LocalUserNum, const FOnlineAutoLoginComplete& InCompletionDelegate) { return false; }
    virtual bool IsLoggedIn(UWorld* World, int32 LocalUserNum) { return false; }
 
    virtual void StartSession(UWorld* World, FName SessionName, FOnlineSessionStartComplete& InCompletionDelegate) { InCompletionDelegate.ExecuteIfBound(SessionName, false); }
    virtual void EndSession(UWorld* World, FName SessionName, FOnlineSessionEndComplete& InCompletionDelegate) { InCompletionDelegate.ExecuteIfBound(SessionName, false); }
    virtual bool DoesSessionExist(UWorld* World, FName SessionName) { return false; }
 
    virtual bool GetSessionJoinability(UWorld* World, FName SessionName, FJoinabilitySettings& OutSettings) { return false; }
    virtual void UpdateSessionJoinability(UWorld* World, FName SessionName, bool bPublicSearchable, bool bAllowInvites, bool bJoinViaPresence, bool bJoinViaPresenceFriendsOnly) {}
 
    virtual void RegisterPlayer(UWorld* World, FName SessionName, const FUniqueNetIdWrapper& UniqueId, bool bWasInvited) {}
    virtual void UnregisterPlayer(UWorld* World, FName SessionName, const FUniqueNetIdWrapper& UniqueId) {}
    virtual void UnregisterPlayers(UWorld* World, FName SessionName, const TArray<FUniqueNetIdWrapper>& Players) {}
    virtual bool GetResolvedConnectString(UWorld* World, FName SessionName, FString& URL) { return false; }
 
    virtual TSharedPtr<FVoicePacket> GetLocalPacket(UWorld* World, uint8 LocalUserNum) { return nullptr; }
    virtual TSharedPtr<FVoicePacket> SerializeRemotePacket(UWorld* World, const UNetConnection* const RemoteConnection, FArchive& Ar) { return nullptr; }
 
    virtual void StartNetworkedVoice(UWorld* World, uint8 LocalUserNum) {}
    virtual void StopNetworkedVoice(UWorld* World, uint8 LocalUserNum) {}
    virtual void ClearVoicePackets(UWorld* World) {}
 
    virtual bool MuteRemoteTalker(UWorld* World, uint8 LocalUserNum, const FUniqueNetIdWrapper& PlayerId, bool bIsSystemWide) { return false; }
    virtual bool UnmuteRemoteTalker(UWorld* World, uint8 LocalUserNum, const FUniqueNetIdWrapper& PlayerId, bool bIsSystemWide) { return false; }
    virtual int32 GetNumLocalTalkers(UWorld* World) { return 0; }
 
    struct FShowWebUrlParams
    {
        bool bEmbedded;
        bool bShowCloseButton;
        bool bShowBackground;
        bool bHideCursor;
        bool bResetCookies;
        int32 OffsetX;
        int32 OffsetY;
        int32 SizeX;
        int32 SizeY;
        TArray<FString> AllowedDomains;
        FString CallbackPath;
 
        FShowWebUrlParams(bool InbEmbedded, int32 InOffsetX, int32 InOffsetY, int32 InSizeX, int32 InSizeY)
            : bEmbedded(InbEmbedded)
            , bShowCloseButton(false)
            , bShowBackground(false)
            , bHideCursor(false)
            , bResetCookies(false)
            , OffsetX(InOffsetX)
            , OffsetY(InOffsetY)
            , SizeX(InSizeX)
            , SizeY(InSizeY)
        {
        }
 
        FShowWebUrlParams()
            : bEmbedded(false)
            , bShowCloseButton(false)
            , bShowBackground(false)
            , bHideCursor(false)
            , bResetCookies(false)
            , OffsetX(0)
            , OffsetY(0)
            , SizeX(0)
            , SizeY(0)
        {
        }
    };
 
    virtual void ShowLeaderboardUI(UWorld* World, const FString& CategoryName) {}
    virtual void ShowAchievementsUI(UWorld* World, int32 LocalUserNum) {}
    virtual void BindToExternalUIOpening(const FOnlineExternalUIChanged& Delegate) {}
#define OSS_ADDED_SHOW_WEB 1 
    virtual void ShowWebURL(const FString& CurrentURL, const FShowWebUrlParams& ShowParams, const FOnlineShowWebUrlClosed& CompletionDelegate) {}
    virtual bool CloseWebURL() { return false; }
 
    virtual void DumpSessionState(UWorld* World) {}
    virtual void DumpPartyState(UWorld* World) {}
    virtual void DumpVoiceState(UWorld* World) {}
    virtual void DumpChatState(UWorld* World) {}
 
    virtual bool SupportsOnlinePIE() { return false; }
    virtual void SetShouldTryOnlinePIE(bool bShouldTry) {}
    virtual int32 GetNumPIELogins() { return 0; }
    virtual FString GetPIELoginCommandLineArgs(int32 Index) { return TEXT(""); }
    virtual void SetForceDedicated(FName OnlineIdentifier, bool bForce) {}
    virtual void LoginPIEInstance(FName OnlineIdentifier, int32 LocalUserNum, int32 PIELoginNum, FOnPIELoginComplete& CompletionDelegate) { CompletionDelegate.ExecuteIfBound(LocalUserNum, false, TEXT("Not implemented")); }
 
private:
 
    static ENGINE_API UOnlineEngineInterface* Singleton;
};