1. Epic GamesDeveloper
  3. UGameEngine

UGameEngine

Engine that manages core systems that enable a game.

Unreal Engine C++ API Reference > Runtime > Engine > Engine

Inheritance Hierarchy

References

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

Syntax

UCLASS (Config=Engine, Transient, MinimalAPI)  
class UGameEngine : public UEngine

Remarks

Engine that manages core systems that enable a game.

Variables

  Type Name Description
Public variable UProperty Transient TObjectPtr< UGameInstance > GameInstance  
Public variable TSharedPtr< class SViewport > GameViewportWidget The game viewport widget
Public variable TWeakPtr< class SWindow > GameViewportWindow The game viewport window
Public variable UProperty Config float MaxDeltaTime Maximium delta time the engine uses to populate FApp::DeltaTime. If 0, unbound.
Public variable TSharedPtr< class FSceneViewport > SceneViewport The primary scene viewport
Public variable UProperty Config float ServerFlushLogInterval Maximium time (in seconds) between the flushes of the logs on the server (best effort).
Protected variable FMovieSceneCaptureHandle StartupMovieCaptureHandle Handle to a movie capture implementation to create on startup

Constructors

  Type Name Description
Public function  

UGameEngine ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Static void

ConditionallyOverrideSettings ( int32& ResolutionX,
int32& ResolutionY,
EWindowMode::Type& WindowMode
)

 Modifies the game window resolution settings if any overrides have been specified on the command line and overrides are enabled (see EnableGameWindowSettingsOverride)
Public function void

CreateGameViewport ( UGameViewportClient* GameViewportClient
)

 Creates the game viewport
Public function void Creates the viewport widget where the games Slate UI is added to.
Public function Static TSharedRef< SWindow > Creates the game window
Public function Static void

DetermineGameWindowResolution ( int32& ResolutionX,
int32& ResolutionY,
EWindowMode::Type& WindowMode,
bool bUseWorkAreaForWindowed
)

 Determines the resolution of the game window, ensuring that the requested size is never bigger than the available desktop size
Public function Static void Enables/disables game window resolution setting overrides specified on the command line (true by default)
Protected function Const FSceneViewport *  
Public function UWorld * This is a global, parameterless function used by the online subsystem modules.
Public function bool  
Public function bool

HandleCancelCommand ( const TCHAR* Cmd,
FOutputDevice& Ar,
UWorld* InWorld
)

  
Public function bool

HandleCommand ( const TCHAR* Cmd,
FOutputDevice& Ar
)

 Exec command handlers.
Public function bool

HandleExitCommand ( const TCHAR* Cmd,
FOutputDevice& Ar
)

  
Public function bool  
Public function bool  
Public function void

OnGameWindowClosed ( const TSharedRef< SWindow >& WindowBeingClosed
)

 Called when the game window closes (ends the game)
Public function void

OnGameWindowMoved ( const TSharedRef< SWindow >& WindowBeingMoved
)

 Called when the game window is moved
Public function void

OnViewportResized ( FViewport* Viewport,
uint32 Unused
)

  
Public function Static void  
Public function void Changes the game window to use the game viewport instead of any loading screen or movie that might be using it instead

Overridden from UEngine

  Type Name Description
Public function Virtual Const TSharedPtr< SViewport > Returns the GameViewport widget
Public function Virtual Const float

GetMaxTickRate ( float DeltaTime,
bool bAllowFrameRateSmoothing
)

 Get tick rate limiter.Get tick rate limitor.
Protected function Virtual void

HandleBrowseToDefaultMapFailure ( FWorldContext& Context,
const FString& TextURL,
const FString& Error
)

 Attempts to gracefully handle a failure to travel to the default map.
Public function Virtual void

Init ( IEngineLoop* InEngineLoop
)

 Initialize the game engine.
Public function Virtual bool

NetworkRemapPath ( UNetConnection* Connection,
FString& Str,
bool bReading
)

  
Public function Virtual void

PreExit ()

 Called at shutdown, just before the exit purge.
Public function Virtual void Handles freezing/unfreezing of rendering
Public function Virtual void Handles frezing/unfreezing of streaming
Public function Virtual void

RedrawViewports ( bool bShouldPresent
)

 Redraws all viewports.
Public function Virtual Const bool  
Public function Virtual void

Start ()

 Start the game, separate from the initialize call to allow for post initialize configuration before the game starts.
Public function Virtual void

Tick ( float DeltaSeconds,
bool bIdleMode
)

 Update everything.

Overridden from UObject

  Type Name Description
Public function Virtual void Called to finish destroying the object.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page