Misc

Windows
MacOS
Linux

Classes

Name

Description

Public struct

FAES

Public struct

FAnd

Public class

FApp

Provides information about the application.

Public class

FAsciiSet

ASCII character bitset useful for fast and readable parsing

Public class

FAsyncSHAVerify

Asynchronous SHA verification

Public class

FAsyncTaskNotification

Provides notifications for an on-going asynchronous task.

Public struct

FAsyncTaskNotificationConfig

Configuration data for initializing an asynchronous task notification.

Public class

FAsyncTaskNotificationFactory

Factory to allow other systems (such as Slate) to override the default asynchronous task notification implementation.

Public class

FAsyncWriter

Thread heartbeat check class.

Public struct

FAutomationEvent

Public struct

FAutomationExecutionEntry

Public struct

FAutomationExpectedError

Public struct

FAutomationScreenshotCompareResults

Public struct

FAutomationScreenshotData

Public class

FAutomationSpecBase

Public class

FAutomationTestBase

Simple abstract base class for all automation tests

Public class

FAutomationTestExecutionInfo

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

Public class

FAutomationTestFramework

Class representing the main framework for running automation tests

Public class

FAutomationTestInfo

Simple class to store the automation test info

Public struct

FBase64

Class for encoding/decoding Base64 data (RFC 4648)

Public class

FBDDAutomationTestBase

Public struct

FBlueprintExceptionTracker

Helper struct for dealing with Blueprint exceptions

Public struct

FBoolConfigValueHelper

Helper structure for boolean values in config

Public struct

FBufferedLine

The type of lines buffered by secondary threads.

Public class

FBufferedOutputDevice

Buffered output device.

Public class

FBufferReaderWithSHA

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

Public class

FChange

FChange modifies a UObject and is meant to be used to implement undo/redo.

Public class

FCodec

Public class

FCodecBWT

Public class

FCodecFull

Public class

FCodecHuffman

Public class

FCodecMTF

Public class

FCodecRLE

Public class

FCommandChange

To use FCommandChange you must implement Apply() and Revert()Revert() is called to "Undo" and Apply() is called to "Redo"

Public struct

FCommandLine

Public struct

FCompiledToken

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

Public class

FCompoundChange

FCompoundChange applies a sequence of FSwapChanges.

Public struct

FCompoundChangeInput

Public struct

FCompressedGrowableBuffer

Growable compressed buffer.

Public struct

FCompression

Public class

FConfigCacheIni

Set of all cached config files.

Public struct

FConfigCommandlineOverride

Options which stemmed from the commandline.

Public class

FConfigFile

Public class

FConfigSection

One section in a config file.

Public struct

FConfigValue

Public class

FContextSupplier

Interface for returning a context string.

Public class

FCoreAsyncTaskNotificationImpl

Basic asynchronous task notification that just logs status changes.

Public class

FCoreDelegates

Public struct

FCrashOverrideParameters

Parameters passed to CrashOverrideParamsChanged used to customize crash report client behavior/appearance. If the corresponding bool is not true, this value will not be stored.

Public struct

FCrc

CRC hash generation for different types of input data

Public struct

FDataDrivenPlatformInfoRegistry

Public struct

FDateTime

Implements a date and time.

Public struct

FDebug

FDebug These functions offer debugging and diagnostic functionality and its presence depends on compiler switches.

Public class

FDefaultValueHelper

FDefaultValueHelper

Public class

FDelayedFunctionLatentCommand

Public struct

FEmbeddedCallParamsHelper

Wraps parameters and a completion delegate

Public class

FEmbeddedCommunication

Public class

FEmbeddedDelegates

Public class

FEmbeddedKeepAwake

RAII for keep awake functionality This may seem a bit over engineered, but it needs to have move semantics so that any aggregate that includes it doesn't lose move semantics.

Public struct

FEmptyVariantState

A special tag that can be used as the first type in a TVariant parameter pack if none of the other types can be default-constructed.

Public class

FEngineBuildSettings

Public class

FEngineVersion

Utility functions.

Public class

FEngineVersionBase

Base class for the EngineVersion class. Holds basic version numbers.

Public struct

FEqual

Public class

FExec

Any object that is capable of taking commands.

Public struct

FExpressionError

Simple error structure used for reporting parse errors

Private class

FExpressionGrammar

A lexical gammer defining how to parse an expression.

Public class

FExpressionNode

A node in an expression.

Public class

FExpressionToken

A specific token in a stream.

Private class

FExpressionTokenConsumer

Class used to consume tokens from a string

Public struct

FFallbackStruct

A struct used as stub for deleted ones.

Public struct

FFbxErrors

This file contains known map errors that can be referenced by name.

Public class

FFbxErrorToken

Map error specific message token.

Public class

FFeedbackContext

A context for displaying modal warning messages.

Public class

FFeedbackContextMarkup

A text-based markup language can be used to allow external processes to control the state machine, allowing command-line utilities to give graphical user feedback.

Public struct

FFileHelper

Public struct

FFnv

FNV hash generation for different types of input data

Public struct

FFrameNumber

Typesafe 32-bit signed frame number.

Public struct

FFrameRate

A frame rate represented as a fraction comprising 2 integers: a numerator (number of frames), and a denominator (per second)

Public struct

