FCoreDelegates

Syntax

class FCoreDelegates

Constructors

No constructors are accessible with public or protected access.

Functions

Name Description

Public function Static

FHotFixDeleg ...

 

GetHotfixDelegate

(
    EHotfixDelegates::Type HotFix
)

Get a hotfix delegate

Public function Static

FSimpleMulti...

 

GetMemoryTrimDelegate()

Called to request that systems free whatever memory they are able to.

Public function Static

FSimpleMulti...

 

GetOutOfMemoryDelegate()

Called when OOM event occurs, after backup memory has been freed, so there's some hope of being effective.

Public function Static

FPakEncrypti ...

 

GetPakEncryptionKeyDelegate()

Public function Static

FPakSigningK ...

 

GetPakSigningKeysDelegate()

Public function Static

FOnPreMainIn ...

 

GetPreMainInitDelegate()

Public function Static

FRegisterEnc ...

 

GetRegisterEncryptionKeyDelegate()

Enums

Name

Description

Public enum

EOnScreenMessageSeverity

Public enum

ETemperatureSeverity

IOS-style temperature updates, allowing game to scale down to let temp drop (to avoid thermal throttling on mobile, for instance)

Typedefs

Name

Description

FApplicationBackgroundSessionEventDelegate

FApplicationFailedToRegisterForRemoteNotificationsDelegate

FApplicationLicenseChange

Called when an application is notified that the application license info has been updated.

FApplicationLifetimeDelegate

IOS-style application lifecycle delegates

FApplicationPerformFetchDelegate

FApplicationReceivedLocalNotificationDelegate

FApplicationReceivedOnScreenOrientationChangedNotificationDelegate

Sent when a device screen orientation changes

FApplicationReceivedRemoteNotificationDelegate

FApplicationRegisteredForRemoteNotificationsDelegate

IOS-style push notification delegates

FApplicationRegisteredForUserNotificationsDelegate

FApplicationRequestAudioState

Generally, events triggering UserMusicInterruptDelegate or AudioMuteDelegate happen only when a change occurs.

FApplicationStartupArgumentsDelegate

FAudioMuteDelegate

[iOS only] Called when the mute switch is detected as changed or when the volume changes.

FAudioRouteChangedDelegate

[iOS only] Called when the audio device changes For instance, when the headphones are plugged in or removed

FConfigReadyForUse

Sent when GConfig is finished initializing

FCountPreLoadConfigFileRespondersDelegate

FGatherAdditionalLocResPathsDelegate

Delegate for gathering up additional localization paths that are unknown to the UE4 core (such as plugins)

FGetOnScreenMessagesDelegate

Called when displaying on screen messages (like the "Lighting needs to be rebuilt"), to let other systems add any messages as needed Sample Usage: void GetMyOnScreenMessages(FCoreDelegates::FSeverityMessageMap& OutMessages) { OutMessages.Add(FCoreDelegates::EOnScreenMessageSeverity::Info , FText::Format , SomeStatus)); }

FHotFixDelegate

Hot fix delegate

FIsLoadingMovieCurrentlyPlaying

FNoPakFilesMountedDelegate

Delegate to let other systems no that no paks were mounted, in case something wants to handle that case

FOnActorLabelChanged

Callback for object property modifications.

FOnApplyCVarFromIni

FOnAsyncLoadingFlush

Callback for platform handling when flushing async loads.

FOnAsyncLoadingFlushUpdate

Callback for a game thread interruption point when a async load flushing. Used to updating UI during long loads.

FOnAsyncLoadPackage

Callback on the game thread when an async load is started. This goes off before the packages has finished loading.

FOnCrashOverrideParamsChanged

Sent by application code to set params that customize crash reporting behavior.

FOnFConfigFileCreated

FOnFConfigFileDeleted

FOnGameSessionIDChange

Sent when application code changes the currently active game session.

FOnGameStateClassChange

Sent when application code changes game state.

FOnHandleSystemEnsure

Callback for handling an ensure.

FOnHandleSystemError

Callback for handling an error.

FOnInviteAccepted

Callback for handling accepting invitations - generally for engine code.

FOnIsVanillaProductChanged

Sent by engine code when the "vanilla" status of the engine changes

FOnLowPowerMode

Called when the OS goes into low power mode

FOnModalMessageBox

Delegate type for opening a modal message box ( Params: EAppMsgType::Type MessageType, const FText & Text, const FText & Title )

FOnMountAllPakFiles

Delegate type for prompting the pak system to mount all pak files, which haven't already been mounted, from all default locations

FOnMountPak

Delegate type for prompting the pak system to mount a new pak

FOnPreMainInit

Callback for platform specific very early init code.

FOnSafeFrameChangedEvent

