GameEngine.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 "Widgets/SWindow.h"
#include "Widgets/SViewport.h"
#include "Engine/Engine.h"
#include "MovieSceneCaptureHandle.h"
#include "Templates/PimplPtr.h"
#include "GameEngine.generated.h"
 
class Error;
class FEngineConsoleCommandExecutor;
class FSceneViewport;
class UGameViewportClient;
class UNetDriver;
 
UCLASS(config=Engine, transient, MinimalAPI)
class UGameEngine
    : public UEngine
{
    GENERATED_UCLASS_BODY()
 
    
    UPROPERTY(config)
    float MaxDeltaTime;
 
    UPROPERTY(config)
    float ServerFlushLogInterval;
 
    UPROPERTY(transient)
    TObjectPtr<UGameInstance> GameInstance;
 
public:
 
    TWeakPtr<class SWindow> GameViewportWindow;
    TSharedPtr<class FSceneViewport> SceneViewport;
    TSharedPtr<class SViewport> GameViewportWidget;
    
    ENGINE_API void CreateGameViewportWidget( UGameViewportClient* GameViewportClient );
 
    ENGINE_API void CreateGameViewport( UGameViewportClient* GameViewportClient );
    
    static ENGINE_API TSharedRef<SWindow> CreateGameWindow();
 
    static ENGINE_API void SafeFrameChanged();
 
    static ENGINE_API void EnableGameWindowSettingsOverride(bool bEnabled);
 
    static ENGINE_API void ConditionallyOverrideSettings( int32& ResolutionX, int32& ResolutionY, EWindowMode::Type& WindowMode );
    
    static ENGINE_API void DetermineGameWindowResolution( int32& ResolutionX, int32& ResolutionY, EWindowMode::Type& WindowMode, bool bUseWorkAreaForWindowed = false );
 
    ENGINE_API void SwitchGameWindowToUseGameViewport();
 
    ENGINE_API void OnGameWindowClosed( const TSharedRef<SWindow>& WindowBeingClosed );
    
    UE_DEPRECATED(5.6, "Replaced by private OnGameWindowMoved_SavePosition function.")
    ENGINE_API void OnGameWindowMoved( const TSharedRef<SWindow>& WindowBeingMoved );
 
    ENGINE_API virtual void RedrawViewports( bool bShouldPresent = true ) override;
 
    ENGINE_API void OnViewportResized(FViewport* Viewport, uint32 Unused);
 
    ENGINE_API void OnGPUCrash();
 
public:
 
    // UObject interface
 
    ENGINE_API virtual void FinishDestroy() override;
 
public:
 
    // UEngine interface
 
    ENGINE_API virtual void Init(class IEngineLoop* InEngineLoop) override;
    ENGINE_API virtual void Start() override;
    ENGINE_API virtual void PreExit() override;
    ENGINE_API virtual void Tick( float DeltaSeconds, bool bIdleMode ) override;
    ENGINE_API virtual float GetMaxTickRate( float DeltaTime, bool bAllowFrameRateSmoothing = true ) const override;
    ENGINE_API virtual void ProcessToggleFreezeCommand( UWorld* InWorld ) override;
    ENGINE_API virtual void ProcessToggleFreezeStreamingCommand( UWorld* InWorld ) override;
    ENGINE_API virtual bool NetworkRemapPath(UNetConnection* Connection, FString& Str, bool bReading = true) override;
    ENGINE_API virtual bool ShouldDoAsyncEndOfFrameTasks() const override;
 
public:
 
    // FExec interface
#if UE_ALLOW_EXEC_COMMANDS
    ENGINE_API virtual bool Exec( UWorld* InWorld, const TCHAR* Cmd, FOutputDevice& Ar=*GLog ) override;
#endif
 
public:
 
    // Exec command handlers
    ENGINE_API bool HandleCommand( const TCHAR* Cmd, FOutputDevice& Ar );
    ENGINE_API bool HandleExitCommand( const TCHAR* Cmd, FOutputDevice& Ar );
    ENGINE_API bool HandleMinimizeCommand( const TCHAR *Cmd, FOutputDevice &Ar );
    ENGINE_API bool HandleGetMaxTickRateCommand( const TCHAR* Cmd, FOutputDevice& Ar );
    ENGINE_API bool HandleCancelCommand( const TCHAR* Cmd, FOutputDevice& Ar, UWorld* InWorld );
 
#if !UE_BUILD_SHIPPING
    ENGINE_API bool HandleApplyUserSettingsCommand( const TCHAR* Cmd, FOutputDevice& Ar );
#endif // !UE_BUILD_SHIPPING
 
    virtual TSharedPtr<SViewport> GetGameViewportWidget() const override
    {
        return GameViewportWidget;
    }
 
    ENGINE_API UWorld* GetGameWorld();
 
protected:
 
    ENGINE_API FSceneViewport* GetGameSceneViewport(UGameViewportClient* ViewportClient) const;
 
    FMovieSceneCaptureHandle StartupMovieCaptureHandle;
 
    ENGINE_API virtual void HandleBrowseToDefaultMapFailure(FWorldContext& Context, const FString& TextURL, const FString& Error) override;
 
private:
 
    ENGINE_API virtual void HandleNetworkFailure_NotifyGameInstance(UWorld* World, UNetDriver* NetDriver, ENetworkFailure::Type FailureType) override;
    ENGINE_API virtual void HandleTravelFailure_NotifyGameInstance(UWorld* World, ETravelFailure::Type FailureType) override;
 
    void OnGameWindowMoved_SavePosition(const TSharedRef<SWindow>& WindowBeingMoved, int32 SaveWinPosIndex);
 
    double LastTimeLogsFlushed;
 
    TPimplPtr<FEngineConsoleCommandExecutor> CmdExec;
};