FFrameTime

Structure representing a time by a context-free frame number, plus a sub frame value in the range [0:1) Conversion to and from time in seconds is achieved in combination with FFrameRate.

Public class

FFunction

Public class

FFunctionLatentCommand

Run some code latently with a predicate lambda.

Public struct

FGreater

Public struct

FGreaterOrEqual

Public struct

FGrowableAllocationBase

Public class

FGrowableMallocBase

A base class for both the classes below, for usage tracking only

Public class

FGrowableMallocChunk

Public struct

FGuid

Implements a globally unique identifier.

Public struct

FHeapDataStorage

Data is stored on the heap in this implementation

Public struct

FIniFilename

FIniFilename struct.

Public struct

FInlineDataStorage

Implementation of the wrapper utility for any moveable/copyable data, that allows us to virtually move/copy/destruct the data Data is stored inline in this implementation, for efficiency

Public class

FInteractiveProcess

Implements an external process that can be interacted.

Public struct

FLess

Public struct

FLessOrEqual

Public class

FLocalTimestampDirectoryVisitor

Visitor to gather local files with their timestamps.

Public struct

FMaintenance

Public struct

FMapErrors

This file contains known map errors that can be referenced by name.

Public class

FMapErrorToken

Map error specific message token.

Public class

FMD5

MD5 Context.

Public struct

FMD5Hash

Simple helper struct to ease the caching of MD5 hashes

Public class

FMemMark

FMemMark marks a top-of-stack position in the memory stack.

Public class

FMemStack

Public class

FMemStackBase

Simple linear-allocation memory stack.

Public struct

FMessageDialog

FMessageDialog These functions open a message dialog and display the specified informations these.

Public class

FMonitoredProcess

Implements an external process that can be monitored.

Public struct

FNameBufferWithNumber

Fills string buffer with FName including number without forcing converting to wide character

Public class

FNetworkGUID

Implements a globally unique identifier for network related use.

Public class

FNetworkReplayVersion

Public struct

FNetworkVersion

Public class

FNoopCounter

Fake Thread safe counter, used to avoid cluttering code with ifdefs when counters are only used for debugging.

Public struct

FNot

Public struct

FNotEqual

Public struct

FObjectFullNameAndThumbnail

Wraps an object's full name and thumbnail

Public class

FObjectThumbnail

Thumbnail image data for an object.

Public struct

FOperatorFunctionID

Struct used to identify a function for a specific operator overload

Private struct

FOpParameters

Struct for storing binary operator definition parameters

Public struct

FOr

Public class

FOutputDevice

An output device.

Public class

FOutputDeviceAnsiError

Public class

FOutputDeviceArchiveWrapper

Output device wrapping any kind of FArchive.

Public class

FOutputDeviceConsole

This class servers as the base class for console window output.

Public class

FOutputDeviceDebug

Public class

FOutputDeviceError

Error device.

Public class

FOutputDeviceFile

File output device (Note: Only works if ALLOW_LOG_FILE && !NO_LOGGING is true, otherwise Serialize does nothing).

Public struct

FOutputDeviceHelper

Helper functions used by FOutputDevice derived classes

Public class

FOutputDeviceMemory

Memory output device. Logs only into pre-allocated memory buffer.

Public class

FOutputDeviceNull

Null output device.

Public class

FOutputDeviceRedirector

Class used for output redirection to allow logs to show

Public class

FPageAllocator

Public struct

FParse

Public class

FPaths

Path helpers for retrieving game dir, engine dir, etc.

Public struct

FQualifiedFrameTime

A frame time qualified by a frame rate context

Public class

FQueuedThreadPool

Interface for queued thread pools.

Public class

FRecursionScopeMarker

Public class

FRemoteConfig

Manages remote config files.

Public class

FRemoteConfigAsyncCachedWriteTask

Info for cached write tasks

Public struct

FRemoteConfigAsyncIOInfo

Stores info relating to remote config files

Public class

FRemoteConfigAsyncTaskManager

Manages async IO tasks for remote config files

Public class

FRemoteConfigAsyncWorker

Async task that handles the IO of a remote config file

Public struct

FRuntimeErrors

Public class

FRWScopeLock

Implements a scope lock for RW locks.

Public class

FScopedEvent

This class is allows a simple one-shot scoped event.

Public struct

FScopedScriptExceptionHandler

Scoped struct used to push and pop a script exception handler

Public struct

FScopedSlowTask

A scope block representing an amount of work divided up into sections.

Public struct

FScopeGuardSyntaxSupport

Public class

FScopeLock

Implements a scope lock.

Public class

FScopeTryLock

Implements a scope lock using TryLock.

Public class

FScriptExceptionHandler

Exception handler stack used for script exceptions.

Public class

FSelfRegisteringExec

Exec handler that registers itself and is being routed via StaticExec.

Public class

FSHA1

Public class

FSHAHash

Stores an SHA hash generated by FSHA1.

Public class

FSingleThreadEvent

Fake event object used when running with only one thread.

Public class

FSingleThreadRunnable

Interface for ticking runnables when there's only one thread available and multithreading is disabled.

Public struct

FSlowTask

Data type used to store information about a currently running slow task.

Public struct

FSlowTaskStack

A stack of feedback scopes

Public class

