description: TestInvalid

code: template<typename ValueType> bool TestValid ( const TCHAR * Description, const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< ValueType > & SharedPointer )


description: Helper method to clear out the results from a previous execution

module: Core

code: void Clear()


code: void AddWarning ( const [FString](API\Runtime\Core\Containers\FString) & WarningMessage )


code: const [FString](API\Runtime\Core\Containers\FString) & GetContext() const


description: Any errors that occurred during execution

code: const [TArray](API\Runtime\Core\Containers\TArray)< [FAutomationExecutionEntry](API\Runtime\Core\Misc\FAutomationExecutionEntry) > & GetEntries() const


code: void PushContext ( const [FString](API\Runtime\Core\Containers\FString) & Context )


code: int32 RemoveAllEvents ( EAutomationEventType EventType )


code: int32 RemoveAllEvents ( [TFunctionRef](API\Runtime\Core\GenericPlatform\TFunctionRef)< bool([FAutomationEvent](API\Runtime\Core\Misc\FAutomationEvent) &)> FilterPredicate )


description: Constructor

code: FAutomationTestExecutionInfo()


description: Destructor

code: ~FAutomationTestExecutionInfo()


className: FAutomationTestExecutionInfo

description: Simple class to store the results of the execution of a automation test

code: class FAutomationTestExecutionInfo

AnalyticsItems

type: TArray<FString...

description: Any analytics items that occurred during execution

bSuccessful

type: bool

description: Whether the automation test completed successfully or not

Duration

type: double

description: Time to complete the task

TelemetryItems

type: TArray<FAutoma...

description: Telemetry items that occurred during execution

TelemetryStorage

type: FString

description: Telemetry storage name set by the test


description: Adds a analytics string to the current test to be parsed later. Must be called only when an automation test is in progress

code: void AddAnalyticsItemToCurrentTest ( const [FString](API\Runtime\Core\Containers\FString) & AnalyticsItem )


description:
Internal helper method designed to check if the given test is able to run in the current environment.
true if the test is able to run; false if it is unable to run.

code: bool CanRunTestInEnvironment ( const [FString](API\Runtime\Core\Containers\FString) & InTestToRun, [FString](API\Runtime\Core\Containers\FString) * OutReason, bool * OutWarn ) const


description:
Checks if a provided test is contained within the framework.
true if the provided test is within the framework; false otherwise

code: bool ContainsTest ( const [FString](API\Runtime\Core\Containers\FString) & InTestName ) const


description: Dequeue all latent and network commands

code: void DequeueAllCommands()


description: Enqueues a latent command for execution on a subsequent frame

code: void EnqueueLatentCommand ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IAutomationLatentCommand](API\Runtime\Core\Misc\IAutomationLatentCommand) > NewCommand )


description: Enqueues a network command for execution in accordance with this workers role

code: void EnqueueNetworkCommand ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IAutomationNetworkCommand](API\Runtime\Core\Misc\IAutomationNetworkCommand) > NewCommand )


description: Execute all latent functions that complete during update

code: bool ExecuteLatentCommands()


description: Execute the next network command if you match the role, otherwise just dequeue

code: bool ExecuteNetworkCommands()


description:
Return the singleton instance of the framework.
The singleton instance of the framework.

code: static [FAutomationTestFramework](API\Runtime\Core\Misc\FAutomationTestFramework) & Get()


description: Returns the actively executing test or null if there isn't one

code: [FAutomationTestBase](API\Runtime\Core\Misc\FAutomationTestBase) * GetCurrentTest() const


code: static [FAutomationTestFramework](API\Runtime\Core\Misc\FAutomationTestFramework) & GetInstance()


description: Gets a scratch space location outside of the project and saved directories. When an automation test needs to do something like generate project files, or create new projects it should use this directory, rather than pollute other areas of the machine.


description: Populates the provided array with the names of all tests in the framework that are valid to run for the current application settings.

code: void GetValidTestNames ( [TArray](API\Runtime\Core\Containers\TArray)< [FAutomationTestInfo](API\Runtime\Core\Misc\FAutomationTestInfo) > & TestInfo ) const


description: Whether there is no latent command in queue

code: bool IsLatentCommandQueueEmpty() const


description: Load any modules that are not loaded by default and have test classes in them

code: void LoadTestModules()


description: Whether to output blueprint functional test metadata to the log when test is running

code: static bool NeedLogBPTestMetadata()


code: void NotifyPerformanceDataRetrieved ( bool bSuccess, const [FString](API\Runtime\Core\Containers\FString) & ErrorMessage )


description: Whether to skip stack walk while iterating for listing the tests

code: static bool NeedSkipStackWalk()


code: void NotifyScreenshotComparisonComplete ( const [FAutomationScreenshotCompareResults](API\Runtime\Core\Misc\FAutomationScreenshotCompareResu-) & CompareResults )


code: void NotifyScreenshotTakenAndCompared()


code: void NotifyTestDataRetrieved ( bool bWasNew, const [FString](API\Runtime\Core\Containers\FString) & JsonData )


description: Accessor for delegate called when a png screenshot is captured and a frame trace


description: Accessor for delegate called when a png screenshot is captured


description: Reset status of worker (delete local files, etc)

code: void ResetTests()


description:
Register a automation test into the framework. The automation test may or may not be necessarily valid for the particular application configuration, but that will be determined when tests are attempted to be run.
true if the test was successfully registered; false if a test was already registered under the same name as before

code: bool RegisterAutomationTest ( const [FString](API\Runtime\Core\Containers\FString) & InTestNameToRegister, [FAutomationTestBase](API\Runtime\Core\Misc\FAutomationTestBase) * InTestToRegister )


description:
Attempt to run all fast smoke tests that are valid for the current application configuration.
true if all smoke tests run were successful, false if any failed

code: bool RunSmokeTests()


description: Sets forcing smoke tests.

code: void SetForceSmokeTests ( const bool bInForceSmokeTests )


description: Sets whether we want to include content in developer directories in automation testing

code: void SetDeveloperDirectoryIncluded ( const bool bInDeveloperDirectoryIncluded )


description: Sets which set of tests to pull from.

code: void SetRequestedTestFilter ( const uint32 InRequestedTestFlags )


description: Used to disabled stack capture when an error or warning event is triggered. Setting bCapture=true does not guaranteesGetCaptureStack()=true because that method also depend onNeedSkipStackWalk().

code: void SetCaptureStack ( bool bCapture )


description: Whether the testing framework should allow content to be tested or not. Intended to block developer directories.

code: bool ShouldTestContent ( const [FString](API\Runtime\Core\Containers\FString) & Path ) const


description: Attempt to start the specified test.

code: void StartTestByName ( const [FString](API\Runtime\Core\Containers\FString) & InTestToRun, const int32 InRoleIndex )


description:
Stop the current test and return the results of execution
true if the test ran successfully, false if it did not (or the test could not be found/was invalid)

code: bool StopTest ( [FAutomationTestExecutionInfo](API\Runtime\Core\Misc\FAutomationTestExecutionInfo) & OutExecutionInfo )


description:
Unregister a automation test with the provided name from the framework.
true if the test was successfully unregistered; false if a test with that name was not found in the framework.

code: bool UnregisterAutomationTest ( const [FString](API\Runtime\Core\Containers\FString) & InTestNameToUnregister )


className: FAutomationTestFramework

description: No destructors are accessible with public or protected access.

code: class FAutomationTestFramework

OnPerformanceDataRetrieved

type: FOnPerformanceD...

description: Called when the performance data is retrieved.

OnScreenshotCompared

type: FOnTestScreensh...

description: Called when a screenshot comparison completes.

OnScreenshotTakenAndCompared

type: FSimpleMulticas...

description: The final call related to screenshots, after they've been taken, and after they've been compared (or not if automation isn't running).

OnTestDataRetrieved

type: FOnTestDataRetr...

description: Called when the test data is retrieved.

OnTestEndEvent

type: FOnTestEvent

description: Called when each automated test is ending

OnTestStartEvent

description: Called when each automated test is starting

PostTestingEvent

description: Called after all automated tests have completed

PreTestingEvent

description: Called right before automated test is about to begin


description: InTestFlags - the child test flag to add.

code: void AddTestFlags ( const uint32 InTestFlags )


description:
Gets the asset potentially associated with the test.
the source line number.

code: const [FString](API\Runtime\Core\Containers\FString) GetAssetPath() const


description:
Gets the full path for this test if you wanted to run it.
the display name.

code: const [FString](API\Runtime\Core\Containers\FString) & GetFullTestPath() const


description:
Get the number of devices running this test
The number of devices which have been given this test to run

code: const int GetNumDevicesRunningTest() const


description:
Get the number of participant this test needs in order to be run
The number of participants needed

code: const int32 GetNumParticipantsRequired() const


description:
Gets the open command potentially associated with the test.
the source line number.

code: const [FString](API\Runtime\Core\Containers\FString) GetOpenCommand() const


description:
Get the source file this test originated in.
the source file.

code: const [FString](API\Runtime\Core\Containers\FString) GetSourceFile() const


description:
Get the line number in the source file this test originated on.
the source line number.

code: const int32 GetSourceFileLine() const


description:
Get the type of test.
the test type.

code: const uint32 GetTestFlags() const


description:
Get the display name of this test.
the display name.

code: const [FString](API\Runtime\Core\Containers\FString) & GetDisplayName() const


description: Be notified of a new device running the test so we should update our flag counting these

code: void InformOfNewDeviceRunningTest()


description:
Get the type of parameter. This will be the asset name for linked assets.
the parameter.

code: const [FString](API\Runtime\Core\Containers\FString) GetTestParameter() const


description: Zero the number of devices running this test

code: void ResetNumDevicesRunningTest()


description: InDisplayName - the new child test name.

code: void SetDisplayName ( const [FString](API\Runtime\Core\Containers\FString) & InDisplayName )


description: NumRequired - The new number of participants needed

code: void SetNumParticipantsRequired ( int32 NumRequired )


description: Default constructor.

code: FAutomationTestInfo()


description: Constructor

code: FAutomationTestInfo ( const [FString](API\Runtime\Core\Containers\FString) & InDisplayName, const [FString](API\Runtime\Core\Containers\FString) & InFullTestPath, const [FString](API\Runtime\Core\Containers\FString) & InTestName, const uint32 InTestFlags, const int32 InNumParticipantsRequired, const [FString](API\Runtime\Core\Containers\FString) & InParameterName, const [FString](API\Runtime\Core\Containers\FString) & InSourceFile, int32 InSourceFileLine, const [FString](API\Runtime\Core\Containers\FString) & InAssetPath, const [FString](API\Runtime\Core\Containers\FString) & InOpenCommand )


className: FAutomationTestInfo

description: Simple class to store the automation test info

code: class FAutomationTestInfo


className: FAutoNamedEventsToggler

description: Enables named events when profiling. Increments/decrements GCycleStatsShouldEmitNamedEvents based on bIsProfiling. Functionality is controlled by stats.AutoEnableNamedEventsWhenProfiling.

code: class FAutoNamedEventsToggler


description: Decodes a Base64 string into aFStringtrue if the buffer was decoded, false if it was invalid.

code: static bool Decode ( const [FString](API\Runtime\Core\Containers\FString) & Source, [FString](API\Runtime\Core\Containers\FString) & OutDest, EBase64Mode Mode )


description:
Decodes a Base64 string into an array of bytes
true if the buffer was decoded, false if it was invalid.

code: static bool Decode ( const [FString](API\Runtime\Core\Containers\FString) & Source, [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & Dest, EBase64Mode Mode )


description:
Get the test name of this test.
The test name.


description:
Decodes a Base64 string into a preallocated buffer
true if the buffer was decoded, false if it was invalid.

code: template<typename CharType> static bool Decode ( const CharType * Source, uint32 Length, uint8 * Dest, EBase64Mode Mode )


description:
Encodes aFStringinto a Base64 string
A string that encodes the binary data in a way that can be safely transmitted via various Internet protocols

code: static [FString](API\Runtime\Core\Containers\FString) Encode ( const [FString](API\Runtime\Core\Containers\FString) & Source, EBase64Mode Mode )


description:
Encodes a binary uint8 array into a Base64 string
A string that encodes the binary data in a way that can be safely transmitted via various Internet protocols

code: static [FString](API\Runtime\Core\Containers\FString) Encode ( const [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & Source, EBase64Mode Mode )


description:
Encodes the source into a Base64 string
Base64 encoded string containing the binary data.

code: static [FString](API\Runtime\Core\Containers\FString) Encode ( const uint8 * Source, uint32 Length, EBase64Mode Mode )


description:
Encodes the source into a Base64 string, storing it in a preallocated buffer.
The length of the encoded data

code: template<typename CharType> static uint32 Encode ( const uint8 * Source, uint32 Length, CharType * Dest, EBase64Mode Mode )


description:
Determine the decoded data size for the incoming base64 encoded string
The size in bytes of the decoded data

code: static uint32 GetDecodedDataSize ( const [FString](API\Runtime\Core\Containers\FString) & Source )


code: template<typename CharType> static uint32 GetDecodedDataSize ( const CharType * Source, uint32 Length )


description:
Get the encoded data size for the given number of bytes.
The number of characters in the encoded data.

code: static constexpr uint32 GetEncodedDataSize ( uint32 NumBytes )


description:
Get the maximum decoded data size for the given number of input characters.
The maximum number of bytes that can be decoded from this input stream. The actual number of characters decoded may be less if the data contains padding characters. CallGetDecodedDataSize()with the input data to find the exact length.

code: static constexpr uint32 GetMaxDecodedDataSize ( uint32 NumChars )


description: Class for encoding/decoding Base64 data (RFC 4648)

code: struct FBase64


className: FBaseScopedAccessDetector

code: struct FBaseScopedAccessDetector


description: Test the given value against the strings extracted from the current item

code: virtual bool TestBasicStringExpression ( const [FTextFilterString](API\Runtime\Core\Misc\FTextFilterString) & InValue, const ETextFilterTextComparisonMode InTextComparisonMode ) const


description: Perform a complex expression test for the current item

code: virtual bool TestComplexExpression ( const [FName](API\Runtime\Core\UObject\FName) & InKey, const [FTextFilterString](API\Runtime\Core\Misc\FTextFilterString) & InValue, const ETextFilterComparisonOperation InComparisonOperation, const ETextFilterTextComparisonMode InTextComparisonMode ) const


code: FBasicStringFilterExpressionContext ( [FString](API\Runtime\Core\Containers\FString) && InTestString )


code: FBasicStringFilterExpressionContext ( const [FString](API\Runtime\Core\Containers\FString) & InTestString )


className: FBasicStringFilterExpressionContext

description: A simple basic string expression context forFString.

code: class FBasicStringFilterExpressionContext : public [ITextFilterExpressionContext](API\Runtime\Core\Misc\ITextFilterExpressionContext)


code: void AfterEach ( [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< void()> DoWork )


code: void BeforeEach ( [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< void()> DoWork )


code: void Describe ( const [FString](API\Runtime\Core\Containers\FString) & InDescription, [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< void()> DoWork )


description: Asks the test to enumerate variants that will all go through the "RunTest" function with different parameters (for load all maps, this should enumerate all maps to load)\

code: virtual void GetTests ( [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & OutBeautifiedNames, [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & OutTestCommands ) const


code: void It ( const [FString](API\Runtime\Core\Containers\FString) & InDescription, [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< void()> DoWork )


description:
Virtual call to execute the automation test.
TRUE if the test was run successfully; FALSE otherwise

code: virtual bool RunTest ( const [FString](API\Runtime\Core\Containers\FString) & Parameters )


code: void xIt ( const [FString](API\Runtime\Core\Containers\FString) & InDescription, [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< void()> DoWork )


code: void xDescribe ( const [FString](API\Runtime\Core\Containers\FString) & InDescription, [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< void()> DoWork )


code: FBDDAutomationTestBase ( const [FString](API\Runtime\Core\Containers\FString) & InName, const bool bInComplexTask )


className: FBDDAutomationTestBase

code: class FBDDAutomationTestBase : public [FAutomationTestBase](API\Runtime\Core\Misc\FAutomationTestBase)


className: FBoolConfigValueHelper::operator bool

code: operator bool() const


code: FBoolConfigValueHelper ( const TCHAR * Section, const TCHAR * Key, const [FString](API\Runtime\Core\Containers\FString) & Filename )


className: FBoolConfigValueHelper

description: Helper structure for boolean values in config

code: struct FBoolConfigValueHelper


className: FBufferedLine

description: The type of lines buffered by secondary threads.

code: struct FBufferedLine

Category

type: constFLazyName

Data

type: TUniquePtr< TCH...

Time

type: const double

Verbosity

type: constELogVerbo...


code: FBufferedLine ( const TCHAR * InData, const [FName](API\Runtime\Core\UObject\FName) & InCategory, [ELogVerbosity::Type](API\Runtime\Core\Logging\ELogVerbosity__Type) InVerbosity, const double InTime )


code: void GetContents ( [TArray](API\Runtime\Core\Containers\TArray)< [FBufferedLine](API\Runtime\Core\Misc\FBufferedLine) > & DestBuffer )


code: virtual void Serialize ( const TCHAR * InData, [ELogVerbosity::Type](API\Runtime\Core\Logging\ELogVerbosity__Type) Verbosity, const [FName](API\Runtime\Core\UObject\FName) & Category )


description: Pushes buffered lines into the specified output device.

code: void RedirectTo ( [FOutputDevice](API\Runtime\Core\Misc\FOutputDevice) & Ar )


code: void SetVerbosity ( [ELogVerbosity::Type](API\Runtime\Core\Logging\ELogVerbosity__Type) Verbosity )


description: Attempts to close and finalize any handles used for backing data storage, returns true if it succeeded.

code: virtual bool Close()


className: FBufferedOutputDevice

description: Buffered output device.

code: class FBufferedOutputDevice : public [FOutputDevice](API\Runtime\Core\Misc\FOutputDevice)

BufferedLines

type: TArray<FBuffer...

SynchronizationObject

type: FCriticalSectio...


description: Constructor

code: FBufferReaderWithSHA ( void * Data, int64 Size, bool bInFreeOnClose, const TCHAR * SHASourcePathname, bool bIsPersistent, bool bInIsUnfoundHashAnError )


className: FBufferReaderWithSHA

description: Similar toFBufferReader, but will verify the contents of the buffer on close (on close to that we know we don't need the data anymore)

code: class FBufferReaderWithSHA : public [FBufferReaderBase](API\Runtime\Core\Serialization\FBufferReaderBase)

bIsUnfoundHashAnError

description: True if failing to lookup the hash should trigger an error

SourcePathname

description: Path to the file to use to lookup the SHA hash value


description: Makes the change to the object

code: void Apply ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * Object )


description: Used by GC to collect referenced objects.

code: virtual void AddReferencedObjects ( [FReferenceCollector](API\Runtime\CoreUObject\UObject\FReferenceCollector) & Collector )


className: EChangeStyle

code: enum EChangeStyle { InPlaceSwap, CommandPattern, }


description: Makes the change to the object, returning a new change that can be used to perfectly roll back this change

code: [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< [FChange](API\Runtime\Core\Misc\FChange) > Execute ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * Object )


description: What style of change is this


description: Prints this change to the log, including sub-changes if there are any. For compound changes, there might be multiple lines. You should not need to override this function.

code: virtual void PrintToLog ( [FFeedbackContext](API\Runtime\Core\Misc\FFeedbackContext) & FeedbackContext, const int32 IndentLevel )


description: Reverts change to the object

code: void Revert ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * Object )


description: Describes this change (for debugging)


description: This is overridden for the specific Archive Types

code: virtual [FString](API\Runtime\Core\Containers\FString) GetArchiveName() const


description: Protected default constructor

code: FChange()


description: Non-copyable.

code: FChange &40; const FChange & &41;


description: Virtual destructor

code: virtual ~FChange()


className: FChange

description: FChangemay eventually be deprecated. You should subclassFSwapChangeandFCommandChangeto implement these different styles.

code: class FChange


code: virtual [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< [FChange](API\Runtime\Core\Misc\FChange) > Execute ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * Object )


description: true if this Change has Expired, ie it will no longer have any effect and could be skipped by undo/redo

code: virtual bool HasExpired ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * Object ) const


className: FCommandChange

description: To useFCommandChangeyou must implementApply()andRevert()Revert()is called to "Undo" andApply()is called to "Redo"

code: class FCommandChange : public [FChange](API\Runtime\Core\Misc\FChange)


description: Adds a new parameter to subprocess command line. If Param does not start with a space, one is added.

code: static void AddToSubprocessCommandline ( const TCHAR * Param )


description: Appends the passed string to the command line as it is (no space is added).

code: static void Append ( const TCHAR * AppendString )


className: bIsInitialized

description: Flag to check if the commandline has been initialized or not.

code: static bool bIsInitialized = false;


description: Builds a command line string from the ArgC/ArgV main() arguments, together with an optional prefix or suffix, for adding additional command list arguments programmatically.

code: static [FString](API\Runtime\Core\Containers\FString) BuildFromArgV ( const WIDECHAR * Prefix, int32 ArgC, WIDECHAR * ArgV, const WIDECHAR * Suffix )


code: static [FString](API\Runtime\Core\Containers\FString) BuildFromArgV ( const ANSICHAR * Prefix, int32 ArgC, ANSICHAR * ArgV, const ANSICHAR * Suffix )


className: CmdLine

description: Character buffer containing the command line

code: static TCHAR CmdLine = {};


description: Returns true if Outline was large enough to hold the filtered string, Otherwise returns false.

code: static bool FilterCLIUsingGrammarBasedParser ( TCHAR * OutLine, int32 MaxLen, const TCHAR * InLine, const [TArrayView](API\Runtime\Core\Containers\TArrayView)< [FString](API\Runtime\Core\Containers\FString) > & AllowedList )


description: Returns an edited version of the executable's command line with the game name and certain other parameters removed.

code: static const TCHAR * Get()


description: Returns an edited version of the executable's command line.

code: static const TCHAR * GetForLogging()


description: Returns the command line originally passed to the executable.

code: static const TCHAR * GetOriginal()


description: Returns an edited version of the command line originally passed to the executable.

code: static const TCHAR * GetOriginalForLogging()


description: Returns the subprocess command line string

code: static const [FString](API\Runtime\Core\Containers\FString) & GetSubprocessCommandline()


description: Returns true if logging filter is enabled


description: Checks if the command line has been initialized.

code: static bool IsInitialized()


className: LoggingCmdLine

description: Character buffer containing the command line filtered for logging purposes

code: static TCHAR LoggingCmdLine = {};


className: LoggingOriginalCmdLine

description: Character buffer containing the original command line filtered for logging purposes

code: static TCHAR LoggingOriginalCmdLine = {};


className: OriginalCmdLine

description: Character buffer containing the original command line

code: static TCHAR OriginalCmdLine = {};


className: MaxCommandLineSize

description: Maximum size of the command line

code: static constexpr uint32 MaxCommandLineSize = 16384;


description: Parses a string into tokens, separating switches (beginning with -) from other parameters

code: static void Parse ( const TCHAR * CmdLine, [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & Tokens, [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & Switches )


description: Removes the executable name from a commandline, denoted by parentheses.

code: static const TCHAR * RemoveExeName ( const TCHAR * CmdLine )


description: ResetsFCommandLineto an uninitialised state as ifSet()has never been called

code: static void Reset()


description: Sets CmdLine to the string given

code: static bool Set ( const TCHAR * NewCommandLine )


className: EType

description: Todo: add callable types here?

code: enum EType { Operand, PreUnaryOperator, PostUnaryOperator, BinaryOperator, ShortCircuit, Benign, }


code: [FCompiledToken](API\Runtime\Core\Misc\FCompiledToken) & operator= ( [FCompiledToken](API\Runtime\Core\Misc\FCompiledToken) && In )


code: FCompiledToken ( [FCompiledToken](API\Runtime\Core\Misc\FCompiledToken) && In )


code: FCompiledToken ( [EType](API\Runtime\Core\Misc\FCompiledToken\EType) InType, [FExpressionToken](API\Runtime\Core\Misc\FExpressionToken) InToken, [TOptional](API\Runtime\Core\IO\TOptional)< int32 > InShortCircuitIndex )


className: FCompiledToken

description: A compiled token, holding the token itself, and any compiler information required to evaluate it

code: struct FCompiledToken : public [FExpressionToken](API\Runtime\Core\Misc\FExpressionToken)

ShortCircuitIndex

type: TOptional< int3...

Type

type: EType


description: Prints this change to the log, including sub-changes if there are any. For compound changes, there might be multiple lines. You should not need to override this function.

code: virtual void PrintToLog ( class [FFeedbackContext](API\Runtime\Core\Misc\FFeedbackContext) & FeedbackContext, const int32 IndentLevel )


description: Makes the change to the object, returning a new change that can be used to perfectly roll back this change

code: virtual [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< [FChange](API\Runtime\Core\Misc\FChange) > Execute ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * Object )


description: Constructor

code: FCompoundChange ( [FCompoundChangeInput](API\Runtime\Core\Misc\FCompoundChangeInput) && InitInput )


description: Describes this change (for debugging)

code: virtual [FString](API\Runtime\Core\Containers\FString) ToString() const


description: Non-copyable.

code: FCompoundChange &40; const FCompoundChange & &41;


className: FCompoundChange

description: FCompoundChangeapplies a sequence of FSwapChanges. The changes are executed in reverse order (this is like a mini undo stack)

code: class FCompoundChange : public [FSwapChange](API\Runtime\Core\Misc\FSwapChange)


code: FCompoundChangeInput ( [FCompoundChangeInput](API\Runtime\Core\Misc\FCompoundChangeInput) && RHS )


description: Non-copyable.

code: FCompoundChangeInput &40; const FCompoundChangeInput & &41;


className: FCompoundChangeInput

code: struct FCompoundChangeInput

Subchanges

type: TArray<TUnique...

description: Ordered list of changes that comprise everything needed to describe this change


description: Accesses the data at passed in offset and returns it. The memory is read-only and memory will be freed in call to unlock. The lifetime of the data is till the next call to Unlock, Append or Access

code: void * Access ( int32 Offset )


description: This enum and the following constructor is a workaround for VC compiler bug that prevents using attributes on constructors without inline implementation. This should be removed when the deprecated ctor is removed.

code: enum EVS2015Redirector { Redirect, }


description:
Appends passed in data to the buffer. The data needs to be less than the max pending buffer size. The code will assert on this assumption.
Offset of data, used for retrieval later on

code: int32 Append ( void * Data, int32 Size )


description:
Helper function to return the amount of memory allocated by this buffer
number of bytes allocated by this buffer

code: SIZE_T GetAllocatedSize() const


description: Locks the buffer for reading. Needs to be called before calls to Access and needs to be matched up with Unlock call.

code: void Lock()


description: Number of entries appended.

code: int32 Num() const


description: Unlocks the buffer and frees temporary resources used for accessing.

code: void Unlock()


description: Constructor

code: FCompressedGrowableBuffer ( int32 MaxPendingBufferSize, ECompressionFlags CompressionFlags )


description: Constructor

code: FCompressedGrowableBuffer &40; EVS2015Redirector, int32 MaxPendingBufferSize, ECompressionFlags CompressionFlags &41;


code: FCompressedGrowableBuffer ( int32 MaxPendingBufferSize, [FName](API\Runtime\Core\UObject\FName) COmpressionFormat, ECompressionFlags CompressionFlags )


className: FCompressedGrowableBuffer

description: Growable compressed buffer. Usage is to append frequently but only request and therefore decompress very infrequently. The prime usage case is the memory profiler keeping track of full call stacks.

code: struct FCompressedGrowableBuffer


className: CompressionFormats

description: Mapping of Compression FNames to their compressor objects

code: static [TMap](API\Runtime\Core\Containers\TMap)< [FName](API\Runtime\Core\UObject\FName), struct [ICompressionFormat](API\Runtime\Core\Misc\ICompressionFormat) * > CompressionFormats;


description:
Thread-safe abstract compression routine to query memory requirements for a compression operation. This is the minimize size to allocate the buffer for CompressMemory (encoding). Use GetMaximumCompressedSize at decode to know how large a compressed buffer may be.
The maximum possible bytes needed for compression of data buffer of size UncompressedSize

code: static int32 CompressMemoryBound ( [FName](API\Runtime\Core\UObject\FName) FormatName, int32 UncompressedSize, ECompressionFlags Flags, int32 CompressionData )


description:
Thread-safe abstract compression routine. Compresses memory from uncompressed buffer and writes it to compressed buffer. Updates CompressedSize with size of compressed data. Compression controlled by the passed in flags. CompressMemory is expected to return true and write valid data even if it expanded bytes. Always check CompressedSize >= UncompressedSize and fall back to uncompressed, or use CompressMemoryIfWorthDecompressing
true if compression succeeds, false if it fails because CompressedBuffer was too small or other reasons

code: static bool CompressMemory ( [FName](API\Runtime\Core\UObject\FName) FormatName, void * CompressedBuffer, int32 & CompressedSize, const void * UncompressedBuffer, int32 UncompressedSize, ECompressionFlags Flags, int32 CompressionData )


description:
Same as CompressMemory but evaluates if the compression gain is worth the runtime decode time returns false if the size saving is not worth it (also if CompressedSize >= UncompressedSize) if false is returned, send the data uncompressed instead
true if compression succeeds, false if it fails because CompressedBuffer was too small or other reasons

code: static bool CompressMemoryIfWorthDecompressing ( [FName](API\Runtime\Core\UObject\FName) FormatName, int32 MinBytesSaved, int32 MinPercentSaved, void * CompressedBuffer, int32 & CompressedSize, const void * UncompressedBuffer, int32 UncompressedSize, ECompressionFlags Flags, int32 CompressionData )


className: CompressorDstBytes

description: Nubmer of bytes after compression.

code: static [TAtomic](API\Runtime\Core\HAL\TAtomic)< uint64 > CompressorDstBytes;


className: CompressorSrcBytes

description: Number of bytes before compression.

code: static [TAtomic](API\Runtime\Core\HAL\TAtomic)< uint64 > CompressorSrcBytes;


className: CompressorTimeCycles

description: Time spent compressing data in cycles.

code: static [TAtomic](API\Runtime\Core\HAL\TAtomic)< uint64 > CompressorTimeCycles;


code: static [FName](API\Runtime\Core\UObject\FName) GetCompressionFormatFromDeprecatedFlags ( ECompressionFlags DeprecatedFlags )


description:
Returns a string which can be used to identify if a format has become out of date
unique DDC key string which will be different when the format is changed / updated

code: static [FString](API\Runtime\Core\Containers\FString) GetCompressorDDCSuffix ( [FName](API\Runtime\Core\UObject\FName) FormatName )


description:
Returns a version number for a specified format
An interpretation of an internal version number for a specific format (different formats will have different layouts) this should change if a version is updated

code: static uint32 GetCompressorVersion ( [FName](API\Runtime\Core\UObject\FName) FormatName )


description: Checks to see if a format will be usable, so that a fallback can be used

code: static bool IsFormatValid ( [FName](API\Runtime\Core\UObject\FName) FormatName )


description:
Thread-safe abstract compression routine to query maximum compressed size that could be made. CompressMemoryBound is strictly greater equal GetMaximumCompressedSize.
The maximum possible size of valid compressed data made by this format

code: static int32 GetMaximumCompressedSize ( [FName](API\Runtime\Core\UObject\FName) FormatName, int32 UncompressedSize, ECompressionFlags Flags, int32 CompressionData )


code: static bool UncompressMemoryStream ( [FName](API\Runtime\Core\UObject\FName) FormatName, void * UncompressedBuffer, int32 UncompressedSize, [IMemoryReadStream](API\Runtime\Core\Misc\IMemoryReadStream) * Stream, int64 StreamOffset, int32 CompressedSize, ECompressionFlags Flags, int32 CompressionData )


description:
Thread-safe abstract decompression routine. Uncompresses memory from compressed buffer and writes it to uncompressed buffer. UncompressedSize is expected to be the exact size of the data after decompression.
true if compression succeeds, false if it fails because CompressedBuffer was too small or other reasons

code: static bool UncompressMemory ( [FName](API\Runtime\Core\UObject\FName) FormatName, void * UncompressedBuffer, int32 UncompressedSize, const void * CompressedBuffer, int32 CompressedSize, ECompressionFlags Flags, int32 CompressionData )


description: Verifies if the passed in value represents valid compression flags

code: static bool VerifyCompressionFlagsValid ( int32 InCompressionFlags )


code: [FConfigFile](API\Runtime\Core\Misc\FConfigFile) & Add ( const [FString](API\Runtime\Core\Containers\FString) & Filename, const [FConfigFile](API\Runtime\Core\Misc\FConfigFile) & File )


description: Returns whether or not file operations are disabled


description: Wipe all cached platform configs. Next ForPlatform call will load on-demand the platform configs

code: static void ClearOtherPlatformConfigs()


description: Reports whether an FConfigFile* is pointing to a config file inside of this Used for downstream functions to check whether a config file they were passed came from this ConfigCacheIni or from a different source such as LoadLocalIniFile

code: bool ContainsConfigFile ( const [FConfigFile](API\Runtime\Core\Misc\FConfigFile) * ConfigFile ) const


description: Create GConfig from a saved file

code: static bool CreateGConfigFromSaved ( const TCHAR * Filename )


code: void Detach ( const [FString](API\Runtime\Core\Containers\FString) & Filename )


description: Disables any file IO by the config cache system

code: virtual void DisableFileOperations()


code: bool DoesSectionExist ( const TCHAR * Section, const [FString](API\Runtime\Core\Containers\FString) & Filename )


description: Prints out the entire config set, or just a single file if an ini is specified

code: void Dump ( [FOutputDevice](API\Runtime\Core\Misc\FOutputDevice) & Ar, const TCHAR * IniName )


code: bool EmptySection ( const TCHAR * Section, const [FString](API\Runtime\Core\Containers\FString) & Filename )


description: Re-enables file IO by the config cache system

code: virtual void EnableFileOperations()


code: bool EmptySectionsMatchingString ( const TCHAR * SectionString, const [FString](API\Runtime\Core\Containers\FString) & Filename )


description:
Finds, loads, or creates the in-memory config file for a config cache filename.
A new or existing config file

code: [FConfigFile](API\Runtime\Core\Misc\FConfigFile) * Find ( const [FString](API\Runtime\Core\Containers\FString) & InFilename )


description: Deprecated* CreateIfNotFound is deprecated, please use the overload without this parameter or FindConfigFile

code: [FConfigFile](API\Runtime\Core\Misc\FConfigFile) * Find ( const [FString](API\Runtime\Core\Containers\FString) & Filename, bool CreateIfNotFound )


description: Attempts to find the platform config in the cache.FConfigFileFoundFConfigFile

code: static [FConfigFile](API\Runtime\Core\Misc\FConfigFile) * FindPlatformConfig ( const TCHAR * IniName, const TCHAR * Platform )


description:
Finds the in-memory config file for a config cache filename.
The existing config file or null if it does not exist in memory

code: [FConfigFile](API\Runtime\Core\Misc\FConfigFile) * FindConfigFile ( const [FString](API\Runtime\Core\Containers\FString) & Filename )


description: Finds Config file that matches the base name such as "Engine"

code: [FConfigFile](API\Runtime\Core\Misc\FConfigFile) * FindConfigFileWithBaseName ( [FName](API\Runtime\Core\UObject\FName) BaseName )


description: This helper function searches the cache before trying to load the ini file using LoadLocalIniFile. Note that the returnedFConfigFilepointer must have the same lifetime as the passed in LocalFile.FConfigFileFound or loadedFConfigFile

code: static [FConfigFile](API\Runtime\Core\Misc\FConfigFile) * FindOrLoadPlatformConfig ( [FConfigFile](API\Runtime\Core\Misc\FConfigFile) & LocalFile, const TCHAR * IniName, const TCHAR * Platform )


className: FKnownConfigFile

description: Create the list of members for the known inis (Engine, Game, etc) See the top of this file for the list

code: struct FKnownConfigFile


description: Given an name ("Engine") return theFConfigFilefor it

code: const FConfigFile &42; GetFile &40; FName Name &41;


description: Get the disk-based filename for the given known ini name

code: const FString & GetFilename &40; FName Name &41;


description: Given an name ("Engine") return the modifiableFConfigFilefor it

code: FConfigFile &42; GetMutableFile &40; FName Name &41;


description: Setup GEngineIni based on this structure's values


className: FKnownConfigFiles

code: struct FKnownConfigFiles

Files

type: FKnownConfigFil...

description: Array of all known filesd


description:
Allows to iterate through all key value pairs
false:error e.g. Section or Filename not found

code: virtual bool ForEachEntry ( const FKeyValueSink & Visitor, const TCHAR * Section, const [FString](API\Runtime\Core\Containers\FString) & Filename )


description: Retrieve the fully processed ini system for another platform. The editor will start loading these in the background on startup

code: static [FConfigCacheIni](API\Runtime\Core\Misc\FConfigCacheIni) * ForPlatform ( [FName](API\Runtime\Core\UObject\FName) PlatformName )


code: int32 GetArray ( const TCHAR * Section, const TCHAR * Key, [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & out_Arr, const [FString](API\Runtime\Core\Containers\FString) & Filename )


code: bool GetBool ( const TCHAR * Section, const TCHAR * Key, bool & Value, const [FString](API\Runtime\Core\Containers\FString) & Filename )


code: bool GetBoolOrDefault ( const TCHAR * Section, const TCHAR * Key, const bool DefaultValue, const [FString](API\Runtime\Core\Containers\FString) & Filename )


code: bool GetColor ( const TCHAR * Section, const TCHAR * Key, [FColor](API\Runtime\Core\Math\FColor) & Value, const [FString](API\Runtime\Core\Containers\FString) & Filename )


description:
For a base ini name, gets the config cache filename key that is used by other functions like Find. This will be the base name for known configs like Engine and the destination filename for others.
Filename key used by other cache functions

code: [FString](API\Runtime\Core\Containers\FString) GetConfigFilename ( const TCHAR * BaseIniName )


code: void Flush ( bool bRemoveFromCache, const [FString](API\Runtime\Core\Containers\FString) & Filename )


description: Retrieve a list of all of the config files stored in the cache

code: void GetConfigFilenames ( [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & ConfigFilenames )


description: Returns the Custom Config string, which if set will load additional config files from Config/Custom/{CustomConfig}/DefaultX.ini to allow different types of builds. It can be set from a game Target.cs file with CustomConfig = "Name". Or in development, it can be overridden with a -CustomConfig=Name command line parameter.

code: static const [FString](API\Runtime\Core\Containers\FString) & GetCustomConfigString()


description:
Calculates the name of a dest (generated) .ini file for a given base (ie Engine, Game, etc)
Standardized .ini filename

code: static [FString](API\Runtime\Core\Containers\FString) GetDestIniFilename ( const TCHAR * BaseIniName, const TCHAR * PlatformName, const TCHAR * GeneratedConfigDir )


code: bool GetDouble ( const TCHAR * Section, const TCHAR * Key, double & Value, const [FString](API\Runtime\Core\Containers\FString) & Filename )


code: [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > GetFilenames()


code: bool GetInt ( const TCHAR * Section, const TCHAR * Key, int32 & Value, const [FString](API\Runtime\Core\Containers\FString) & Filename )


code: float GetFloatOrDefault ( const TCHAR * Section, const TCHAR * Key, const float DefaultValue, const [FString](API\Runtime\Core\Containers\FString) & Filename )


code: bool GetInt64 ( const TCHAR * Section, const TCHAR * Key, int64 & Value, const [FString](API\Runtime\Core\Containers\FString) & Filename )


description: Return a config value if found, if not found return default value does not indicate if return value came from config or the default value useful for one-time init of static variables in code locations where config may be queried too often, like : static int32 bMyConfigValue = GConfig->GetIntOrDefault(Section,Key,DefaultValue,ConfigFilename);

code: int32 GetIntOrDefault ( const TCHAR * Section, const TCHAR * Key, const int32 DefaultValue, const [FString](API\Runtime\Core\Containers\FString) & Filename )


code: bool GetRotator ( const TCHAR * Section, const TCHAR * Key, FRotator & Value, const [FString](API\Runtime\Core\Containers\FString) & Filename )


description: USed to get the max memory usage for theFConfigCacheInithe amount of memory in byes

code: virtual SIZE_T GetMaxMemoryUsage()


description:
Retrieve the names of sections which contain data for the specified PerObjectConfig class.
true if the file specified was found and it contained at least 1 section for the specified class

code: bool GetPerObjectConfigSections ( const [FString](API\Runtime\Core\Containers\FString) & Filename, const [FString](API\Runtime\Core\Containers\FString) & SearchClass, [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & out_SectionNames, int32 MaxResults )


description:
Retrieve the names for all sections contained in the file specified by Filename
true if the file specified was successfully found;

code: bool GetSectionNames ( const [FString](API\Runtime\Core\Containers\FString) & Filename, [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & out_SectionNames )


code: bool GetSection ( const TCHAR * Section, [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & Result, const [FString](API\Runtime\Core\Containers\FString) & Filename )


code: bool GetFloat ( const TCHAR * Section, const TCHAR * Key, float & Value, const [FString](API\Runtime\Core\Containers\FString) & Filename )


code: [FConfigSection](API\Runtime\Core\Misc\FConfigSection) * GetSectionPrivate ( const TCHAR * Section, const bool Force, const bool Const, const [FString](API\Runtime\Core\Containers\FString) & Filename )


code: bool GetString ( const TCHAR * Section, const TCHAR * Key, [FString](API\Runtime\Core\Containers\FString) & Value, const [FString](API\Runtime\Core\Containers\FString) & Filename )


description:
Loads a "delimited" list of strings
Loads a "delimited" list of string

code: int32 GetSingleLineArray ( const TCHAR * Section, const TCHAR * Key, [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & out_Arr, const [FString](API\Runtime\Core\Containers\FString) & Filename )


code: [FString](API\Runtime\Core\Containers\FString) GetStringOrDefault ( const TCHAR * Section, const TCHAR * Key, const [FString](API\Runtime\Core\Containers\FString) & DefaultValue, const [FString](API\Runtime\Core\Containers\FString) & Filename )


code: bool GetText ( const TCHAR * Section, const TCHAR * Key, [FText](API\Runtime\Core\Internationalization\FText) & Value, const [FString](API\Runtime\Core\Containers\FString) & Filename )


description: Derived functions.

code: [FString](API\Runtime\Core\Containers\FString) GetStr ( const TCHAR * Section, const TCHAR * Key, const [FString](API\Runtime\Core\Containers\FString) & Filename )


code: [FText](API\Runtime\Core\Internationalization\FText) GetTextOrDefault ( const TCHAR * Section, const TCHAR * Key, const [FText](API\Runtime\Core\Internationalization\FText) & DefaultValue, const [FString](API\Runtime\Core\Containers\FString) & Filename )


description: Generic versions for use with templates

code: bool GetValue ( const TCHAR * Section, const TCHAR * Key, [FString](API\Runtime\Core\Containers\FString) & Value, const [FString](API\Runtime\Core\Containers\FString) & Filename )


code: bool GetValue ( const TCHAR * Section, const TCHAR * Key, [FText](API\Runtime\Core\Internationalization\FText) & Value, const [FString](API\Runtime\Core\Containers\FString) & Filename )


code: bool GetValue ( const TCHAR * Section, const TCHAR * Key, int32 & Value, const [FString](API\Runtime\Core\Containers\FString) & Filename )


code: bool GetValue ( const TCHAR * Section, const TCHAR * Key, float & Value, const [FString](API\Runtime\Core\Containers\FString) & Filename )


code: bool GetValue ( const TCHAR * Section, const TCHAR * Key, bool & Value, const [FString](API\Runtime\Core\Containers\FString) & Filename )


code: int32 GetValue ( const TCHAR * Section, const TCHAR * Key, [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & Value, const [FString](API\Runtime\Core\Containers\FString) & Filename )


code: bool GetVector ( const TCHAR * Section, const TCHAR * Key, FVector & Value, const [FString](API\Runtime\Core\Containers\FString) & Filename )


code: bool GetVector2D ( const TCHAR * Section, const TCHAR * Key, FVector2D & Value, const [FString](API\Runtime\Core\Containers\FString) & Filename )


code: bool GetVector4 ( const TCHAR * Section, const TCHAR * Key, FVector4 & Value, const [FString](API\Runtime\Core\Containers\FString) & Filename )


description: Creates GConfig, loads the standard global ini files (Engine, Editor, etc), fills out GEngineIni, etc. and marks GConfig as ready for use

code: static void InitializeConfigSystem()


description: return True if the engine ini was loaded

code: static bool InitializeKnownConfigFiles ( [FConfigContext](API\Runtime\Core\Misc\FConfigContext) & Context )


description: Returns true if the given name is one of the known configs, where the matching G****Ini property is going to match the base name ("Engine" returns true, which means GEngineIni's value is just "Engine")

code: bool IsKnownConfigName ( [FName](API\Runtime\Core\UObject\FName) ConfigName )


description: true after after the basic .ini files have been loaded

code: bool IsReadyForUse()


description: Needs to be called after GConfig is set and LoadCoalescedFile was called. Loads the state of console variables. Works even if the variable is registered after the ini file was loaded.


code: void LoadFile ( const [FString](API\Runtime\Core\Containers\FString) & InFilename, const [FConfigFile](API\Runtime\Core\Misc\FConfigFile) * Fallback, const TCHAR * PlatformString )


description:
Load an ini file directly into anFConfigFilefrom the specified config folders, optionally writing to disk. The passed in .ini name can be a "base" (Engine, Game) which will be modified by platform and/or commandline override, or it can be a full ini filename (ie WrangleContent) loaded from the Source config directory
true if the ini file was loaded successfully

code: static bool LoadExternalIniFile ( [FConfigFile](API\Runtime\Core\Misc\FConfigFile) & ConfigFile, const TCHAR * IniName, const TCHAR * EngineConfigDir, const TCHAR * SourceConfigDir, bool bIsBaseIniName, const TCHAR * Platform, bool bForceReload, bool bWriteDestIni, bool bAllowGeneratedIniWhenCooked, const TCHAR * GeneratedConfigDir )


description: Loads and generates a destination ini file and adds it to GConfig:

code: static bool LoadGlobalIniFile ( [FString](API\Runtime\Core\Containers\FString) & FinalIniFilename, const TCHAR * BaseIniName, const TCHAR * Platform, bool bForceReload, bool bRequireDefaultIni, bool bAllowGeneratedIniWhenCooked, bool bAllowRemoteConfig, const TCHAR * GeneratedConfigDir, [FConfigCacheIni](API\Runtime\Core\Misc\FConfigCacheIni) * ConfigSystem )


description:
Load an ini file directly into anFConfigFile, and nothing is written to GConfig or disk. The passed in .ini name can be a "base" (Engine, Game) which will be modified by platform and/or commandline override, or it can be a full ini filename (ie WrangleContent) loaded from the Source config directory
true if the ini file was loaded successfully

code: static bool LoadLocalIniFile ( [FConfigFile](API\Runtime\Core\Misc\FConfigFile) & ConfigFile, const TCHAR * IniName, bool bIsBaseIniName, const TCHAR * Platform, bool bForceReload )


description:
We can prevent these types of issues by enforcing normalized paths when accessing configs.
A normalized version of the path (may be the same as the input).

code: static [FString](API\Runtime\Core\Containers\FString) NormalizeConfigIniPath ( const [FString](API\Runtime\Core\Containers\FString) & NonNormalizedPath )


description: NOTE: The function naming is weird because you can't apparently have an overridden function differnt only by template type params

code: virtual void Parse1ToNSectionOfNames ( const TCHAR * Section, const TCHAR * KeyOne, const TCHAR * KeyN, [TMap](API\Runtime\Core\Containers\TMap)< [FName](API\Runtime\Core\UObject\FName), [TArray](API\Runtime\Core\Containers\TArray)< [FName](API\Runtime\Core\UObject\FName) > > & OutMap, const [FString](API\Runtime\Core\Containers\FString) & Filename )


code: virtual void Parse1ToNSectionOfStrings ( const TCHAR * Section, const TCHAR * KeyOne, const TCHAR * KeyN, [TMap](API\Runtime\Core\Containers\TMap)< [FString](API\Runtime\Core\Containers\FString), [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > > & OutMap, const [FString](API\Runtime\Core\Containers\FString) & Filename )


code: int32 Remove ( const [FString](API\Runtime\Core\Containers\FString) & Filename )


description: Save the current config cache state into a file for bootstrapping other processes.

code: void SaveCurrentStateForBootstrap ( const TCHAR * Filename )


code: bool RemoveKey ( const TCHAR * Section, const TCHAR * Key, const [FString](API\Runtime\Core\Containers\FString) & Filename )


code: void Serialize ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar )


code: void SetArray ( const TCHAR * Section, const TCHAR * Key, const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & Value, const [FString](API\Runtime\Core\Containers\FString) & Filename )


code: void SetBool ( const TCHAR * Section, const TCHAR * Key, bool Value, const [FString](API\Runtime\Core\Containers\FString) & Filename )


code: void SetColor ( const TCHAR * Section, const TCHAR * Key, [FColor](API\Runtime\Core\Math\FColor) Value, const [FString](API\Runtime\Core\Containers\FString) & Filename )


code: void SetFile ( const [FString](API\Runtime\Core\Containers\FString) & InFilename, const [FConfigFile](API\Runtime\Core\Misc\FConfigFile) * NewConfigFile )


code: void SetDouble ( const TCHAR * Section, const TCHAR * Key, double Value, const [FString](API\Runtime\Core\Containers\FString) & Filename )


code: void SetInt ( const TCHAR * Section, const TCHAR * Key, int32 Value, const [FString](API\Runtime\Core\Containers\FString) & Filename )


code: void SetFloat ( const TCHAR * Section, const TCHAR * Key, float Value, const [FString](API\Runtime\Core\Containers\FString) & Filename )


code: void SetRotator ( const TCHAR * Section, const TCHAR * Key, FRotator Value, const [FString](API\Runtime\Core\Containers\FString) & Filename )


description:
Saves a "delimited" list of strings
Saves a "delimited" list of strings

code: void SetSingleLineArray ( const TCHAR * Section, const TCHAR * Key, const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & In_Arr, const [FString](API\Runtime\Core\Containers\FString) & Filename )


code: void SetString ( const TCHAR * Section, const TCHAR * Key, const TCHAR * Value, const [FString](API\Runtime\Core\Containers\FString) & Filename )


code: void SetText ( const TCHAR * Section, const TCHAR * Key, const [FText](API\Runtime\Core\Internationalization\FText) & Value, const [FString](API\Runtime\Core\Containers\FString) & Filename )


code: void SetVector ( const TCHAR * Section, const TCHAR * Key, FVector Value, const [FString](API\Runtime\Core\Containers\FString) & Filename )


code: void SetVector2D ( const TCHAR * Section, const TCHAR * Key, FVector2D Value, const [FString](API\Runtime\Core\Containers\FString) & Filename )


description: Dumps memory stats for each file in the config cache to the specified archive.

code: virtual void ShowMemoryUsage ( [FOutputDevice](API\Runtime\Core\Misc\FOutputDevice) & Ar )


code: void SetVector4 ( const TCHAR * Section, const TCHAR * Key, const FVector4 & Value, const [FString](API\Runtime\Core\Containers\FString) & Filename )


code: void UnloadFile ( const [FString](API\Runtime\Core\Containers\FString) & Filename )


description: DO NOT USE. This constructor is for internal usage only for hot-reload purposes.

code: FConfigCacheIni()


description: Basic functions.

code: FConfigCacheIni ( EConfigCacheType Type )


className: FConfigCacheIni

description: Set of all cached config files.

code: class FConfigCacheIni


className: FConfigCommandlineOverride

description: Options which stemmed from the commandline.

code: struct FConfigCommandlineOverride


description: Call to make before attempting parallel config init


description: Create a context to read a hierarchical config into GConfig. Only for current platform.


className: FPerPlatformDirs

description: Because the hierarchy can jump between platforms, we cache off some directories per chained-platform

code: struct FPerPlatformDirs


description: Outdatedness also can be affected by commandline params which allow one to delete all .ini, have automated build system etc.

code: bool GenerateDestIniFile()


description: Return the paths to use to find hierarchical config files for the given platform (note that these are independent of the ini name)

code: const [FPerPlatformDirs](API\Runtime\Core\Misc\FConfigContext\FPerPlatformDirs) & GetPerPlatformDirs ( const [FString](API\Runtime\Core\Containers\FString) & PlatformName )


description: Use the context to perform the actual load operation. Note that this is where you specify the Ini name (for instance "Engine"), meaning you can use the same context for multiple configs (Engine, Game, Input, etc)

code: bool Load ( const TCHAR * IniName )


description: Use the context to perform the actual load operation as above, but will return the generated final ini filename (in the case of GConfig, this would be the key used to look up into GConfig, for example)

code: bool Load ( const TCHAR * IniName, [FString](API\Runtime\Core\Containers\FString) & OutFilename )


code: [FString](API\Runtime\Core\Containers\FString) PerformFinalExpansions ( const [FString](API\Runtime\Core\Containers\FString) & InString, const [FString](API\Runtime\Core\Containers\FString) & Platform )


code: bool PrepareForLoad ( bool & bPerformLoad )


description: Create a context to read a hierarchical config into the given ConfigSystem structure - usually will be for other platforms

code: static [FConfigContext](API\Runtime\Core\Misc\FConfigContext) ReadIntoConfigSystem ( [FConfigCacheIni](API\Runtime\Core\Misc\FConfigCacheIni) * ConfigSystem, const [FString](API\Runtime\Core\Containers\FString) & Platform )


description: Create a context to read a hierarchical config into the given localFConfigFile, optionally for another platform

code: static [FConfigContext](API\Runtime\Core\Misc\FConfigContext) ReadIntoLocalFile ( [FConfigFile](API\Runtime\Core\Misc\FConfigFile) & DestConfigFile, const [FString](API\Runtime\Core\Containers\FString) & Platform )


description: Create a context to read a plugin's ini file named for the plugin. This is not used for inserting, say, Engine.ini into GConfig

code: static [FConfigContext](API\Runtime\Core\Misc\FConfigContext) ReadIntoPluginFile ( [FConfigFile](API\Runtime\Core\Misc\FConfigFile) & DestConfigFile, const [FString](API\Runtime\Core\Containers\FString) & PluginRootDir, const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & ChildPluginsBaseDirs )


description: Create a context to read a non-hierarchical config into the given ConfigSystem structure - usually will be for other platforms

code: static [FConfigContext](API\Runtime\Core\Misc\FConfigContext) ReadSingleIntoConfigSystem ( [FConfigCacheIni](API\Runtime\Core\Misc\FConfigCacheIni) * ConfigSystem, const [FString](API\Runtime\Core\Containers\FString) & Platform )


description: Create a context to read a non-hierarchical config into GConfig. Only for current platform.


description: Create a context to read a non-hierarchical config into the given localFConfigFile, optionally for another platform

code: static [FConfigContext](API\Runtime\Core\Misc\FConfigContext) ReadSingleIntoLocalFile ( [FConfigFile](API\Runtime\Core\Misc\FConfigFile) & DestConfigFile, const [FString](API\Runtime\Core\Containers\FString) & Platform )


description: Create a context to read a hierarchy, but once it reaches the given filename (StartDeletingFilename), it will not read in anymore files at that point

code: static [FConfigContext](API\Runtime\Core\Misc\FConfigContext) ReadUpToBeforeFile ( [FConfigFile](API\Runtime\Core\Misc\FConfigFile) & DestConfigFile, const [FString](API\Runtime\Core\Containers\FString) & Platform, const [FString](API\Runtime\Core\Containers\FString) & StartSkippingAtFilename )


code: [FConfigContext](API\Runtime\Core\Misc\FConfigContext) & ResetBaseIni ( const TCHAR * InBaseIniName )


code: FConfigContext ( [FConfigCacheIni](API\Runtime\Core\Misc\FConfigCacheIni) * InConfigSystem, bool InIsHierarchicalConfig, const [FString](API\Runtime\Core\Containers\FString) & InPlatform, [FConfigFile](API\Runtime\Core\Misc\FConfigFile) * DestConfigFile )


description: Deprecated* Call AddDynamicLayerToHierarchy. You also may need to call GetConfigFilename to get the rightFConfigFile

code: void AddDynamicLayerToHeirarchy ( const [FString](API\Runtime\Core\Containers\FString) & Filename )


className: FConfigContext

code: class FConfigContext

bAllowGeneratedIniWhenCooked

type: bool

ChildPluginBaseDirs

type: TArray<FString...

ConfigFile

type: FConfigFile...

ConfigSystem

type: FConfigCacheIni...

IniCacheSet

type: constTSet<FSt...

description: If this is non-null, it contains a set of pre-scanned ini files to use to find files, instead of looking on disk

PerPlatformDirs

type: TMap<FString, ...

ProjectNotForLicenseesDir

description: Useful strings that are used alot when walking the hierarchy


description: Appends a new INI file to the SourceIniHierarchy and combines it with the current contents

code: void AddDynamicLayerToHierarchy ( const [FString](API\Runtime\Core\Containers\FString) & Filename )


description: Adds any properties that exist in InSourceFile that this config file is missing

code: void AddMissingProperties ( const [FConfigFile](API\Runtime\Core\Misc\FConfigFile) & InSourceFile )


description: Append a correctly escaped line to add to the config file for the given property

code: static void AppendExportedPropertyLine ( [FString](API\Runtime\Core\Containers\FString) & Out, const [FString](API\Runtime\Core\Containers\FString) & PropertyName, const [FString](API\Runtime\Core\Containers\FString) & PropertyValue )


code: bool Combine ( const [FString](API\Runtime\Core\Containers\FString) & Filename )


description: Deprecated* Use CombineFromBuffer that takes FileHint

code: void CombineFromBuffer ( const [FString](API\Runtime\Core\Containers\FString) & Buffer )


code: void CombineFromBuffer ( const [FString](API\Runtime\Core\Containers\FString) & Buffer, const [FString](API\Runtime\Core\Containers\FString) & FileHint )


code: bool DoesSectionExist ( const TCHAR * Section ) const


code: void Dump ( [FOutputDevice](API\Runtime\Core\Misc\FOutputDevice) & Ar )


description: Generate a correctly escaped line to add to the config file for the given property

code: static [FString](API\Runtime\Core\Containers\FString) GenerateExportedPropertyLine ( const [FString](API\Runtime\Core\Containers\FString) & PropertyName, const [FString](API\Runtime\Core\Containers\FString) & PropertyValue )


description: Looks for a section by name, and creates an empty one if it can't be found

code: [FConfigSection](API\Runtime\Core\Misc\FConfigSection) * FindOrAddSection ( const [FString](API\Runtime\Core\Containers\FString) & Name )


code: bool GetDouble ( const TCHAR * Section, const TCHAR * Key, double & Value ) const


code: bool GetBool ( const TCHAR * Section, const TCHAR * Key, bool & Value ) const


code: int32 GetArray ( const TCHAR * Section, const TCHAR * Key, [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & Value ) const


code: bool GetFloat ( const TCHAR * Section, const TCHAR * Key, float & Value ) const


code: bool GetInt64 ( const TCHAR * Section, const TCHAR * Key, int64 & Value ) const


code: bool GetString ( const TCHAR * Section, const TCHAR * Key, [FString](API\Runtime\Core\Containers\FString) & Value ) const


code: bool GetText ( const TCHAR * Section, const TCHAR * Key, [FText](API\Runtime\Core\Internationalization\FText) & Value ) const


description: Generic versions for use with templates

code: bool GetValue ( const TCHAR * Section, const TCHAR * Key, [FString](API\Runtime\Core\Containers\FString) & Value ) const


code: bool GetValue ( const TCHAR * Section, const TCHAR * Key, [FText](API\Runtime\Core\Internationalization\FText) & Value ) const


code: bool GetValue ( const TCHAR * Section, const TCHAR * Key, int32 & Value ) const


code: bool GetValue ( const TCHAR * Section, const TCHAR * Key, double & Value ) const


code: bool GetValue ( const TCHAR * Section, const TCHAR * Key, float & Value ) const


code: bool GetValue ( const TCHAR * Section, const TCHAR * Key, int64 & Value ) const


code: bool GetInt ( const TCHAR * Section, const TCHAR * Key, int32 & Value ) const


code: bool GetValue ( const TCHAR * Section, const TCHAR * Key, bool & Value ) const


code: int32 GetValue ( const TCHAR * Section, const TCHAR * Key, [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & Value ) const


code: bool operator!= ( const [FConfigFile](API\Runtime\Core\Misc\FConfigFile) & Other ) const


code: bool operator== ( const [FConfigFile](API\Runtime\Core\Misc\FConfigFile) & Other ) const


description: Checks the command line for any overridden config file settings

code: static bool OverrideFileFromCommandline ( [FString](API\Runtime\Core\Containers\FString) & Filename )


description: Looks for any overrides on the commandline for this file

code: static void OverrideFromCommandline ( [FConfigFile](API\Runtime\Core\Misc\FConfigFile) * File, const [FString](API\Runtime\Core\Containers\FString) & Filename )


description: Deprecated* Use ProcessInputFileContents that takes FileHint

code: void ProcessInputFileContents ( const [FString](API\Runtime\Core\Containers\FString) & Buffer )


description: Process the contents of an .ini file that has been read into anFString

code: void ProcessInputFileContents ( FStringView Contents, const [FString](API\Runtime\Core\Containers\FString) & FileHint )


description: Check the source hierarchy which was loaded without any user changes from the Config/Saved dir. If anything in the default/base options have changed, we need to ensure that these propagate through to the final config so they are not potentially ignored


code: void Read ( const [FString](API\Runtime\Core\Containers\FString) & Filename )


code: void SetArray ( const TCHAR * Section, const TCHAR * Key, const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & Value )


code: void SetBool ( const TCHAR * Section, const TCHAR * Key, bool Value )


code: void SetDouble ( const TCHAR * Section, const TCHAR * Key, double Value )


code: void SetFloat ( const TCHAR * Section, const TCHAR * Key, float Value )


code: void SetInt64 ( const TCHAR * Section, const TCHAR * Key, const int64 Value )


code: void SetString ( const TCHAR * Section, const TCHAR * Key, const TCHAR * Value )


code: void SetText ( const TCHAR * Section, const TCHAR * Key, const [FText](API\Runtime\Core\Internationalization\FText) & Value )


description: Checks if the PropertyValue should be exported in quotes when writing the ini to disk.

code: static bool ShouldExportQuotedString ( const [FString](API\Runtime\Core\Containers\FString) & PropertyValue )


description: Saves only the sections in thisFConfigFileinto the given file. All other sections in the file are left alone. The sections in this file are completely replaced. If IniRootName is specified, the current section settings are diffed against the file in the hierarchy up to right before this file (so, if you are saving DefaultEngine.ini, and IniRootName is "Engine", then Base.ini and BaseEngine.ini will be loaded, and only differences against that will be saved into DefaultEngine.ini)

code: void UpdateSections ( const TCHAR * DiskFilename, const TCHAR * IniRootName, const TCHAR * OverridePlatform )


description: Update a single property in the config file, for the section that is specified.

code: bool UpdateSinglePropertyInSection ( const TCHAR * DiskFilename, const TCHAR * PropertyName, const TCHAR * SectionName )


description: Write this ConfigFile to the given Filename, constructed the text from the config sections in *this, prepended by the optional PrefixText

code: bool Write ( const [FString](API\Runtime\Core\Containers\FString) & Filename, bool bDoRemoteWrite, const [FString](API\Runtime\Core\Containers\FString) & PrefixText )


description: Whether to write a temp file then move it to it's destination when saving.

code: static bool WriteTempFileThenMove()


description: Write this ConfigFile to the given string, constructed the text from the config sections in *this, prepended by the optional PrefixText

code: void WriteToString ( [FString](API\Runtime\Core\Containers\FString) & InOutText, const [FString](API\Runtime\Core\Containers\FString) & SimulatedFilename, const [FString](API\Runtime\Core\Containers\FString) & PrefixText )


className: FConfigFile

code: class FConfigFile : public [TMap< FString, FConfigSection >](API\Runtime\Core\Containers\TMap)

CommandlineOptions

type: TArray<FConfig...

description: The collection of overrides which stemmed from the commandline

Name

type: FName

description: The name of this config file

PlatformName

type: FString

SourceConfigFile

description: The untainted config file which contains the coalesced base/default options. I.e. No Saved/ options

SourceEngineConfigDir

description: Locations where this file may have come from - used to merge with non-standard ini locations.

SourceIniHierarchy

type: FConfigFileHier...

description: The collection of source files which were used to generate this file.


className: FConfigLayer

description: Structure to define all the layers of the config system. Layers can be expanded by expansion files (NoRedist, etc), or by ini platform parents

code: struct FConfigLayer

EditorName

type: const TCHAR ...

description: Used by the editor to display in the ini-editor.

Flag

type: EConfigLayerFla...

description: Special flag.

Path

description: Path to the ini file (with variables)


className: FConfigFileHierarchy

code: class FConfigFileHierarchy : public [TMap< int32, FString >](API\Runtime\Core\Containers\TMap)


className: FConfigLayerExpansion

description: This describes extra files per layer, to deal with restricted and NDA covered platform files that can't have the settings be in the Base/Default ini files. Note that we treat DedicatedServer as a "Platform" where it will have it's own directory of files, like a platform

code: struct FConfigLayerExpansion

description: A set of replacements from the source file to possible other files

Flags

type: EConfigExpansio...


description: Process the '+' and '.' commands, takingf into account ArrayOfStruct unique keys

code: void HandleAddCommand ( [FName](API\Runtime\Core\UObject\FName) Key, [FString](API\Runtime\Core\Containers\FString) && Value, bool bAppendValueIfNotArrayOfStructsKeyUsed )


code: bool HandleArrayOfKeyedStructsCommand ( [FName](API\Runtime\Core\UObject\FName) Key, [FString](API\Runtime\Core\Containers\FString) && Value )


description:
Check whether the input string is surrounded by quotes
true if the input string is surrounded by quotes

code: static bool HasQuotes ( const [FString](API\Runtime\Core\Containers\FString) & Test )


code: template<typename Allocator> void MultiFind ( const [FName](API\Runtime\Core\UObject\FName) Key, [TArray](API\Runtime\Core\Containers\TArray)< [FConfigValue](API\Runtime\Core\Misc\FConfigValue), Allocator > & OutValues, const bool bMaintainOrder ) const


code: template<typename Allocator> void MultiFind ( const [FName](API\Runtime\Core\UObject\FName) Key, [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString), Allocator > & OutValues, const bool bMaintainOrder ) const


code: bool operator== ( const [FConfigSection](API\Runtime\Core\Misc\FConfigSection) & Other ) const


code: bool operator!= ( const [FConfigSection](API\Runtime\Core\Misc\FConfigSection) & Other ) const


className: FConfigSection

description: One section in a config file.

code: class FConfigSection : public [TMultiMap< FName, FConfigValue >](API\Runtime\Core\Containers\TMultiMap)

ArrayOfStructKeys

type: TMap<FName,FS...

description: Look for "array of struct" keys for overwriting single entries of an array


description:
Given an expanded config value, try and produce a collapsed version of it (adding any placeholder tokens).
true if collapsing occurred, false if the collapsed and expanded values are equal.

code: static bool CollapseValue ( const [FString](API\Runtime\Core\Containers\FString) & InExpandedValue, [FString](API\Runtime\Core\Containers\FString) & OutCollapsedValue )


description:
Given an expanded config value, try and produce a collapsed version of it (adding any placeholder tokens).
The collapsed version of the config value.

code: static [FString](API\Runtime\Core\Containers\FString) CollapseValue ( const [FString](API\Runtime\Core\Containers\FString) & InExpandedValue )


description:
Given a collapsed config value, try and produce an expanded version of it (removing any placeholder tokens).
The expanded version of the config value.

code: static [FString](API\Runtime\Core\Containers\FString) ExpandValue ( const [FString](API\Runtime\Core\Containers\FString) & InCollapsedValue )


description:
Given a collapsed config value, try and produce an expanded version of it (removing any placeholder tokens).
true if expansion occurred, false if the collapsed and expanded values are equal.

code: static bool ExpandValue ( const [FString](API\Runtime\Core\Containers\FString) & InCollapsedValue, [FString](API\Runtime\Core\Containers\FString) & OutExpandedValue )


description: Returns the original ini setting without macro expansion.

code: const [FString](API\Runtime\Core\Containers\FString) & GetSavedValue() const


description: Returns the ini setting with any macros expanded out.

code: const [FString](API\Runtime\Core\Containers\FString) & GetValue() const


code: [FConfigValue](API\Runtime\Core\Misc\FConfigValue) & operator= ( [FConfigValue](API\Runtime\Core\Misc\FConfigValue) && RHS )


code: [FConfigValue](API\Runtime\Core\Misc\FConfigValue) & operator= ( const [FConfigValue](API\Runtime\Core\Misc\FConfigValue) & RHS )


code: bool operator== ( const [FConfigValue](API\Runtime\Core\Misc\FConfigValue) & Other ) const


code: bool operator!= ( const [FConfigValue](API\Runtime\Core\Misc\FConfigValue) & Other ) const


code: void SetHasBeenRead ( bool InBRead ) const


code: FConfigValue ( const TCHAR * InValue )


code: FConfigValue ( const [FString](API\Runtime\Core\Containers\FString) & InValue )


code: FConfigValue ( [FString](API\Runtime\Core\Containers\FString) && InValue )


code: FConfigValue ( const [FConfigValue](API\Runtime\Core\Misc\FConfigValue) & InConfigValue )


code: FConfigValue ( [FConfigValue](API\Runtime\Core\Misc\FConfigValue) && InConfigValue )


className: FContextSupplier

description: Interface for returning a context string.

code: class FContextSupplier


description: Return the notification prompt action. The action resets to `None_ when the notification state changes.

code: virtual EAsyncTaskNotificationPromptAction GetPromptAction() const


description: Initialize this notification based on the given config.

code: virtual void Initialize ( const [FAsyncTaskNotificationConfig](API\Runtime\Core\Misc\FAsyncTaskNotificationConfig) & InConfig )


description: Set whether this task be canceled.

code: virtual void SetCanCancel ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< bool > & InCanCancel )


description: Set the task as complete.

code: virtual void SetComplete ( const bool bSuccess )


description: Update the text and set the task as complete.

code: virtual void SetComplete ( const [FText](API\Runtime\Core\Internationalization\FText) & InTitleText, const [FText](API\Runtime\Core\Internationalization\FText) & InProgressText, const bool bSuccess )


description: Set the hyperlink text of this notification.

code: virtual void SetHyperlink ( const FSimpleDelegate & InHyperlink, const [FText](API\Runtime\Core\Internationalization\FText) & InHyperlinkText )


description: Set whether to keep this notification open on failure.

code: virtual void SetKeepOpenOnFailure ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< bool > & InKeepOpenOnFailure )


description: Set whether to keep this notification open on success.

code: virtual void SetKeepOpenOnSuccess ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< bool > & InKeepOpenOnSuccess )


description: Set the progress text of this notification.

code: virtual void SetProgressText ( const [FText](API\Runtime\Core\Internationalization\FText) & InProgressText )


description: Set the task notification state. provides finer control than SetComplete

code: virtual void SetNotificationState ( const [FAsyncNotificationStateData](API\Runtime\Core\Misc\FAsyncNotificationStateData) & InState )


description: Set the title text of this notification.

code: virtual void SetTitleText ( const [FText](API\Runtime\Core\Internationalization\FText) & InTitleText, const bool bClearProgressText )


description: Set the prompt text of this notification.

code: virtual void SetPromptText ( const [FText](API\Runtime\Core\Internationalization\FText) & InPromptText )


description: Update the notification (the critical section is held while this function is called)

code: virtual void UpdateNotification()


className: FCoreAsyncTaskNotificationImpl

description: Basic asynchronous task notification that just logs status changes.

code: class FCoreAsyncTaskNotificationImpl : public [IAsyncTaskNotificationImpl](API\Runtime\Core\Misc\IAsyncTaskNotificationImpl)

Hyperlink

type: FSimpleDelegate

description: When set this will display as a hyperlink on the right side of the notification.

HyperlinkText

type: FText

description: Text to display for the hyperlink message

ProgressText

description: The progress text displayed in the notification (if any)

State

type: EAsyncTaskNotif...

description: The current state of this notification

TitleText

description: The title text displayed in the notification (if any)


description: Called when the application fails to register for remote notifications


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


className: ApplicationHasReactivatedDelegate

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

code: static [TMulticastDelegate](API\Runtime\Core\Delegates\TMulticastDelegate)< void()> ApplicationHasReactivatedDelegate;


className: ApplicationHasEnteredForegroundDelegate

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


className: ApplicationLicenseChange

description: Called when an application is notified that the application license info has been updated. The new license data should be polled and steps taken based on the results (i.e. halt application if license is no longer valid).

code: static [TMulticastDelegate](API\Runtime\Core\Delegates\TMulticastDelegate)< void()> ApplicationLicenseChange;


className: ApplicationNetworkInitializationChanged

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

code: static [TMulticastDelegate](API\Runtime\Core\Delegates\TMulticastDelegate)< void(bool bIsNetworkInitialized)> ApplicationNetworkInitializationChanged;


className: ApplicationPerformFetchDelegate

description: Called when the application receives notice to perform a background fetch

code: static [TMulticastDelegate](API\Runtime\Core\Delegates\TMulticastDelegate)< void()> ApplicationPerformFetchDelegate;


description: Called when the application receives a remote notification


description: Sent when a device screen orientation changes


description: Called when the application receives a local notification

code: static [TMulticastDelegate](API\Runtime\Core\Delegates\TMulticastDelegate)< void([FString](API\Runtime\Core\Containers\FString), int, int)> ApplicationReceivedLocalNotificationDelegate;


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

code: static [TMulticastDelegate](API\Runtime\Core\Delegates\TMulticastDelegate)< void(const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > &)> ApplicationReceivedStartupArgumentsDelegate;


description: IOS-style push notification delegates

code: static [TMulticastDelegate](API\Runtime\Core\Delegates\TMulticastDelegate)< void([TArray](API\Runtime\Core\Containers\TArray)< uint8 >)> ApplicationRegisteredForRemoteNotificationsDelegate;


className: ApplicationRequestAudioState

description: Generally, events triggering UserMusicInterruptDelegate or AudioMuteDelegate happen only when a change occurs. When a system comes online needing the current audio state but the event has already been broadcast, calling ApplicationRequestAudioState will force the UserMusicInterruptDelegate and AudioMuteDelegate to be called again if the low-level application layer supports it. Currently, this is available only on iOS.

code: static [TMulticastDelegate](API\Runtime\Core\Delegates\TMulticastDelegate)< void()> ApplicationRequestAudioState;


description: Called when the user grants permission to register for notifications


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


description: Some platform have a System UI Overlay that can draw on top of the application. The game might want to be notified so it can pause, etc... Parameter (bool) should be true if the system UI is displayed, otherwise false should be passed


className: ApplicationWillDeactivateDelegate

description: 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). The game should be paused if possible, etc...

code: static [TMulticastDelegate](API\Runtime\Core\Delegates\TMulticastDelegate)< void()> ApplicationWillDeactivateDelegate;


className: ApplicationWillEnterBackgroundDelegate

description: 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.


className: ApplicationWillTerminateDelegate

description: Thismaybe called when the application is getting terminated by the OS. There is no guarantee that this will ever be called on a mobile device, save state when ApplicationWillEnterBackgroundDelegate is called instead.

code: static [TMulticastDelegate](API\Runtime\Core\Delegates\TMulticastDelegate)< void()> ApplicationWillTerminateDelegate;


className: AudioMuteDelegate

description: [iOS only] Called when the mute switch is detected as changed or when the volume changes. Parameter 1 is the mute switch state (true is muted, false is unmuted). Parameter 2 is the volume as an integer from 0 to 100.

code: static [TMulticastDelegate](API\Runtime\Core\Delegates\TMulticastDelegate)< void(bool, int)> AudioMuteDelegate;


className: ColorPickerChanged

description: Color picker color has changed, please refresh as needed


className: AudioRouteChangedDelegate

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

code: static [TMulticastDelegate](API\Runtime\Core\Delegates\TMulticastDelegate)< void(bool)> AudioRouteChangedDelegate;


className: CrashOverrideParamsChanged

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

code: static [TMulticastDelegate](API\Runtime\Core\Delegates\TMulticastDelegate)< void(const [FCrashOverrideParameters](API\Runtime\Core\Misc\FCrashOverrideParameters) &)> CrashOverrideParamsChanged;


className: CreatePackageStore

code: static [TDelegate](API\Runtime\Core\Delegates\TDelegate)< [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< class IPackageStore >)> CreatePackageStore;


className: EOnScreenMessageSeverity

code: enum EOnScreenMessageSeverity { Info, Warning, Error, }


className: ETemperatureSeverity

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

code: enum ETemperatureSeverity { Unknown, Good, Bad, Serious, Critical, NumSeverities, }


className: FAttachShaderReadRequestFunc

code: typedef [TFunctionRef](API\Runtime\Core\GenericPlatform\TFunctionRef)< class [FIoRequest](API\Runtime\Core\IO\FIoRequest)(const class [FIoChunkId](API\Runtime\Core\IO\FIoChunkId) &, FGraphEventRef)> FAttachShaderReadRequestFunc


code: FExtraBinaryConfigData &40; class FConfigCacheIni & InConfig, bool InIsGenerating &41;


className: FExtraBinaryConfigData

description: 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 TheTMapis 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)

code: struct FExtraBinaryConfigData

bIsGenerating

type: bool

description: If true, the callback should fill out Data/Config

Config

description: Ini config data (not necessarily GConfig)

Data

description: The data that will be saved/loaded quickly


className: FMovieStreamerPtr

code: typedef [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< class [IMovieStreamer](API\Runtime\MoviePlayer\IMovieStreamer), ESPMode::ThreadSafe > FMovieStreamerPtr


className: FOnDisallowedExecCommandCalled

description: Called whenFExec::Execis called in a context where it's disallowed (UE_ALLOW_EXEC_COMMANDS = 0).

code: typedef TMulticastDelegate_OneParam< void, const TCHAR * > FOnDisallowedExecCommandCalled


className: FOnNamedCommandParsed

description: Called whenFParse::Commandsucceeds. Used to audit named commands usage.

code: typedef TMulticastDelegate_OneParam< void, const TCHAR * > FOnNamedCommandParsed


className: FOnNetworkConnectionChanged

code: typedef TMulticastDelegate_OneParam< void, ENetworkConnectionType > FOnNetworkConnectionChanged


className: GameSessionIDChanged

description: Sent when application code changes the currently active game session. The exact semantics of this will vary between games but it is useful for analytics, crash reports, etc

code: static [TMulticastDelegate](API\Runtime\Core\Delegates\TMulticastDelegate)< void(const [FString](API\Runtime\Core\Containers\FString) &)> GameSessionIDChanged;


className: GameStateClassChanged

description: Sent when application code changes game state. The exact semantics of this will vary between games but it is useful for analytics, crash reports, etc

code: static [TMulticastDelegate](API\Runtime\Core\Delegates\TMulticastDelegate)< void(const [FString](API\Runtime\Core\Containers\FString) &)> GameStateClassChanged;


className: GatherAdditionalLocResPathsCallback

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

code: static [TMulticastDelegate](API\Runtime\Core\Delegates\TMulticastDelegate)< void([TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > &)> GatherAdditionalLocResPathsCallback;


code: static TTSMulticastDelegate< void()> & GetApplicationWillTerminateDelegate()


description: Implemented as a function to address global ctor issues

code: static [TMulticastDelegate](API\Runtime\Core\Delegates\TMulticastDelegate)< void(const uint64, const uint64)> & GetGPUOutOfMemoryDelegate()


description: Get a hotfix delegate

code: static [TDelegate](API\Runtime\Core\Delegates\TDelegate)< void(void *, int32)> & GetHotfixDelegate ( [EHotfixDelegates::Type](API\Runtime\Core\Misc\EHotfixDelegates__Type) HotFix )


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

code: static FSimpleMulticastDelegate & GetLowLevelAllocatorMemoryTrimDelegate()


code: static FSimpleMulticastDelegate & GetMemoryTrimDelegate()


code: static TTSMulticastDelegate< void(const TCHAR *PakFile, const TCHAR *FileName)> & GetOnFileOpenedForReadFromPakFile()


code: static TTSMulticastDelegate< void(const [IPakFile](API\Runtime\Core\GenericPlatform\IPakFile) &)> & GetOnPakFileMounted2()


code: static FSimpleMulticastDelegate & GetOutOfMemoryDelegate()


code: static [TDelegate](API\Runtime\Core\Delegates\TDelegate)< void(uint8[32])> & GetPakEncryptionKeyDelegate()


code: static [TDelegate](API\Runtime\Core\Delegates\TDelegate)< void([TArray](API\Runtime\Core\Containers\TArray)< uint8 > &, [TArray](API\Runtime\Core\Containers\TArray)< uint8 > &)> & GetPakSigningKeysDelegate()


description: Callback for platform specific very early init code.

code: static [TMulticastDelegate](API\Runtime\Core\Delegates\TMulticastDelegate)< void()> & GetPreMainInitDelegate()


description: Called to request that low level allocator must refreshed.

code: static FSimpleMulticastDelegate & GetRefreshLowLevelAllocatorDelegate()


code: static [TMulticastDelegate](API\Runtime\Core\Delegates\TMulticastDelegate)< void(const [FGuid](API\Runtime\Core\Misc\FGuid) &, const [FAES::FAESKey](API\Runtime\Core\Misc\FAES\FAESKey) &)> & GetRegisterEncryptionKeyMulticastDelegate()


className: IsLoadingMovieCurrentlyPlaying

code: static [TDelegate](API\Runtime\Core\Delegates\TDelegate)< bool()> IsLoadingMovieCurrentlyPlaying;


className: HotFixDelegates

description: Callbacks for hotfixes.

code: static [TArray](API\Runtime\Core\Containers\TArray)< [TDelegate](API\Runtime\Core\Delegates\TDelegate)< void(void *, int32)> > HotFixDelegates;


className: IsVanillaProductChanged

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

code: static [TMulticastDelegate](API\Runtime\Core\Delegates\TMulticastDelegate)< void(bool)> IsVanillaProductChanged;


className: LaunchCustomHandlerForURL

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

code: static [TDelegate](API\Runtime\Core\Delegates\TDelegate)< void(const [FString](API\Runtime\Core\Containers\FString) &URL, [FString](API\Runtime\Core\Containers\FString) *Error)> LaunchCustomHandlerForURL;


className: MobileBackgroundTickDelegate

description: Called when in the background, if the OS is giving CPU time to the device. It is very likely this will never be called due to mobile OS backgrounded CPU restrictions. But if, for instance, VOIP is active on iOS, the will be getting called

code: static [TMulticastDelegate](API\Runtime\Core\Delegates\TMulticastDelegate)< void(float DeltaTime)> MobileBackgroundTickDelegate;


className: ModalMessageDialog

description: Requests to open a message box

code: static [TDelegate](API\Runtime\Core\Delegates\TDelegate)< [EAppReturnType::Type](API\Runtime\Core\GenericPlatform\EAppReturnType__Type)(EAppMsgCategory, [EAppMsgType::Type](API\Runtime\Core\GenericPlatform\EAppMsgType__Type), const [FText](API\Runtime\Core\Internationalization\FText) &, const [FText](API\Runtime\Core\Internationalization\FText) &)> ModalMessageDialog;


className: MountPak

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

code: static [TDelegate](API\Runtime\Core\Delegates\TDelegate)< [IPakFile](API\Runtime\Core\GenericPlatform\IPakFile) *(const [FString](API\Runtime\Core\Containers\FString) &, int32)> MountPak;


className: NewFileAddedDelegate

description: After a file is added this is called.

code: static [TMulticastDelegate](API\Runtime\Core\Delegates\TMulticastDelegate)< void(const [FString](API\Runtime\Core\Containers\FString) &)> NewFileAddedDelegate;


className: NoPakFilesMountedDelegate

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

code: static [TMulticastDelegate](API\Runtime\Core\Delegates\TMulticastDelegate)< void()> NoPakFilesMountedDelegate;


className: OnActivatedByProtocol

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

code: static [TMulticastDelegate](API\Runtime\Core\Delegates\TMulticastDelegate)< void(const [FString](API\Runtime\Core\Containers\FString) &[Parameter](API\Plugins\Niagara\ENiagaraInputNodeUsage), [FPlatformUserId](API\Runtime\Core\Misc\FPlatformUserId) UserId)> OnActivatedByProtocol;


className: OnActorLabelChanged

description: Called when an actor label is changed.

code: static [TMulticastDelegate](API\Runtime\Core\Delegates\TMulticastDelegate)< void([AActor](API\Runtime\Engine\GameFramework\AActor) *)> OnActorLabelChanged;


className: OnAllModuleLoadingPhasesComplete

description: Called after all modules have been loaded for all phases.


className: OnApplyCVarFromIni

code: static [TMulticastDelegate](API\Runtime\Core\Delegates\TMulticastDelegate)< void(const TCHAR *SectionName, const TCHAR *IniFilename, uint32 SetBy, bool bAllowCheating)> OnApplyCVarFromIni;


className: OnAsyncLoadingFlush

description: Callback for platform handling when flushing async loads.

code: static [TMulticastDelegate](API\Runtime\Core\Delegates\TMulticastDelegate)< void()> OnAsyncLoadingFlush;


className: OnAsyncLoadingFlushUpdate

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

code: static [TMulticastDelegate](API\Runtime\Core\Delegates\TMulticastDelegate)< void()> OnAsyncLoadingFlushUpdate;


className: OnAsyncLoadPackage

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

code: static [TMulticastDelegate](API\Runtime\Core\Delegates\TMulticastDelegate)< void(const [FString](API\Runtime\Core\Containers\FString) &)> OnAsyncLoadPackage;


className: OnBeginFrame

description: Called at the beginning of a frame.


className: OnBeginFrameRT

description: Called at the beginning of a frame on the renderthread.


className: OnChildEndFramePostFork

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


className: OnCommandletPostMain

description: Called after running the Main function for commandlets.


className: OnCommandletPreMain

description: Called prior to running the Main function for commandlets.


className: OnControllerConnectionChange

description: Callback when controllers disconnected / reconnected

code: static [TMulticastDelegate](API\Runtime\Core\Delegates\TMulticastDelegate)< void(bool, [FPlatformUserId](API\Runtime\Core\Misc\FPlatformUserId), int32)> OnControllerConnectionChange;


className: OnControllerPairingChange

description: Callback when a single controller pairing changes

code: static [TMulticastDelegate](API\Runtime\Core\Delegates\TMulticastDelegate)< void(int32 ControllerIndex, [FPlatformUserId](API\Runtime\Core\Misc\FPlatformUserId) NewUserPlatformId, [FPlatformUserId](API\Runtime\Core\Misc\FPlatformUserId) OldUserPlatformId)> OnControllerPairingChange;


className: OnEndFrame

description: Called at the end of a frame.


className: OnEndFrameRT

description: Called at the end of a frame on the renderthread.


className: OnEnginePreExit

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


className: OnFeatureLevelDisabled

description: Called when a feature level is disabled by the user.

code: static [TMulticastDelegate](API\Runtime\Core\Delegates\TMulticastDelegate)< void(int, const [FName](API\Runtime\Core\UObject\FName) &)> OnFeatureLevelDisabled;


className: OnExit

description: Called when the application is about to exit.

code: static FSimpleMulticastDelegate OnExit;


className: OnFEngineLoopInitComplete

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


className: OnFileOpenedForReadFromPakFile

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

code: static [TMulticastDelegate](API\Runtime\Core\Delegates\TMulticastDelegate)< void(const TCHAR *PakFile, const TCHAR *FileName), [FNotThreadSafeNotCheckedDelegateUserPolicy](API\Runtime\Core\Delegates\FNotThreadSafeNotCheckedDelegate-) > OnFileOpenedForReadFromPakFile;


className: OnGCFinishDestroyTimeExtended

description: Sent when GC finish destroy takes more time than expected

code: static [TMulticastDelegate](API\Runtime\Core\Delegates\TMulticastDelegate)< void(const [FString](API\Runtime\Core\Containers\FString) &)> OnGCFinishDestroyTimeExtended;


className: OnGetBuildURL

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

code: static [TDelegate](API\Runtime\Core\Delegates\TDelegate)< const TCHAR *()> OnGetBuildURL;


className: OnGetExecutingJobURL

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

code: static [TDelegate](API\Runtime\Core\Delegates\TDelegate)< const TCHAR *()> OnGetExecutingJobURL;


className: OnGetOnScreenMessages

description: 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(LOCTEXT("MyMessage", "My Status: {0}"), SomeStatus)); }