Callback for handling safe frame area size changes.

FOnSyncLoadPackage

FOnSystemResolutionChanged

FOnTargetPlatformChangedSupportedFormats

Called when a target platform changes it's return value of supported formats. This is so anything caching those results can reset (like cached shaders for cooking)

FOnTemperatureChange

FOnUnmountPak

Delegate type for prompting the pak system to mount a new pak

FOnUserActivityStringChanged

Sent when application code changes the user activity hint string for analytics, crash reports, etc

FOnUserControllerConnectionChange

Callback for handling the Controller connection / disconnection first param is true for a connection, false for a disconnection.

FOnUserControllerPairingChange

Callback for handling a Controller pairing change first param is controller index second param is NewUserPlatformId, third is OldUserPlatformId.

FOnUserLoginChangedEvent

Callback for handling user login/logout. first int is UserID, second int is UserIndex.

FPakEncryptionKeyDelegate

Callback for accessing pak encryption key, if it exists.

FPakFileMountedDelegate

Delegate for handling when a new pak file is successfully mounted passes in the name of the mounted pak file

FPakSigningKeysDelegate

Callback for gathering pak signing keys, if they exist.

FPlatformChangedLaptopMode

Sent when the platform changed its laptop mode (for convertible laptops).

FPreLoadConfigFileDelegate

FPreSaveConfigFileDelegate

FRegisterEncryptionKeyDelegate

Callback for registering a new encryption key.

FRegisterMovieStreamerDelegate

Delegate used to register a movie streamer with any movie player modules that bind to this delegate.

FRenderingThreadChanged

Callback for notifications regarding changes of the rendering thread.

FResolvePackageNameDelegate

Callback to allow custom resolution of package names.

FSeverityMessageMap

FShouldLaunchUrl

Callback to allow user code to prevent url from being launched from FPlatformProcess::LaunchURL .

FStarvedGameLoop

Called when the main loop would otherwise starve.

FStatCheckEnabled

Checks to see if the stat is already enabled

FStatDisableAll

Sent when all stats need to be disabled

FStatDisabled

Sent after each stat is disabled

FStatEnabled

Sent after each stat is enabled

FUnRegisterMovieStreamerDelegate

Delegate used to un-register a movie streamer with any movie player modules that bind to this delegate.

FUserMusicInterruptDelegate

Called when the OS needs control of the music (parameter is true) or when the OS returns control of the music to the application (parameter is false).

FVRControllerRecentered

Sent when a 3DOF VR controller is recentered

FVRHeadsetConnectCanceled

Sent when connection to VR HMD connection is refused by the player

FVRHeadsetLost

Sent when connection to VR HMD is lost

FVRHeadsetPutOnHead

Sent when the VR HMD detects that it has been put on by the player.

FVRHeadsetRecenter

Sent when the platform requests a low-level VR recentering

FVRHeadsetReconnected

Sent when connection to VR HMD is restored

FVRHeadsetRemovedFromHead

Sent when the VR HMD detects that it has been taken off by the player.

FVRHeadsetTrackingInitializedDelegate

Sent when the platform finds that needed headset tracking on startup has completed (PS4 Morpheus only)

FVRHeadsetTrackingInitializingAndNeedsHMDToBeTrackedDelegate

Sent when the platform needs the user to fix headset tracking on startup (PS4 Morpheus only)

FWorldOriginOffset

Constants

Name

Description

ApplicationBackgroundSessionEventDelegate

Called when the application receives notice that a background download has completed

ApplicationFailedToRegisterForRemoteNotificationsDelegate

Called when the application fails to register for remote notifications

ApplicationHasEnteredForegroundDelegate

Called when the application is returning to the foreground (reverse any processing done in the EnterBackground delegate)

ApplicationHasReactivatedDelegate

Called when the application has been reactivated (reverse any processing done in the Deactivate delegate)

ApplicationLicenseChange

ApplicationPerformFetchDelegate

Called when the application receives notice to perform a background fetch

ApplicationReceivedLocalNotificationDelegate

Called when the application receives a local notification

ApplicationReceivedRemoteNotificationDelegate

Called when the application receives a remote notification

ApplicationReceivedScreenOrientationChangedNotificationDelegate

ApplicationReceivedStartupArgumentsDelegate

Called with arguments passed to the application on statup, perhaps meta data passed on by another application which launched this one.

ApplicationRegisteredForRemoteNotificationsDelegate

Called when the user grants permission to register for remote notifications

ApplicationRegisteredForUserNotificationsDelegate

Called when the user grants permission to register for notifications

ApplicationRequestAudioState

ApplicationShouldUnloadResourcesDelegate

Called when the OS is running low on resources and asks the application to free up any cached resources, drop graphics quality etc.

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).

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.