FStaticSelfRegisteringExec

Registers a static Exec function using FSelfRegisteringExec.

Public struct

FStringFormatArg

An argument supplied to FString::Format

Public class

FStringFormatter

A string formatter is responsible for formatting string patterns using a set of named, or ordered arguments

Public class

FStringToken

Simple struct that defines a specific token contained in an FTokenStream

Public class

FStructBuilder

Lays out up a struct at runtime, in hopefully the same way as a compiler, and returns the offset of each member as it's added.

Public struct

FSubExpressionEnd

Public struct

FSubExpressionStart

Public class

FSwapChange

To use FSwapChange you must implement Execute().

Public struct

FTestHotFixPayload

This is an example of a hotfix arg and return value structure. Once we have other examples, it can be deleted.

Public class

FTextFilterExpressionEvaluator

Defines an expression evaluator that can be used to perform complex text filter queries

Public class

FTextFilterString

String used by the text filter.

Public class

FTextToken

Public class

FThreadedAutomationLatentCommand

A simple latent command that runs the provided function on another thread

Public class

FThumbnailCompressionInterface

Thumbnail compression interface for packages.

Public struct

FTimecode

A timecode that stores time in HH:MM:SS format with the remainder of time represented by an integer frame count.

Public struct

FTimespan

Implements a time span.

Public struct

FToBoolHelper

Helper class used to convert CString into a boolean value.

Private class

FTokenDefinitions

A lexeme dictionary defining how to lex an expression.

Public class

FTokenStream

A token stream wraps up a raw string, providing accessors into it for consuming tokens

Public struct

FTransactionContext

Convenience struct for passing around transaction context.

Public struct

FTransactionDiff

Diff for a given transaction.

Public struct

FTransactionObjectDeltaChange

Delta-change information for an object that was transacted

Public class

FTransactionObjectEvent

Transaction object events.

Public class

FTypeContainer

Thread-unsafe type container (for backwards compatibility).

Public class

FUntilCommand

Public class

FUProjectDictionary

Dictionary of all the non-foreign projects for an engine installation, found by parsing .uprojectdirs files for source directories.

Public struct

FUrlConfig

Helper for obtaining the default Url configuration

Public class

FVariant

Implements an extensible union of multiple types.

Public class

FWildcardString

Implements a string with wild card pattern matching abilities.

Public class

IAsyncTaskNotificationImpl

Implementation interface of notifications for an on-going asynchronous task.

Public class

IAutomationLatentCommand

Simple abstract base class for creating time deferred of a single test that need to be run sequentially (Loadmap & Wait, Open Editor & Wait, then execute...)

Public class

IAutomationNetworkCommand

Simple abstract base class for networked, multi-participant tests

Public struct

ICompressionFormat

Public struct

IEngineCrypto

Public struct

IExpressionNodeStorage

Interface for a wrapper utility for any moveable/copyable data

Public class

IFilter

A generic interface that represents a Filter of ItemType.

Public class

ILifeCycle

Interface for controlling an object's start/stop life cycle.

Public class

IMemoryReadStream

Represents a block of memory, but abstracts away the underlying layout

Private struct

IOperatorEvaluationEnvironment

Structures used for managing the evaluation environment for operators in an expression.

Public class

IQueuedWork

Interface for queued work objects.

Public class

ITextFilterExpressionContext

Interface to implement to allow FTextFilterExpressionEvaluator to perform its comparison tests in TestTextFilter

Public class

ITransaction

Interface for transactions.

Public class

ITransactionObjectAnnotation

Interface for transaction object annotations.

Public struct

MaxStackAllocationSize

Public struct

SHA1_WORKSPACE_BLOCK

NOTE: 100% free public domain implementation of the SHA-1 algorithm by Dominik Reichl [dominik.reichl@t-online.de](mailto:dominik.reichl@t-online.de) Web: http://www.dominik-reichl.de/

Public class

TAttribute

Attribute object

Public struct

TCallableInfo

Machinery required for operator mapping

Public struct

TCallableInfoImpl

Public struct

TChar

TChar Set of utility functions operating on a single character.

Public struct

TCharBase

Public struct

TContainsReferenceType

Determine if any of the types in a template parameter pack are references

Public struct

TCopyConstructorCaller

An adapter for calling a copy constructor of a type

Public struct

TCopyConstructorLookup

A utility for calling a type's copy constructor based on an index into a template parameter pack

Public struct

TCString

Set of basic string utility functions operating on plain C strings.

Public struct

TCStringSpcHelper

Public class

TDelegateFilter

A generic filter designed to call a predicate provided on construction to filter

Public struct

TDestructorCaller

An adapter for calling DestructItem

Public struct

TDestructorLookup

Lookup a type in a template parameter pack by its index and call the destructor

Public struct

TEnumContiguousIterator

Public struct

TEnumRange

Range type for iterating over enum values.

Public struct

TEnumRange_Impl

Public struct

TEnumRangeTraits

Public struct

TEnumValueArrayIterator

Public class

TFilterCollection

A simple collection of Filters, with additional Filter specific functionality.

Public struct

TFrameValue

This struct allows you to cache a value for a frame, and automatically invalidates when the frame advances.

Public class

TGenericGrowableAllocator

Allocator that will grow as needed with direct mapped memory for a given memory type

Public struct

TGetExpressionNodeTypeId

Public struct

TGetOperatorCallPtr

Public class

TInlineValue

A container type that houses an instance of BaseType in inline memory where it is <= MaxInlineSize, or in a separate heap allocation where it's > MaxInlineSize.

Public struct

TInPlaceType

A special tag used to indicate that in-place construction of a variant should take place.

Public struct

TIsType

Determine if the type with the provided index in the template parameter pack is the same

Public struct

TLiteral

Templated literal struct to allow selection of wide or ansi string literals based on the character type provided, and not on compiler switches.

Public class

TMemStackAllocator

A container allocator that allocates from a mem-stack.

Public struct

TMoveConstructorCaller

A utility for calling a type's move constructor based on an index into a template parameter pack

Public struct

TMoveConstructorLookup

A utility for calling a type's move constructor based on an index into a template parameter pack

Private struct

TOperatorEvaluationEnvironment

Public struct

TOperatorJumpTable

Jump table specifying how to execute an operator with different types

Public struct

TOptional

When we have an optional value IsSet() returns true, and GetValue() is meaningful.

Public struct

TParameterPackTypeIndex

Entry-point for looking up the index of a type in a template parameter pack

Public struct

TParameterPackTypeIndexHelper

Helper to lookup indices of each type in a template parameter pack

Public struct

TRemoveConst

TRemoveConst<> is modeled after boost's implementation.

Public class

TScopeGuard

Not meant for direct consumption : use ON_SCOPE_EXIT instead.

Public struct

TStaticDeprecateExpression

Public struct

TStorageTypeDeduction

Public class

TTextFilter

A generic filter specialized for text restrictions

Public class

TTypeContainer

Template for type containers.

Public struct

TTypePackContainsDuplicates

Determine if all the types in a template parameter pack has duplicate types

Public class

TVariant

A type-safe union based loosely on std::variant.

Public struct

TVariantStorage

Determine the max alignof and sizeof of all types in a template parameter pack and provide a type that is compatible with those sizes

Public struct

TVariantTraits

Stub for variant type traits.

Constants

Typedefs

Name

Description

CompileResultType

FBinaryFunction

FChar

FCharAnsi

FCharWide

FConfigFileHierarchy

FConfigSectionMap

FCString

FCStringAnsi

FCStringWide

FDoneDelegate

FEmbeddedCommunicationMap

FExpressionResult

FKeyValueSink

Declares a delegate type that's used by the config system to allow iteration of key value pairs.

FOnInteractiveProcessCompleted

Declares a delegate that is executed when a interactive process completed.

FOnInteractiveProcessOutput

Declares a delegate that is executed when a interactive process produces output.

FOnMonitoredProcessCompleted

Declares a delegate that is executed when a monitored process completed.

FOnMonitoredProcessOutput

Declares a delegate that is executed when a monitored process produces output.

FOnPerformanceDataRetrieved

FOnTestDataRetrieved

FOnTestScreenshotCaptured

Delegate type for when a test screenshot has been captured

FOnTestScreenshotComparisonComplete

FOperatorEvaluationEnvironment

FOperatorEvaluationEnvironment

FOperatorJumpTable

FPlatformUserId

Handle type to stably track users on a specific platform.

FQueryIsRunningServer

Called to determine the result of IsServerForOnlineSubsystems()

FRSAKeyHandle

FScriptExceptionHandlerFunc

Function signature for handlers for script exceptions.

FShortCircuit

FThumbnailMap

Maps an object's full name to a thumbnail

FTokenFunctionHandler

FUnaryFunction

IMemoryReadStreamRef

LexResultType

STRUCT_AR

STRUCT_DC

Class for handling undo/redo transactions among objects.

STRUCT_DTOR

Enums

Name

Description

Private enum

EAssociativity

Enum specifying the associativity (order of execution) for binary operators

Public enum

EAutomationEventType

Public enum

EAutomationExpectedErrorFlags::MatchType

Flags for indicating the matching type to use for an expected error

Public enum

EAutomationTestFlags::Type

Flags for specifying automation test requirements/behavior

Public enum

EByteOrderMark

Public enum

ECompilationResult::Type

Enumerates possible results of a compilation operation.

Public enum

ECompressionFlags

Flags controlling [de]compression Make sure to update VerifyCompressionFlagsValid after changing these values.

Public enum

EConfigCacheType

Public enum

EDayOfWeek

Enumerates the days of the week in 7-day calendars.

Public enum

EEngineNetworkVersionHistory

Public enum

EForceInit

Public enum

EGuidFormats

Enumerates known GUID formats.

Public enum

EHotfixDelegates::Type

Delegates for hotfixes

Public enum

EInPlace

Public enum

ELogTimes::Type

Enum that defines how the log times are to be displayed.

Public enum

EMemOned

Public enum

EMemZeroed

Enums for specifying memory allocation type.

Public enum

EMonthOfYear

Enumerates the months of the year in 12-month calendars.

Public enum

ENoInit

Public enum

EParseState

Enum specifying how to treat the currently parsing character.

Public enum

ESlowTaskVisibility

Enum to specify a particular slow task section should be shown

Public enum

ETextFilterComparisonOperation

Defines the comparison operators that can be used for a complex (key->value) comparison

Public enum

ETextFilterExpressionEvaluatorMode

Defines whether or not the expression parser can evaluate complex expressions

Public enum

ETextFilterExpressionType

Defines the complexity of the current filter terms.

Public enum

ETextFilterTextComparisonMode

Defines the different ways that a string can be compared while evaluating the expression

Public enum

ETransactionObjectEventType

Different kinds of actions that can trigger a transaction object event

Public enum

ETransactionStateEventType

Different kinds of actions that can trigger a transaction state change

Public enum

ETypeContainerScope

Enumerates the scopes for instance creation in type containers.

Public enum

EVariantTypes

Enumerates the built-in types that can be stored in instances of FVariant.

Public enum

EVersionComparison

Components of a version string.

Public enum

EVersionComponent

Enum for the components of a version string.

Public enum

FRWScopeLockType

A scope lifetime controlled Read or Write lock of referenced mutex object

Functions

Name Description

Public function

void

 

ApplyCVarSettingsFromIni

(
    const TCHAR* InSectionBaseName,
    const TCHAR* InIniFilename,
    uint32 SetBy,
    bool bAllowCheating
)

Helper function to read the contents of an ini file and a specified group of cvar parameters, where sections in the ini file are marked [InName]

Public function

void

 

ApplyCVarSettingsGroupFromIni

(
    const TCHAR* InSectionBaseName,
    const TCHAR* InSectionTag,
    const TCHAR* InIniFilename,
    uint32 SetBy
)

Helper function to read the contents of an ini file and a specified group of cvar parameters, where sections in the ini file are marked [InName]

Public function

void

 

ApplyCVarSettingsGroupFromIni

(
    const TCHAR* InSectionBaseName,
    int32 InGroupNumber,
    const TCHAR* InIniFilename,
    uint32 SetBy
)

Helper function to read the contents of an ini file and a specified group of cvar parameters, where sections in the ini file are marked [InName]

Public function

void

 

appOnFailSHAVerification

(
    const TCHAR* FailedPathname,
    bool bFailedDueToMissingHash
)

Callback that is called if the asynchronous SHA verification fails This will be called from a pooled thread.

Public function Static

void

 

BYTESWAP_ORDER_TCHARARRAY

(
    TCHAR* str
)

Public function Static

uint16

 

BYTESWAP_ORDER16

(
    uint16 val
)

Public function Static

int16

 

BYTESWAP_ORDER16

(
    int16 val
)

Public function Static

uint32

 

BYTESWAP_ORDER32

(
    uint32 val
)

Public function Static

int32

 

BYTESWAP_ORDER32

(
    int32 val
)

Public function Static

uint64

 

BYTESWAP_ORDER64

(
    uint64 Value
)

Public function Static

int64

 

BYTESWAP_ORDER64

(
    int64 Value
)

Public function Static

float

 

BYTESWAP_ORDERF

(
    float val
)

Public function

void

 

ConsoleCommandLibrary_DumpLibrary

(
    UWorld* InWorld,
    FExec& SubSystem,
    const FString& Pattern,
    FOutputDevice& Ar
)

Needed for the console command "DumpConsoleCommands"

Public function

void

 

ConsoleCommandLibrary_DumpLibraryHTML

(
    UWorld* InWorld,
    FExec& SubSystem,
    const FString& OutPath
)

Needed for the console command "Help"

Public function

FFrameTime

 

ConvertFrameTime

(
    FFrameTime SourceTime,
    FFrameRate SourceRate,
    FFrameRate DestinationRate
)

Public function

void

 

DeleteRecordedConfigReadsFromIni()

Helper function to clean up config read history

Public function

void

 

DeleteRecordedCVarSettingsFromIni()

Helper function to clean up ini history

Public function

RetType

 

DispatchCheckVerify

(
    InnerType&& Inner
)

MSVC (v19.00.24215.1 at time of writing) ignores no-inline attributes on lambdas.

Public function

void

 

DumpRecordedConfigReadsFromIni()

Helper function to dump config reads to csv after RecordConfigReadsFromIni was called

Public function

const TCHAR ...

 

EAutomationExpectedErrorFlags::ToString

Public function Static

bool

 

ECompilationResult::Failed

(
    ECompilationResult::Type Result
)

Returns false if the provided Result is either UpToDate or Succeeded.

Public function Static

const TCHAR ...

 

ECompilationResult::ToString

(
    ECompilationResult::Type Result
)

Converts ECompilationResult enum to string.

Public function

bool

 

EnumHasAllFlags

(
    Enum Flags,
    Enum Contains
)

Public function

bool

 

EnumHasAnyFlags

(
    Enum Flags,
    Enum Contains
)

Public function Const

FExpressionR...

 

ExecBinary

(
    const FExpressionToken& Operator,
    const FExpressionToken& L,
    const FExpressionToken& R,
    const ContextType* Context
)

Execute the specified token as a binary operator, if such an overload exists

Public function Const

FExpressionR...

 

ExecPostUnary

(
    const FExpressionToken& Operator,
    const FExpressionToken& L,
    const ContextType* Context
)

Execute the specified token as a unary operator, if such an overload exists

Public function Const

FExpressionR...

 

ExecPreUnary

(
    const FExpressionToken& Operator,
    const FExpressionToken& R,
    const ContextType* Context
)

