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 > Kismet > UPlatformGameInstance

Light Theme

Dark Theme

UPlatformGameInstance

[UObject](API\Runtime\CoreUObject\UObject\UObject) based class for handling mobile events.

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UGameInstance

UPlatformGameInstance

References

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

Syntax

class UPlatformGameInstance : public UGameInstance

Remarks

UObject based class for handling mobile events. Having this object as an option gives the app lifetime access to these global delegates. The component UApplicationLifecycleComponent is destroyed at level loads

Variables

	Name	Description
FPlatformFailed...	ApplicationFailedToRegisterForRemoteNotificationsDelegate	Called when the application fails to register for remote notifications
FPlatformDelega...	ApplicationHasEnteredForegroundDelegate	Called when the application is returning to the foreground (reverse any processing done in the EnterBackground delegate)
FPlatformDelega...	ApplicationHasReactivatedDelegate	Called when the application has been reactivated (reverse any processing done in the Deactivate delegate)
FPlatformReceiv...	ApplicationReceivedLocalNotificationDelegate	Called when the application receives a local notification
FPlatformReceiv...	ApplicationReceivedRemoteNotificationDelegate	Called when the application receives a remote notification
FPlatformScreen...	ApplicationReceivedScreenOrientationChangedNotificationDelegate	Called when the application receives a screen orientation change notification
FPlatformStartu...	ApplicationReceivedStartupArgumentsDelegate	Called with arguments passed to the application on statup, perhaps meta data passed on by another application which launched this one.
FPlatformRegist...	ApplicationRegisteredForRemoteNotificationsDelegate	Called when the user grants permission to register for remote notifications
FPlatformRegist...	ApplicationRegisteredForUserNotificationsDelegate	Called when the user grants permission to register for notifications
FPlatformDelega...	ApplicationShouldUnloadResourcesDelegate	Called when the OS is running low on resources and asks the application to free up any cached resources, drop graphics quality etc.
FPlatformDelega...	ApplicationWillDeactivateDelegate	This is called when the application is about to be deactivated (e.g., due to a phone call or SMS or the sleep button).
FPlatformDelega...	ApplicationWillEnterBackgroundDelegate	This is called when the application is being backgrounded (e.g., due to switching to another app or closing it via the home button) The game should release shared resources, save state, etc..., since it can be terminated from the background state without any further warning.
FPlatformDelega...	ApplicationWillTerminateDelegate	This may be called when the application is getting terminated by the OS.

Overridden from UObject

		Name	Description
	void	BeginDestroy()	Called before destroying the object.
	void	PostInitProperties()	Called after the C++ constructor and after the properties have been initialized, including those loaded from config.

Classes

	Name	Description
	FPlatformDelegate
	FPlatformFailedToRegisterForRemoteNotificationsDelegate
	FPlatformReceivedLocalNotificationDelegate
	FPlatformReceivedRemoteNotificationDelegate
	FPlatformRegisteredForRemoteNotificationsDelegate
	FPlatformRegisteredForUserNotificationsDelegate
	FPlatformScreenOrientationChangedDelegate
	FPlatformStartupArgumentsDelegate

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

Take our survey

Dismiss