Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Engine > Engine > UGameInstance

Light Theme

Dark Theme

UGameInstance

GameInstance: high-level manager object for an instance of the running game.

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UGameInstance

UPlatformGameInstance

References

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

Syntax

class UGameInstance :
public UObject,
public FExec

Remarks

GameInstance: high-level manager object for an instance of the running game. Spawned at game creation and not destroyed until game instance is shut down. Running as a standalone game, there will be one of these. Running in PIE (play-in-editor) will generate one of these per PIE instance.

Variables

	Name	Description
FLatentActionMa...	LatentActionManager
TArray< ULocalP...	LocalPlayers	List of locally participating players in this game instance
FOnPreClientTra...	NotifyPreClientTravelDelegates	Listeners to PreClientTravel call
UOnlineSession ...	OnlineSession	Class to manage online services
FOnLocalPlayerE...	OnLocalPlayerAddedEvent	Local player access
FOnLocalPlayerE...	OnLocalPlayerRemovedEvent
FDelegateHandle	OnPlayTogetherEventReceivedDelegateHandle	Handle for delegate for handling PS4 play together system events
FString	PIEMapName
double	PIEStartTime
TArray< UObject...	ReferencedObjects	List of objects that are being kept alive by this game instance.
FTimerManager &...	TimerManager
FWorldContext &...	WorldContext

Constructors

	Name	Description
	UGameInstance ( const FObjectInitializer& ObjectIn... )

Functions

	Name	Description
int32	AddLocalPlayer ( ULocalPlayer* NewPlayer, int32 ControllerId )	Adds a LocalPlayer to the local and global list of Players.
void	AddUserToReplay ( const FString& UserString )	Adds a join-in-progress user to the set of users associated with the currently recording replay (if any)
void	CleanupGameViewport()
bool	ClientTravelToSession ( int32 ControllerId, FName InSessionName )	Helper function for traveling to a session that has already been joined via the online platform Grabs the URL from the session info and travels
AGameModeBas...	CreateGameModeForURL ( FURL InURL, UWorld* InWorld )	Call to create the game mode for a given map URL
ULocalPlayer...	CreateInitialPlayer ( FString& OutError )
ULocalPlayer...	CreateLocalPlayer ( int32 ControllerId, FString& OutError, bool bSpawnPlayerController )	Adds a new player.
void	CreateMinimalNetRPCWorld ( const FName InPackageName, UPackage& OutWorldPackage, UWorld& OutWorld )	Static util function used by InitializeForMinimalNetRPC and LoadMap to create the minimal world suitable for basic network RPC
void	DebugCreatePlayer ( int32 ControllerId )	Debug console command to create a player.
void	DebugRemovePlayer ( int32 ControllerId )	Debug console command to remove the player with a given controller ID.
bool	DelayPendingNetGameTravel()	Return true to delay an otherwise ready-to-join PendingNetGame performing LoadMap() and finishing up useful to wait for content downloads, etc
ULocalPlayer...	FindLocalPlayerFromControllerId ( const int32 ControllerId )
ULocalPlayer...	FindLocalPlayerFromUniqueNetId ( const FUniqueNetId& UniqueNetId )
ULocalPlayer...	FindLocalPlayerFromUniqueNetId ( TSharedPtr< const FUniqueNetId > Un... )
UEngine *...	GetEngine()
ULocalPlayer...	GetFirstGamePlayer()
APlayerContr...	GetFirstLocalPlayerController ( const UWorld* World )
UGameViewpor...	GetGameViewportClient()
FLatentActio...	GetLatentActionManager()
ULocalPlayer...	GetLocalPlayerByIndex ( const int32 Index )
TArray< ULoc...	GetLocalPlayerIterator()
const TArray...	GetLocalPlayers()
int32	GetNumLocalPlayers()
FName	GetOnlinePlatformName()	Retrieves the name of the online subsystem for the platform used by this instance.
UOnlineSessi...	GetOnlineSession()
TSubclassOf<...	GetOnlineSessionClass()
APlayerContr...	GetPrimaryPlayerController()	Get the primary player controller on this machine (others are splitscreen children) (must have valid player state and unique id)
TSharedPtr< ...	GetPrimaryPlayerUniqueId()	Get the unique id for the primary player on this machine (others are splitscreen children)
TSubsystemCl...	GetSubsystem()	Get a Subsystem of specified type
TSubsystemCl...	GetSubsystem ( const UGameInstance* GameInsta... )	Get a Subsystem of specified type from the provided GameInstance returns nullptr if the Subsystem cannot be found or the GameInstance is null
const TArray...	GetSubsystemArray()	Get all Subsystem of specified type, this is only necessary for interfaces that can have multiple implementations instanced at a time.
UGameInstanc...	GetSubsystemBase ( TSubclassOf< UGameInstanceSubsystem... )	Get a Subsystem of specified type
FTimerManage...	GetTimerManager()
UWorld *	GetWorld()
FWorldContex...	GetWorldContext()
void	HandleDemoPlaybackFailure ( EDemoPlayFailure::Type FailureType, const FString& ErrorString )	Called when demo playback fails for any reason
bool	HandleDisconnectCommand ( const TCHAR* Cmd, FOutputDevice& Ar, UWorld* InWorld )
void	HandleGameNetControlMessage ( UNetConnection* Connection, uint8 MessageByte, const FString& MessageStr )	Handle a game specific net control message (NMT_GameSpecific) this allows games to insert their own logic into the control channel the meaning of both data parameters is game-specific
void	HandleNetworkError ( ENetworkFailure::Type FailureType, bool bIsServer )	Opportunity for blueprints to handle network errors.
bool	HandleOpenCommand ( const TCHAR* Cmd, FOutputDevice& Ar, UWorld* InWorld )
bool	HandleReconnectCommand ( const TCHAR* Cmd, FOutputDevice& Ar, UWorld* InWorld )
bool	HandleTravelCommand ( const TCHAR* Cmd, FOutputDevice& Ar, UWorld* InWorld )
void	HandleTravelError ( ETravelFailure::Type FailureType )	Opportunity for blueprints to handle travel errors.
void	Init()	Virtual function to allow custom GameInstances an opportunity to set up what it needs
void	InitializeForMinimalNetRPC ( const FName InPackageName )	Called to initialize the game instance with a minimal world suitable for basic network RPC
FGameInstanc...	InitializeForPlayInEditor ( int32 PIEInstanceIndex, const FGameInstancePIEParameters& ... )	Called to initialize the game instance for PIE instances of the game
void	InitializeStandalone ( const FName InWorldName, UPackage* InWorldPackage )	Called to initialize the game instance for standalone instances of the game
bool	IsDedicatedServerInstance()	Returns true if this instance is for a dedicated server world
bool	JoinSession ( ULocalPlayer* LocalPlayer, int32 SessionIndexInSearchResults )
bool	JoinSession ( ULocalPlayer* LocalPlayer, const FOnlineSessionSearchResult& ... )
void	LoadComplete ( const float LoadTime, const FString& MapName )
void	NotifyPreClientTravel ( const FString& PendingURL, ETravelType TravelType, bool bIsSeamlessTravel )	Broadcast a notification that travel is occurring
void	OnConsoleInput ( const FString& Command )	Delegate for handling external console commands
FOnPreClient...	OnNotifyPreClientTravel()
void	OnPlayTogetherEventReceived ( int32 UserIndex, const TArray< const FUniqueNetId& ... )	Delegate for handling PS4 play together system events
void	OnSeamlessTravelDuringReplay()	This gets called when the player scrubs in a replay to a different level
void	OnStart()	Called when the game instance is started either normally or through PIE.
void	OnWorldChanged ( UWorld* OldWorld, UWorld* NewWorld )	Callback from the world context when the world changes
TSubclassOf<...	OverrideGameModeClass ( TSubclassOf< AGameModeBase > GameMo..., const FString& MapName, const FString& Options, const FString& Portal )	Return the game mode subclass to use for a given map, options, and portal.
bool	PlayReplay ( const FString& InName, UWorld* WorldOverride, const TArray< FString >& Additiona... )	Start playing back a previously recorded replay.
bool	PlayReplayPlaylist ( const FReplayPlaylistParams& Playl... )	Start playing back a playlist of previously recorded replays.
FGameInstanc...	PostCreateGameModeForPIE ( const FGameInstancePIEParameters& ..., AGameModeBase* GameMode )	Called as soon as the game mode is spawned, to allow additional PIE setting validation prior to creating the local players / etc...
void	PreloadContentForURL ( FURL InURL )	Call to preload any content before loading a map URL, used during seamless travel as well as map loading
void	ReceivedNetworkEncryptionAck ( const FOnEncryptionKeyResponse& De... )	Called when a client receives the EncryptionAck control message from the server, will generally enable encryption.
void	ReceivedNetworkEncryptionToken ( const FString& EncryptionToken, const FOnEncryptionKeyResponse& De... )	Handle setting up encryption keys.
void	ReceiveInit()	Opportunity for blueprints to handle the game instance being initialized.
void	ReceiveShutdown()	Opportunity for blueprints to handle the game instance being shutdown.
void	RegisterReferencedObject ( UObject* ObjectToReference )	Registers an object to keep alive as long as this game instance is alive
bool	RemoveLocalPlayer ( ULocalPlayer* ExistingPlayer )	Removes a player.
void	ReturnToMainMenu()	Calls HandleDisconnect on either the OnlineSession if it exists or the engine, to cause a travel back to the default map.
void	Shutdown()	Virtual function to allow custom GameInstances an opportunity to do cleanup when shutting down
void	StartGameInstance()	Starts the GameInstance state machine running
FGameInstanc...	StartPlayInEditorGameInstance ( ULocalPlayer* LocalPlayer, const FGameInstancePIEParameters& ... )	Called to actually start the game when doing Play/Simulate In Editor
void	StartRecordingReplay ( const FString& InName, const FString& FriendlyName, const TArray< FString >& Additiona... )	Start recording a replay with the given custom name and friendly name.
void	StopRecordingReplay()	Stop recording a replay if one is currently in progress
void	UnregisterReferencedObject ( UObject* ObjectToReference )	Remove a referenced object, this will allow it to GC out

Overridden from UObject

		Name	Description
	void	FinishDestroy()	Called to finish destroying the object.

Overridden from FExec

		Name	Description
	bool	Exec ( UWorld* InWorld, const TCHAR* Cmd, FOutputDevice& Ar )	Exec handler

Deprecated Functions

		Name	Description
	bool	InitializePIE ( bool bAnyBlueprintErrors, int32 PIEInstance, bool bRunAsDedicated )	Please override InitializeForPIE instead
	bool	StartPIEGameInstance ( ULocalPlayer* LocalPlayer, bool bInSimulateInEditor, bool bAnyBlueprintErrors, bool bStartInSpectatorMode )	Please override StartPlayInEditorGameInstance instead

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss