FCoreDelegates

References

Module

Core

Header

/Engine/Source/Runtime/Core/Public/Misc/CoreDelegates.h

Include

#include "Misc/CoreDelegates.h"

Syntax

class FCoreDelegates

Constructors

No constructors are accessible with public or protected access.

Functions

Name Description

Public function Static

TTSMulticast...

 

GetApplicationWillTerminateDelegate()

Public function Static

TMulticastDe...

 

GetGPUOutOfMemoryDelegate()

Called from TerminateOnOutOfMemory in D3D11Util.cpp/D3D12Util.cpp.

Public function Static

TDelegate< v...

 

GetHotfixDelegate

(
    EHotfixDelegates::Type HotFix
)

Get a hotfix delegate

Public function Static

FSimpleMulti...

 

GetLowLevelAllocatorMemoryTrimDelegate()

Called to request that low level allocator free whatever memory they are able to.

Public function Static

FSimpleMulti...

 

GetMemoryTrimDelegate()

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

Public function Static

TTSMulticast...

 

GetOnFileOpenedForReadFromPakFile()

Public function Static

TTSMulticast...

 

GetOnPakFileMounted2()

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

TDelegate< v...

 

GetPakEncryptionKeyDelegate()

Public function Static

TDelegate< v...

 

GetPakSigningKeysDelegate()

Public function Static

TMulticastDe...

 

GetPreMainInitDelegate()

Callback for platform specific very early init code.

Public function Static

FSimpleMulti...

 

GetRefreshLowLevelAllocatorDelegate()

Called to request that low level allocator must refreshed.

Public function Static

TMulticastDe...

 

GetRegisterEncryptionKeyMulticastDelegate()

Public function Static

TTSMulticast...

 

TSAccessExtraBinaryConfigData()

Public function Static

TTSMulticast...

 

TSConfigReadyForUse()

Sent when GConfig is finished initializing

Public function Static

TTSMulticast...

 

TSCountPreLoadConfigFileRespondersDelegate()

Public function Static

TTSMulticast...

 

TSOnConfigSectionNameRead()

Public function Static

TTSMulticast...

 

TSOnConfigSectionRead()

Public function Static

TTSMulticast...

 

TSOnConfigSectionsChanged()

Public function Static

TTSMulticast...

 

TSOnConfigValueRead()

Public function Static

TTSMulticast...

 

TSOnFConfigCreated()

Public function Static

TTSMulticast...

 

TSOnFConfigDeleted()

Public function Static

TTSMulticast...

 

TSPreLoadConfigFileDelegate()

Public function Static

TTSMulticast...

 

TSPreSaveConfigFileDelegate()

Classes

Name

Description

Public struct

FExtraBinaryConfigData

Callback to let code read or write specialized binary data that is generated at Stage time, for optimizing data right before final game data is being written to disk The TMap is a map of an identifier for owner of the data, and a boolean where true means the data is being generated (ie editor), and false means the data is for use (ie runtime game)

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

FAttachShaderReadRequestFunc

FMovieStreamerPtr

FOnDisallowedExecCommandCalled

Called when FExec::Exec is called in a context where it's disallowed (UE_ALLOW_EXEC_COMMANDS = 0).

FOnNamedCommandParsed

Called when FParse::Command succeeds. Used to audit named commands usage.

FOnNetworkConnectionChanged

FSeverityMessageMap

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

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

ApplicationNetworkInitializationChanged

Called when the application's network initializes or shutdowns on platforms where the network stack is not always available

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

Sent when a device screen orientation changes

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

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

ApplicationShouldUnloadResourcesDelegate

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

ApplicationSystemUIOverlayStateChangedDelegate

Some platform have a System UI Overlay that can draw on top of the application.

ApplicationWillDeactivateDelegate

IOS-style application lifecycle delegates 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

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

AudioRouteChangedDelegate

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

ColorPickerChanged

Color picker color has changed, please refresh as needed

CrashOverrideParamsChanged

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

CreatePackageStore

GameSessionIDChanged

Sent when application code changes the currently active game session.

GameStateClassChanged

Sent when application code changes game state.

GatherAdditionalLocResPathsCallback

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

HotFixDelegates

Callbacks for hotfixes.

IsLoadingMovieCurrentlyPlaying

IsVanillaProductChanged

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

LaunchCustomHandlerForURL

Callback to allow user code to implement a custom implementation for FPlatformProcess::LaunchURL. (Windows Only)

MobileBackgroundTickDelegate

Called when in the background, if the OS is giving CPU time to the device.

ModalMessageDialog

Requests to open a message box

MountPak

Callback to prompt the pak system to mount a pak file.

NewFileAddedDelegate

After a file is added this is called.

NoPakFilesMountedDelegate

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

OnActivatedByProtocol

Callback when the application has been activated by protocol (with optional user id, depending on the platform)

OnActorLabelChanged

Called when an actor label is changed.

OnAllModuleLoadingPhasesComplete

Called after all modules have been loaded for all phases.

OnApplyCVarFromIni

OnAsyncLoadingFlush

Callback for platform handling when flushing async loads.

OnAsyncLoadingFlushUpdate

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

OnAsyncLoadPackage

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

OnBeginFrame

Called at the beginning of a frame.

OnBeginFrameRT

Called at the beginning of a frame on the renderthread.

OnChildEndFramePostFork

Called at the end of the frame where the process spawned a fork.

OnCommandletPostMain

Called after running the Main function for commandlets.

OnCommandletPreMain

Called prior to running the Main function for commandlets.

OnControllerConnectionChange

Callback when controllers disconnected / reconnected

OnControllerPairingChange

Callback when a single controller pairing changes

OnDisallowedExecCommandCalled

OnEndFrame

Called at the end of a frame.

OnEndFrameRT

Called at the end of a frame on the renderthread.

OnEnginePreExit

Called before the engine exits. Separate from OnPreExit as OnEnginePreExit occurs before shutting down any core modules.

OnExit

Called when the application is about to exit.

OnFeatureLevelDisabled

Called when a feature level is disabled by the user.

OnFEngineLoopInitComplete

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

OnFileOpenedForReadFromPakFile

When a file is opened for read from a pak file.

OnGCFinishDestroyTimeExtended

Sent when GC finish destroy takes more time than expected

OnGetBuildURL

Extension point for projects to report the URL for a continuous integration job which produced these binaries.

OnGetExecutingJobURL

Extension point for projects to report the URL for a continuous integration job which is currently executing this process.

OnGetOnScreenMessages

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)); }

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

OnLogVerbosityChanged

Called when the verbosity of a log category is changed

OnLowPowerMode

Called when the OS goes into low power mode

OnMountAllPakFiles

Callback for mounting all the pak files in default locations.

OnNamedCommandParsed

OnNetworkConnectionChanged

OnNetworkConnectionStatusChanged

Called when the connection state as reported by the platform changes

OnOptimizeMemoryUsageForMountedPaks

Callback to optimize memeory for currently mounted paks.

OnOutputDevicesInit

Called during FEngineLoop::PreInit after GWarn & GError have been first set so that they can be overridden before anything in PreInit uses them.

OnPakFileMounted2

After a pakfile is mounted this is called

OnParentBeginFork

Called immediately before the parent process will start responding to signals to fork.

OnParentPreFork

Called each time immediately before the parent process forks itself.

OnPostEngineInit

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

OnPostFork

Called immediately after the process spawned a fork.

OnPreExit

Called when before the application is exiting.

OnSafeFrameChangedEvent

Callback when a user changes the safe frame size.

OnSamplingInput

Called at the moment of sampling the input (currently on the gamethread)

OnShutdownAfterError

Called when an error occurred.

OnSyncLoadPackage

OnSystemResolutionChanged

OnTargetPlatformChangedSupportedFormats

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)

OnTemperatureChange

OnUnmountPak

Callback to prompt the pak system to unmount a pak file.

OnUserLoginChangedEvent

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

PackageNameResolvers

Callback to allow custom resolution of package names.

PlatformChangedLaptopMode

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

PostModal

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

PostRenderingThreadCreated

Callback for notifications regarding changes of the rendering thread.

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

PreloadPackageShaderMaps

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.

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

ReleasePreloadedPackageShaderMaps

ShouldLaunchUrl

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

StarvedGameLoop

Called when the main loop would otherwise starve.

StatCheckEnabled

Checks to see if the stat is already enabled

StatDisableAll

Sent when all stats need to be disabled

StatDisabled

Sent after each stat is disabled

StatEnabled

Sent after each stat is enabled

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

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

UserMusicInterruptDelegate

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

VRControllerRecentered

Sent when a 3DOF VR controller is recentered

VRHeadsetConnectCanceled

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

VRHeadsetLost

Sent when connection to VR HMD is lost

VRHeadsetPutOnHead

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

VRHeadsetRecenter

Sent when the platform requests a low-level VR recentering

VRHeadsetReconnected

Sent when connection to VR HMD is restored

VRHeadsetRemovedFromHead

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

VRHeadsetTrackingInitializedDelegate

Sent when the platform finds that needed headset tracking on startup has completed (Most platforms do not need this.)

VRHeadsetTrackingInitializingAndNeedsHMDToBeTrackedDelegate

Sent when the platform needs the user to fix headset tracking on startup (Most platforms do not need this.)

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