ApplicationWillTerminateDelegate

This may be called when the application is getting terminated by the OS.

AudioMuteDelegate

AudioRouteChangedDelegate

ColorPickerChanged

Color picker color has changed, please refresh as needed

ConfigReadyForUse

CountPreLoadConfigFileRespondersDelegate

CrashOverrideParamsChanged

GameSessionIDChanged

GameStateClassChanged

GatherAdditionalLocResPathsCallback

HotFixDelegates

Callbacks for hotfixes.

IsLoadingMovieCurrentlyPlaying

IsVanillaProductChanged

ModalErrorMessage

Requests to open a message box

NoPakFilesMountedDelegate

After an attempt to mount all pak files, but none wre found, this is called.

OnActorLabelChanged

Called when an actor label is changed.

OnApplyCVarFromIni

OnAsyncLoadingFlush

OnAsyncLoadingFlushUpdate

OnAsyncLoadPackage

OnBeginFrame

Called at the beginning of a frame.

OnBeginFrameRT

Called at the beginning of a frame on the renderthread.

OnControllerConnectionChange

Callback when controllers disconnected / reconnected.

OnControllerPairingChange

Callback when a single controller pairing changes.

OnEndFrame

Called at the end of a frame.

OnEndFrameRT

Called at the end of a frame on the renderthread.

OnExit

Called when the application is about to exit.

OnFConfigCreated

OnFConfigDeleted

OnFEngineLoopInitComplete

Called at the very end of engine initialization, right before the engine starts ticking. This is not called for commandlets.

OnGetOnScreenMessages

OnHandleSystemEnsure

Callback when an ensure has occurred.

OnHandleSystemError

Callback when an error (crash) has occurred.

OnInit

Called when appInit is called, very early in startup.

OnInviteAccepted

Called when the user accepts an invitation to the current game

OnLowPowerMode

OnMountAllPakFiles

Callback for mounting all the pak files in default locations.

OnMountPak

Callback for mounting a new pak file.

OnPostEngineInit

Called at the end of UEngine::Init , right before loading PostEngineInit modules for both normal execution and commandlets.

OnPreExit

Called when before the application is exiting.

OnSafeFrameChangedEvent

Callback when a user changes the safe frame size.

OnShutdownAfterError

Called when an error occurred.

OnSyncLoadPackage

OnSystemResolutionChanged

OnTargetPlatformChangedSupportedFormats

OnTemperatureChange

OnUnmountPak

Callback for unmounting a pak file.

OnUserLoginChangedEvent

Callback when a user logs in/out of the platform.

PackageNameResolvers

PakFileMountedCallback

After a pakfile is mounted this callback is called for each new file.

PlatformChangedLaptopMode

PostModal

Called after the editor dismisses a modal window, allowing other windows the opportunity to disable themselves to avoid reentrant calls.

PostRenderingThreadCreated

Sent just after the rendering thread has been created.

PostSlateModal

Called after the editor dismisses a Slate (non-platform) modal window, allowing other windows the opportunity to disable themselves to avoid reentrant calls.

PostWorldOriginOffset

Called after world origin shifting

PreLoadConfigFileDelegate

PreModal

Called before the editor displays a modal window, allowing other windows the opportunity to disable themselves to avoid reentrant calls.

PreRenderingThreadDestroyed

Sent just before the rendering thread is destroyed.

PreSaveConfigFileDelegate

PreSlateModal

Called before the editor displays a Slate (non-platform) modal window, allowing other windows the opportunity to disable themselves to avoid reentrant calls.

PreWorldOriginOffset

Called before world origin shifting

RegisterMovieStreamerDelegate

Delegate used to register a movie streamer with any movie player modules that bind to this delegate Designed to be called when a platform specific movie streamer plugin starts up so that it doesn't need to implement a register for all movie player plugins

ShouldLaunchUrl

StarvedGameLoop

StatCheckEnabled

StatDisableAll

StatDisabled

StatEnabled

UnRegisterMovieStreamerDelegate

Delegate used to un-register a movie streamer with any movie player modules that bind to this delegate Designed to be called when a platform specific movie streamer plugin shuts down so that it doesn't need to implement a register for all movie player plugins

UserActivityStringChanged

UserMusicInterruptDelegate

VRControllerRecentered

VRHeadsetConnectCanceled

VRHeadsetLost

VRHeadsetPutOnHead

VRHeadsetRecenter

VRHeadsetReconnected

VRHeadsetRemovedFromHead

VRHeadsetTrackingInitializedDelegate

VRHeadsetTrackingInitializingAndNeedsHMDToBeTrackedDelegate

References

Module

Core

Header

Runtime/Core/Public/Misc/CoreDelegates.h