Execute the specified token as a unary operator, if such an overload exists

Public function

FExpressionR...

 

ExpressionParser::Evaluate

(
    const TArray< FCompiledToken >& Co...,
    const TOperatorJumpTable< ContextTy...,
    const ContextType* InContext
)

Public function

FExpressionR...

 

ExpressionParser::Evaluate

(
    const TCHAR* InExpression,
    const FTokenDefinitions& InTokenDe...,
    const FExpressionGrammar& InGramma...,
    const TOperatorJumpTable< ContextTy...,
    const ContextType* InContext
)

Templated versions of evaluation functions used when passing a specific jump table and context

Public function

FDerivedData...

 

GetDerivedDataCache()

Return the DDC interface, if it is available, otherwise return NULL

Public function

FDerivedData...

 

GetDerivedDataCacheRef()

Return the DDC interface, fatal error if it is not available.

Public function

FDateTime

 

GetIniTimeStamp

(
    const TCHAR* FilenameToLoad,
    const TCHAR* IniFileName
)

Returns the timestamp of the appropriate config file.

Public function

ITargetPlatf...

 

GetTargetPlatformManager()

Return the Target Platform Manager interface, if it is available, otherwise return NULL

Public function

ITargetPlatf...

 

GetTargetPlatformManagerRef()

Return the Target Platform Manager interface, fatal error if it is not available.

Public function

uint32

 

GetTypeHash

(
    FFrameNumber A
)

Public function Static

FExpressionR...

 

Impl::ForwardReturnType

(
    FExpressionResult&& Result
)

Public function Static

FExpressionR...

 

Impl::ForwardReturnType

(
    T&& Result
)

Overloaded function that returns an FExpressionResult, regardless of what is passed in

Public function Static

TEnableIf< I...

 

Impl::WrapBinaryFunction

(
    FuncType In
)

Wrapper function for supplied functions of the signature T(A, B)

Public function Static

TEnableIf< I...

 

Impl::WrapBinaryFunction

(
    FuncType In
)

Wrapper function for supplied functions of the signature T(A, B, const ContextType* Context)

Public function Static

TEnableIf< I...

 

Impl::WrapShortCircuitFunction

(
    FuncType In
)

Wrapper function for supplied functions of the signature bool(A, const ContextType* Context)

Public function Static

TEnableIf< I...

 

Impl::WrapShortCircuitFunction

(
    FuncType In
)

Wrapper function for supplied functions of the signature bool(A, const ContextType* Context)

Public function Static

TEnableIf< I...

 

Impl::WrapUnaryFunction

(
    FuncType In
)

Wrapper function for supplied functions of the signature T(A)

Public function Static

TEnableIf< I...

 

Impl::WrapUnaryFunction

(
    FuncType In
)

Wrapper function for supplied functions of the signature T(A, const ContextType* Context)

Public function

bool

 

IsRunningClientOnly()

Check to see if this executable is running as "the client"

Public function

bool

 

IsRunningDedicatedServer()

Check to see if this executable is running as dedicated server Editor can run as dedicated with -server

Public function

bool

 

IsRunningGame()

Check to see if this executable is running as "the game"

Public function

bool

 

IsServerForOnlineSubsystems

(
    FName WorldContextHandle
)

Public function

bool

 

IsUsingLocalIniFile

(
    const TCHAR* FilenameToLoad,
    const TCHAR* IniFileName
)

Returns true if no remote version of this config file exists and/or isn't being used.

Public function

void

 

LowLevelFatalErrorHandler

(
    const ANSICHAR* File,
    int32 Line,
    const TCHAR* Format,
    ...
)

Low level fatal error handler.

Public function

decltype(aut...

 

MakeAttributeLambda

(
    LambdaType&& InCallable,
    PayloadTypes&&... InputPayload
)

Helper function for creating TAttributes from a lambda TAttribute FloatAttribute = MakeAttributeLambda([]{ return 10.f; });Helper function for creating TAttributes from a lambda TAttribute FloatAttribute = MakeAttributeLambda([]{ return 10.f; });

Public function

TAttribute< ...

 

MakeAttributeRaw

(
    const SourceType* InObject,
    T(SourceTypeOrBase::*)(PayloadT...,
    typename TDecay< PayloadTypes >::Ty...
)

Helper function for creating TAttributes from a const member function pointer, accessed through a raw pointer

Public function

TAttribute< ...

 

MakeAttributeRaw

(
    SourceType* InObject,
    T(SourceTypeOrBase::*)(PayloadT...,
    typename TDecay< PayloadTypes >::Ty...
)

Helper function for creating TAttributes from a non-const member function pointer, accessed through a raw pointer

Public function

TAttribute< ...

 

MakeAttributeSP

(
    const SourceType* InObject,
    T(SourceTypeOrBase::*)(PayloadT...,
    typename TDecay< PayloadTypes >::Ty...
)

Helper function for creating TAttributes from a const member function pointer, accessed through a weak pointer to the shared object

Public function

TAttribute< ...

 

MakeAttributeSP

(
    SourceType* InObject,
    T(SourceTypeOrBase::*)(PayloadT...,
    typename TDecay< PayloadTypes >::Ty...
)

Helper function for creating TAttributes from a non-const member function pointer, accessed through a weak pointer to the shared object

Public function

*return

 

MakeError

(
    FExpressionError(LOCTEXT("DivisionB...
)

Map an expression node to a binary operator with the specified implementation.

Public function

TInlineValue...

 

MakeInlineValue

(
    ArgsType... Args
)

Construct a new TInlineValue from the specified user type, and arguments

Public function

void

 

MakeLocalCopy

(
    const TCHAR* Filename
)

Before overwriting the local file with the contents from the remote file, we save off a copy of the local file (if it exists).

Public function

TOperatorJum...

 

MakeValue

(
    ! A
)

Public function

**vo...

 

MapBinary

(
    FuncType InFunc
)

Public function

void

 

MapPostUnary

(
    FuncType InFunc
)

Map an expression node to a post-unary operator with the specified implementation.

Public function

void

 

MapPreUnary

(
    FuncType InFunc
)

Map an expression node to a pre-unary operator with the specified implementation.

Public function

void

 

MapShortCircuit

(
    FuncType InFunc
)

Public function

T *

 

New

(
    FMemStackBase& Mem,
    int32 Count,
    int32 Align
)

Operator new for typesafe memory stack allocation.

Public function

T *

 

NewOned

(
    FMemStackBase& Mem,
    int32 Count,
    int32 Align
)

Public function

T *

 

NewZeroed

(
    FMemStackBase& Mem,
    int32 Count,
    int32 Align
)

Public function

FFrameTime

 

operator-

(
    FFrameTime A,
    FFrameTime B
)

Public function

FFrameTime

 

operator-

(
    FFrameTime A
)

Public function

void *

 

operator new

(
    size_t Size,
    FMemStackBase& Mem,
    EMemZeroed Tag,
    int32 Count,
    int32 Align
)

Public function

void *

 

operator new

(
    size_t Size,
    FMemStackBase& Mem,
    EMemOned Tag,
    int32 Count,
    int32 Align
)

Public function

void *

 

operator new

(
    size_t Size,
    FMemStackBase& Mem,
    int32 Count,
    int32 Align
)

Operator new for typesafe memory stack allocation.

Public function

void *

 

operator new[]

(
    size_t Size,
    FMemStackBase& Mem,
    int32 Count,
    int32 Align
)

Public function

void *

 

operator new[]

(
    size_t Size,
    FMemStackBase& Mem,
    EMemZeroed Tag,
    int32 Count,
    int32 Align
)

Public function

void *

 

operator new[]

(
    size_t Size,
    FMemStackBase& Mem,
    EMemOned Tag,
    int32 Count,
    int32 Align
)

Public function

constexpr bo...

 

operator!

Public function

bool

 

operator!=

(
    FFrameTime A,
    FFrameTime B
)

Public function

bool

 

operator!=

(
    const FFrameRate& A,
    const FFrameRate& B
)

Public function

bool

 

operator!=

(
    const FTimecode& A,
    const FTimecode& B
)

Public function

constexpr FF...

 

operator&

Public function

FFileHelper:...

 

operator&=

Public function

FFrameRate

 

operator*

(
    FFrameRate A,
    FFrameRate B
)

Public function

FFrameTime

 

operator*

(
    FFrameTime A,
    float Scalar
)

Public function

FFrameTime

 

operator*

(
    float TimeInSeconds,
    FFrameRate Rate
)

Public function

FFrameTime

 

operator*

(
    double TimeInSeconds,
    FFrameRate Rate
)

Public function

FTimespan

 

operator*

(
    float Scalar,
    const FTimespan& Timespan
)

Pre-multiply a time span with the given scalar.

Public function

FFrameRate

 

operator/

(
    FFrameRate A,
    FFrameRate B
)

Public function

double

 

operator/

(
    FFrameNumber Frame,
    FFrameRate Rate
)

Public function

TRange< doub...

 

operator/

(
    const TRange< FFrameNumber >& Fram...,
    FFrameRate Rate
)

Public function

FFrameTime

 

operator/

(
    FFrameTime A,
    float Scalar
)

Public function

double

 

operator/

(
    FFrameTime FrameTime,
    FFrameRate Rate
)

Public function

constexpr FF...

 

operator^

Public function

FFileHelper:...

 

operator^=

Public function

constexpr FF...

 

operator|

Public function

FFileHelper:...

 

operator|=

Public function

constexpr FF...

 

operator~

Public function

FFrameTime

 

operator+

(
    FFrameTime A,
    FFrameTime B
)

Public function

FFrameTime &

 

operator+=

(
    FFrameTime& LHS,
    FFrameTime RHS
)

Public function

bool

 

operator==

(
    const FTimecode& A,
    const FTimecode& B
)

Public function

bool

 

operator==

(
    FFrameTime A,
    FFrameTime B
)

Public function

bool

 

operator==

(
    const FFrameRate& A,
    const FFrameRate& B
)

Public function

bool

 

operator>

(
    FFrameTime A,
    FFrameTime B
)

Public function

bool

 

operator>=

(
    FFrameTime A,
    FFrameTime B
)

Public function

TValueOrErro...

 

ParseFrameRate

(
    const TCHAR* FrameRateString
)

Attempt to parse a frame rate from a string

Public function

void

 

PrintScriptCallstack()

C Exposed function to print the callstack to ease debugging needs.

Public function

void

 

ProcessIniContents

(
    const TCHAR* FilenameToLoad,
    const TCHAR* IniFileName,
    FConfigFile* Config,
    bool bDoEmptyConfig,
    bool bDoCombine
)

Contains the logic for processing config files, local or remote.

Public function

void

 

ReapplyRecordedCVarSettingsFromIni()

Helper function to reapply inis which have been applied after RecordCVarIniHistory was called

Public function

void

 

RecordApplyCVarSettingsFromIni()

CVAR Ini history records all calls to ApplyCVarSettingsFromIni and can re run them Helper function to start recording ApplyCVarSettings function calls uses these to generate a history of applied ini settings sections

Public function

void

 

RecordConfigReadsFromIni()

Helper function to start recording config reads

Public function

void

 

SetIsServerForOnlineSubsystemsDelegate

(
    FQueryIsRunningServer NewDelegate
)

Sets the delegate used for IsServerForOnlineSubsystems

Public function Const

bool

 

ShouldShortCircuit

(
    const FExpressionToken& Operator,
    const FExpressionToken& L,
    const ContextType* Context
)

Check whether we should short circuit the specified operator

Public function

bool

 

StringHasBadDashes

(
    const TCHAR* Str
)

Public function

FString

 

StringUtility::UnescapeURI

(
    const FString& URLString
)

Unescapes a URI

Public function

void

 

TextFilterUtils::IntToStringBuffer

(
    CharType* Dest,
    int32 Source,
    int32 MaxLen
)

Public function

int32

 

TextFilterUtils::NameStrincmp

(
    const FName& Name,
    const FString& WideOther,
    const TArray< ANSICHAR >& AnsiOthe...,
    int32 Length
)

Compare FNameEntry vs Wide or Ansi string

Public function

bool

 

TextFilterUtils::TestBasicStringExpression

(
    const FTextFilterString& InValue1,
    const FTextFilterString& InValue2,
    const ETextFilterTextComparisonMode...
)

Utility function to perform a basic string test for the given values

Public function

bool

 

TextFilterUtils::TestComplexExpression

(
    const FTextFilterString& InValue1,
    const FTextFilterString& InValue2,
    const ETextFilterComparisonOperatio...,
    const ETextFilterTextComparisonMode...
)

Utility function to perform a complex expression test for the given values

Public function

bool

 

TextFilterUtils::TryConvertWideToAnsi

(
    const FString& SourceWideString,
    TArray< ANSICHAR >& DestAnsiString
)

Convert a wide string to ansi if all characters are ansi

Public function

bool

 

TryParseString

(
    FFrameRate& OutFrameRate,
    const TCHAR* InString
)

Common Lex::TryParseString overload for FFrameRate

Public function

bool

 

UE4Asserts_Private::GetMemberNameCheckedJunk

(
    const volatile T&
)

A junk function to allow us to use sizeof on a member variable which is potentially a bitfield.

Public function

bool

 

UE4Asserts_Private::GetMemberNameCheckedJunk

(
    const T&
)

A junk function to allow us to use sizeof on a member variable which is potentially a bitfield.

Public function

bool

 

UE4Asserts_Private::GetMemberNameCheckedJunk

(
    R(*)(Args...)
)

A junk function to allow us to use sizeof on a member variable which is potentially a bitfield.

Variables

Name Description

Private variable

TMap< FOperator...

 

BinaryOps

Private variable

TMap< FOperator...

 

BinaryShortCircuits

Public variable

FQueuedThreadPo...

 

GBackgroundPriorityThreadPool

Public variable

FQueuedThreadPo...

 

GIOThreadPool

Public variable

FQueuedThreadPo...

 

GLargeThreadPool

Public variable

FQueuedThreadPo...

 

GThreadPool

Global thread pool for shared async operations

The global thread pool

Private variable

IOperatorEvalua...

 

MakeValue

Public variable

constexpr int64

 

MaxTicks

The maximum number of ticks that can be represented in FTimespan.

Public variable

constexpr int64

 

MinTicks

The minimum number of ticks that can be represented in FTimespan.

Public variable

constexpr int64

 

NanosecondsPerTick

The number of nanoseconds per tick.

Public variable

const FPlatform...

 

PLATFORMUSERID_NONE

Private variable

TMap< FOperator...

 

PostUnaryOps

Private variable

TMap< FOperator...

 

PreUnaryOps

Maps of unary/binary operators

Public variable

constexpr int64

 

TicksPerDay

The number of timespan ticks per day.

Public variable

constexpr int64

 

TicksPerHour

The number of timespan ticks per hour.

Public variable

constexpr int64

 

TicksPerMicrosecond

The number of timespan ticks per microsecond.

Public variable

constexpr int64

 

TicksPerMillisecond

The number of timespan ticks per millisecond.

Public variable

constexpr int64

 

TicksPerMinute

The number of timespan ticks per minute.

Public variable

constexpr int64

 

TicksPerSecond

The number of timespan ticks per second.

Public variable

constexpr int64

 

TicksPerWeek

The number of timespan ticks per week.

Public variable

constexpr int64

 

TicksPerYear

The number of timespan ticks per year (365 days, not accounting for leap years).

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback