description: Returns a list of editor-specific localization paths

code: static const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & GetEditorLocalizationPaths()


description:
Gets the extension for this filename.
the extension of this filename, or an empty string if the filename doesn't have an extension.

module: Core

code: static [FString](API\Runtime\Core\Containers\FString) GetExtension ( const [FString](API\Runtime\Core\Containers\FString) & InPath, bool bIncludeDot )


description: Returns a list of engine-specific localization paths

code: static const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & GetEngineLocalizationPaths()


description:
Returns platform and restricted extensions that are present and valid (for platforms, it uses FDataDrivePlatformInfo to determine valid platforms, it doesn't just use what's present)
BaseDir and usable extension directories under BaseDir (either Engine or Project)

code: static [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > GetExtensionDirs ( const [FString](API\Runtime\Core\Containers\FString) & BaseDir, const [FString](API\Runtime\Core\Containers\FString) & SubDir )


description: Returns a list of game-specific localization paths

code: static const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & GetGameLocalizationPaths()


description: Returns a string containing all invalid characters as dictated by the operating system


description: Returns the path in front of the filename.

code: static [FString](API\Runtime\Core\Containers\FString) GetPath ( [FString](API\Runtime\Core\Containers\FString) && InPath )


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


description: Returns the leaf in the path.

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


description: Returns the leaf in the path.

code: static [FString](API\Runtime\Core\Containers\FString) GetPathLeaf ( [FString](API\Runtime\Core\Containers\FString) && InPath )


description: Get the name of the platform-specific localization sub-folder


description:
Gets the path to the project file.
Project file path.


description: Gets the relative path to get from BaseDir to RootDirectory

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


description: Returns a list of property name localization paths

code: static const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & GetPropertyNameLocalizationPaths()


description: Returns a list of restricted/internal folder names (without any slashes) which may be tested against full paths to determine if a path is restricted or not.

code: static const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & GetRestrictedFolderNames()


description: Returns a list of tool tip localization paths

code: static const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & GetToolTipLocalizationPaths()


description: Returns true if a writable directory for downloaded data that persists across play sessions is available


description: Returns true if this path represents a root drive or volume

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


description:
Checks whether the path to the project file, if any, is set.
true if the path is set, false otherwise.

code: static bool IsProjectFilePathSet()


description: Returns true if this path is relative to another path

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


description:
Checks if two paths are the same.
True if both paths are the same. False otherwise.

code: static bool IsSamePath ( const [FString](API\Runtime\Core\Containers\FString) & PathA, const [FString](API\Runtime\Core\Containers\FString) & PathB )


description: Determines if supplied path uses a restricted/internal subdirectory. Note that slashes are normalized and character case is ignored for the comparison.

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


description: Determines if a path is under a given directory

code: static bool IsUnderDirectory ( const [FString](API\Runtime\Core\Containers\FString) & InPath, const [FString](API\Runtime\Core\Containers\FString) & InDirectory )


description: Returns the directory the application was launched from (useful for commandline utilities)


description:
Assuming both paths (or filenames) are relative to the same base dir, modifies InPath to be relative to InRelativeTo
true if InPath was changed to be relative

code: static bool MakePathRelativeTo ( [FString](API\Runtime\Core\Containers\FString) & InPath, const TCHAR * InRelativeTo )


description: Takes an "Unreal" pathname and converts it to a platform filename.

code: static void MakePlatformFilename ( [FString](API\Runtime\Core\Containers\FString) & InPath )


code: static void MakeStandardFilename ( [FString](API\Runtime\Core\Containers\FString) & InPath )


description: Normalize all / and \ to TEXT("/") and remove any trailing TEXT("/") if the character before that is not a TEXT("/") or a colon

code: static void NormalizeDirectoryName ( [FString](API\Runtime\Core\Containers\FString) & InPath )


description: Returns a string that is safe to use as a filename because all items inGetInvalidFileSystemChars()are removed

code: static [FString](API\Runtime\Core\Containers\FString) MakeValidFileName ( const [FString](API\Runtime\Core\Containers\FString) & InString, const TCHAR InReplacementChar )


description: Convert all / and \ to TEXT("/")

code: static void NormalizeFilename ( [FString](API\Runtime\Core\Containers\FString) & InPath )


description:
Returns the directory the root configuration files are located.
root config directory


description:
Returns the directory the engine uses to output profiling files.
log directory


description:
Returns the content directory of the current game by looking atFApp::GetProjectName().
content directory


description:
Returns the base directory of the current project by looking atFApp::GetProjectName(). This is usually a subdirectory of the installation root directory and can be overridden on the command line to allow self contained mod support.
base directory


description:
Returns the intermediate directory of the current game by looking atFApp::GetProjectName().
intermediate directory


description:
Returns the directory the engine uses to output logs. This currently can't be an .ini setting as the game starts logging before it can read from .ini files.
log directory


description:
Returns the mods directory of the current project by looking atFApp::GetProjectName().
mods directory


description: Returns the writable directory for downloaded data that persists across play sessions.


description:
Returns the directory where the project's platform extensions reside
project platform extensions directory


description:
Returns the plugins directory of the current game by looking atFApp::GetProjectName().
plugins directory


description: Removes duplicate slashes in paths. Assumes all slashes have been converted to TEXT('/'). For example, takes the string: BaseDirectory/SomeDirectory//SomeOtherDirectory////Filename.ext and converts it to: BaseDirectory/SomeDirectory/SomeOtherDirectory/Filename.ext

code: static void RemoveDuplicateSlashes ( [FString](API\Runtime\Core\Containers\FString) & InPath )


description:
Returns the root directory for user-specific game files.
game user directory


description:
Returns the saved directory of the current game by looking atFApp::GetProjectName().
saved directory

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


description: Returns a copy of the given path on which duplicate slashes were removed (see the inplace version for more details).

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


description:
Returns the root directory of the engine directory tree
Root directory.


description:
Returns the directory the engine stores sandbox output
sandbox directory


description:
Returns the directory the engine uses to output screenshot files.
screenshot directory


description: Sets the extension of the given filename (like ChangeExtension, but also applies the extension if the file doesn't have one)

code: static [FString](API\Runtime\Core\Containers\FString) SetExtension ( const [FString](API\Runtime\Core\Containers\FString) & InPath, const [FString](API\Runtime\Core\Containers\FString) & InNewExtension )


description: Sets the path to the project file.

code: static void SetProjectFilePath ( const [FString](API\Runtime\Core\Containers\FString) & NewGameProjectFilePath )


description: Should the "saved" directory structures be rooted in the user dir or relative to the "engine/game"

code: static bool ShouldSaveToUserDir()


description:
Returns the directory the engine uses to look for the source leaf ini files. This can't be an .ini variable for obvious reasons.
source config directory


description: Parses a fully qualified or relative filename into its components (filename, path, extension).

code: static void Split ( const [FString](API\Runtime\Core\Containers\FString) & InPath, [FString](API\Runtime\Core\Containers\FString) & PathPart, [FString](API\Runtime\Core\Containers\FString) & FilenamePart, [FString](API\Runtime\Core\Containers\FString) & ExtensionPart )


description: Frees any memory retained byFPaths.

code: static void TearDown()


description: Validates that the parts that make up the path contain no invalid characters as dictated by the operating system Note that this is a different set of restrictions to those imposed byFPackageName

code: static bool ValidatePath ( const [FString](API\Runtime\Core\Containers\FString) & InPath, [FText](API\Runtime\Core\Internationalization\FText) * OutReason )


description:
Returns the directory the engine uses to output user requested video capture files.
Video capture directory


className: FPaths

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

code: class FPaths


description: If AppendPath is a relative path, append it as a relative path onto InOutPath. If AppendPath is absolute, reset InOutPath and replace it with RelPath. Handles presence or absence of terminating separator in BasePath. Does not interpret . or ..; each occurrence of these in either path will remain in the combined InOutPath.

code: static void AppendPath ( FStringBuilderBase & InOutPath, FStringView AppendPath )


description: Collapses redundant paths like "/./" and "SkipDir/..".FPaths::CollapseRelativeDirectories()equivalent.

code: static bool CollapseRelativeDirectories ( FStringBuilderBase & InOutPath )


description:
Examples: (Using '/' but '' is valid too.) "A/B/C.D" -> "C" "A/B/C" -> "C" "A/B/" -> "" "A" -> "A"
The portion of the path after the last separator and before the last dot.

code: static FStringView GetBaseFilename ( const FStringView & InPath )


description:
Examples: (Using '/' but '' is valid too.) "A/B/C.D" -> "A/B/C" "A/B/C" -> "A/B/C" "A/B/" -> "A/B/" "A" -> "A"
The portion of the path before the last dot.

code: static FStringView GetBaseFilenameWithPath ( const FStringView & InPath )


description:
Examples: (Using '/' but '' is valid too.) "A/B/C.D" -> "C.D" "A/B/C" -> "C" "A/B/" -> "" "A" -> "A"
The portion of the path after the last separator.

code: static FStringView GetCleanFilename ( const FStringView & InPath )


description: Returns the name of the mount point in a path Removes starting forward slash and Classes_ prefix if bInWithoutSlashes is true Example: "/Classes_A/Textures" returns "A" and sets bOutHadClassesPrefix=true if bInWithoutSlashes is true returns "/Classes_A" otherwise and sets bOutHadClassesPrefix=false

code: static FStringView GetMountPointNameFromPath ( const FStringView InPath, bool * bOutHadClassesPrefix, bool bInWithoutSlashes )


description:
Return whether Parent is a parent path of (or is equal to) Child. Case-insensitive / is treated as equal to \ Presence or absence of terminating separator (/) is ignored in the comparison. Directory elements of . and .. are currently not interpreted and are treated as literal characters. Callers should not rely on this behavior as it may be corrected in the future. callers should instead conform the paths before calling. Relative paths and absolute paths are not resolved, and relative paths will never equal absolute paths. Callers should not rely on this behavior as it may be corrected in the future; callers should instead conform the paths before calling. Examples: ("../A", "../A/B") -> true ("../A/", "../A\B") -> true ("../A", "../A/") -> true ("../A", ".././A/") -> false ("d:/root/Engine", "../../../Engine") -> false
True if and only if Child is a child path of Parent (or is equal to it).

code: static bool IsParentPathOf ( FStringView Parent, FStringView Child )


description: Return whether the given path is a relativepath - does not start with a separator or volume:. Returns true for empty paths.

code: static bool IsRelativePath ( FStringView InPath )


description:
Returns the portion of the path before the last dot and optionally after the last separator. Return true if the the first path is lexicographically less than the second path (with caveats noted below). Case-insensitive / is treated as equal to \ Presence or absence of terminating separator (/) is ignored in the comparison. Directory elements of . and .. are currently not interpreted and are treated as literal characters. Callers should not rely on this behavior as it may be corrected in the future. callers should instead conform the paths before calling. Relative paths and absolute paths are not resolved, and relative paths will never equal absolute paths. Callers should not rely on this behavior as it may be corrected in the future; callers should instead conform the paths before calling. Examples: ("../A/B.C", "../A/B.C") -> false (they are equal) ("../A/B", "../A/B.C") -> true (a string is greater than any prefix of itself) ("../A/", "../A/") -> false (they are equal) ("../A/", "../A") -> false (they are equal) ("../A", "../A/") -> false (they are equal) ("d:/root/Engine/", "d:\root\Engine") -> false (they are equal) (../../../Engine/Content", "d:/root/Engine/Content") -> true ('.' is less than 'd')
(d:/root/Engine/..", "d:/root") -> false (A string is greater than any prefix of itself) (d:/root/Engine/./Content", "d:/root/Engine/Content") -> false

code: static [FPathViews::GetBaseFilename](API\Runtime\Core\Misc\FPathViews\GetBaseFilename)(InPath) and [FPathViews](API\Runtime\Core\Misc\FPathViews)bool Less ( FStringView A, FStringView B )


description: Normalize and remove trailing slash unless the preceding character is '/' or ':'

code: static void NormalizeDirectoryName ( FStringBuilderBase & InOutPath )


description: Convert \ to / and do platform-specific normalization

code: static void NormalizeFilename ( FStringBuilderBase & InOutPath )


description: Removes duplicate forward slashes, e.g. "a/b//c////f.e" -> "a/b/c/f.e"

code: static void RemoveDuplicateSlashes ( FStringBuilderBase & InOutPath )


description: Split the given absolute or relative path into its topmost directory and the relative path from that directory. Directory elements of . and .. are currently not interpreted and are treated as literal characters. Callers should not rely on this behavior as it may be corrected in the future. callers should instead conform the paths before calling.

code: static void SplitFirstComponent ( FStringView InPath, FStringView & OutFirstComponent, FStringView & OutRemainder )


description: Convert to absolute using process BaseDir(), normalize and append.FPaths::ConvertRelativePathToFull()equivalent.

code: static void ToAbsolutePath ( FStringView InPath, FStringBuilderBase & OutPath )


description: Convert to absolute using explicit BasePath, normalize and append.FPaths::ConvertRelativePathToFull()equivalent.

code: static void ToAbsolutePath ( FStringView BasePath, FStringView InPath, FStringBuilderBase & OutPath )


description: Convert to absolute using process BaseDir() and normalize inlined.FPaths::ConvertRelativePathToFull()equivalent.

code: static void ToAbsolutePathInline ( FStringBuilderBase & InOutPath )


description: Convert to absolute using explicit BasePath and normalize inlined.FPaths::ConvertRelativePathToFull()equivalent.

code: static void ToAbsolutePathInline ( FStringView BasePath, FStringBuilderBase & InOutPath )


description:
Check whether Parent is a parent path of Child and report the relative path if so. Case-insensitive / is treated as equal to \ Presence or absence of terminating separator (/) is ignored in the comparison. Directory elements of . and .. are currently not interpreted and are treated as literal characters. Callers should not rely on this behavior as it may be corrected in the future. callers should instead conform the paths before calling. Relative paths and absolute paths are not resolved, and relative paths will never equal absolute paths. Callers should not rely on this behavior as it may be corrected in the future; callers should instead conform the paths before calling. Examples: ("../A/B", "../A") -> (true, "B") ("../A\B", "../A/") -> (true, "B") ("../A/", "../A") -> (true, "") (".././A/", "../A") -> (false, "") ("../../../Engine", "d:/root/Engine") -> (false, "")
True if and only if Child is a child path of Parent (or is equal to it).

code: static bool TryMakeChildPathRelativeTo ( FStringView Child, FStringView Parent, FStringView & OutRelPath )


code: FPlatformIconPaths ( const [FString](API\Runtime\Core\Containers\FString) & InNormalPath, const [FString](API\Runtime\Core\Containers\FString) & InLargePath )


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


code: FPlatformIconPaths ( const [FString](API\Runtime\Core\Containers\FString) & InNormalPath, const [FString](API\Runtime\Core\Containers\FString) & InLargePath, const [FString](API\Runtime\Core\Containers\FString) & InXLargePath )


className: FPlatformIconPaths

description: Information about where to find the platform icons (for use byFAppStyle)

code: struct FPlatformIconPaths

LargePath

type: FString

LargeStyleName

type: FName


className: FPlatformInputDeviceState

description: Data about an input device's current state

code: struct FPlatformInputDeviceState

ConnectionState

type: EInputDeviceCon...

description: The connection state of this input device

OwningPlatformUser

type: FPlatformUserId

description: The platform user that this input device belongs to


description: Explicit function to create from an internal id

code: static [FPlatformUserId](API\Runtime\Core\Misc\FPlatformUserId) CreateFromInternalId ( int32 InInternalId )


description: Returns the internal id for debugging/etc

code: int32 GetInternalId() const


description: Sees if this is a valid user

code: bool IsValid() const


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


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


description: This should be deprecated when the online code uniformly handlesFPlatformUserId

code: * UE_DEPRECATED ( 5. x, "Implicit conversion to user index is deprecated, use FPlatformMisc::GetUserIndexForPlatformUser" ) const


className: FPlatformUserId

description: Handle that defines a local user on this platform. This used to be just a typedef int32 that was used interchangeably as ControllerId and LocalUserIndex. Moving forward these will be allocated by the platform application layer.

code: struct FPlatformUserId


description: When in PreloadBytes mode, allocate if necessary the memory for the preloaded bytes. Return whether the memory is now allocated.

code: bool AllocateCache()


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

code: virtual bool Close()


className: DefaultPageSize

code: enum { DefaultPageSize = 64*1024 }


className: DefaultPrimeSize

code: enum { DefaultPrimeSize = 1024 }


description: Return the LowerLevelFArchiveif it has been allocated. May return null, even if theFPreloadableFileis currently active. If return value is non-null, caller is responsible for deleting it.


className: FCreateArchive

code: typedef [TUniqueFunction](API\Runtime\Core\Templates\TUniqueFunction)< [FArchive](API\Runtime\Core\Serialization\FArchive) *()> FCreateArchive


className: Flags

code: enum Flags { None = 0x0, ModeBits = 0x1, PreloadHandle = 0x0, PreloadBytes = 0x1, Prime = 0x2, }


code: void Get &40; bool & bOutCanceled, IAsyncReadRequest &42;& OutReadRequest &41;


className: FSavedReadCompleteArguments

description: Saved values from the inline OnReadComplete call

code: struct FSavedReadCompleteArguments


description: This is overridden for the specific Archive Types

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


code: void Set &40; bool bInCanceled, IAsyncReadRequest &42; InReadRequest &41;


description: Initialize theFPreloadableFileasynchronously, performing FileOpen operations on another thread. Use IsInitialized or WaitForInitialization to check progress.

code: void InitializeAsync ( [FCreateArchive](API\Runtime\Core\Misc\FPreloadableArchive\FCreateArchive) && InCreateArchiveFunction, uint32 InFlags, int64 PrimeSize )


code: void InitializeAsync ( [FCreateAsyncArchive](API\Runtime\Core\Misc\FPreloadableArchive\FCreateAsyncArchive) && InCreateAsyncArchiveFunction, uint32 InFlags, int64 PrimeSize )


description: Helper function for InitializeAsync, called from a TaskGraph thread.

code: void InitializeInternal ( [FCreateArchive](API\Runtime\Core\Misc\FPreloadableArchive\FCreateArchive) && InCreateArchiveFunction, [FCreateAsyncArchive](API\Runtime\Core\Misc\FPreloadableArchive\FCreateAsyncArchive) && InCreateAsyncArchiveFunction, uint32 Flags, int64 PrimeSize )


description: Helper function for InitializeAsync, sets up the asynchronous call to InitializeInternal

code: void InitializeInternalAsync ( [FCreateArchive](API\Runtime\Core\Misc\FPreloadableArchive\FCreateArchive) && InCreateArchiveFunction, [FCreateAsyncArchive](API\Runtime\Core\Misc\FPreloadableArchive\FCreateAsyncArchive) && InCreateAsyncArchiveFunction, uint32 InFlags, int64 PrimeSize )


description: Return whether InitializeAsync has completed. If Close is called, state returns to false until the next call to InitializeAsync.

code: bool IsInitialized() const


description: Return whether the cache is currently allocated.

code: bool IsCacheAllocated() const


description: Return whether preloading is in progress. Value may not be up to date since asynchronous work might complete in a race condition.

code: bool IsPreloading() const


code: void OnReadComplete ( bool bCanceled, [IAsyncReadRequest](API\Runtime\Core\Async\IAsyncReadRequest) * ReadRequest )


description: Free all memory used by the cache or for preloading (calling StopPreload if necessary).

code: void ReleaseCache()


description: Attempts to set the current offset into backing data storage, this will do nothing if there is no storage.

code: virtual void Seek ( int64 InPos )


description: FArchive.

code: virtual void Serialize ( void * V, int64 Length )


code: void SerializeSynchronously ( void * V, int64 Length )


description: Set the PageSize used read requests made to the LowerLevel Archive in PreloadBytes mode when reading bytes into the In-Memory cache. Invalid to set after Initialization; PageSize must be constant during use.

code: void SetPageSize ( int64 PageSize )


description: When in PreloadBytes mode, if not already preloading, allocate if necessary the memory for the preloaded bytes and start the chain of asynchronous ReadRequests for the bytes. Returns whether preloading is now active.

code: bool StartPreload()


description: Cancel any current asynchronous ReadRequests and wait for the asynchronous work to exit.

code: void StopPreload()


description: Returns the current location within the backing data storage, which can possibly be passed to Seek later to restore a read/write location. If this returns -1, there is no backing data storage and Seek will not function.

code: virtual int64 Tell()


description: Return the size of the file, or -1 if the file does not exist. This is also the amount of memory that will be allocated by AllocateCache.

code: virtual int64 TotalSize()


description: Wait for InitializeAsync to complete if it is running, otherwise return immediately.

code: void WaitForInitialization() const


code: FPreloadableArchive ( FStringView ArchiveName )


className: FPreloadableArchive

description: This class is not threadsafe. The public interface can be used at the same time as internal asynchronous tasks are executing, but the public interface can not be used from multiple threads at once.

code: class FPreloadableArchive : public [FArchive](API\Runtime\Core\Serialization\FArchive)

AsynchronousHandle

type: TUniquePtr<IAs...

description: The handle used for PreloadBytes mode, to fulfull ReadReqeusts.

bInitialized

type: TAtomic< bool >

description: Threadsafe variable that returns true only after all asynchronous initialization is complete.

bIsInlineReadComplete

type: bool

description: Set to true during the ReadRequest call to allow us to detect if OnReadComplete is called inline on the same thread from ReadRequest.

bIsPreloading

description: Threadsafe variable that is true only during the period between initialization until Preloading stops (either due to EOF reached or due to Serialize turning it off.

bIsPreloadingPaused

description: Variable that is set to true from the public interface thread to signal that (temporarily) no further ReadRequests should be sent when the currently active one completes.

bReadCompleteWasCalledInline

description: Set to true if OnReadComplete is called inline on the same thread from ReadRequest; we need special handling for this case.

CacheBytes

type: uint8 *

description: An array of bytes of size Size.

CacheEnd

type: TAtomic< int64 ...

description: Number of bytes in CacheBytes that have already been read.

PageSize

description: The number of bytes requested from the AsynchronousHandle in each ReadRequest.

PendingAsyncComplete

type: FEvent*

description: An Event used for synchronization with asynchronous tasks - InitializingAsync or receiving ReadRequests from the AsynchronousHandle.

Pos

description: The Offset into the file or preloaded bytes that will be used in the next call to Serialize.

PreloadLock

type: FCriticalSectio...

description: CriticalSection used to synchronize access to the CacheBytes.

RetiredRequests

type: TArray<IAsyncR...

description: ReadRequests that have completed but we have not yet deleted.

SavedReadCompleteArguments

type: FPreloadableArc...

Size

description: The number of bytes in the file.

SynchronousArchive

type: TUniquePtr<FAr...

description: The archive used in PreloadHandle mode or to service Serialize requests that are beyond CacheEnd when in PreloadBytes mode.


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

code: virtual bool Close()


description: This is overridden for the specific Archive Types

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


description: Returns total size of the backing data storage.


code: FPreloadableArchiveProxy ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FPreloadableArchive](API\Runtime\Core\Misc\FPreloadableArchive) > & InArchive )


className: FPreloadableArchiveProxy

description: A helper class for systems that want to make their own registration system. A proxy archive that keeps a shared pointer to the innerFPreloadableArchive, so that the inner preloadablearchive will remain alive until at least as long as the proxy is destroyed.

code: class FPreloadableArchiveProxy : public [FArchive](API\Runtime\Core\Serialization\FArchive)


description: Initialize theFPreloadableFileasynchronously, performing FileOpen operations on another thread. Use IsInitialized or WaitForInitialization to check progress.

code: void InitializeAsync ( uint32 InFlags, int64 PrimeSize )


className: RegisteredFiles

description: Map used for TryTakeArchive registration.

code: static [TMap](API\Runtime\Core\Containers\TMap)< [FString](API\Runtime\Core\Containers\FString), [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FPreloadableFile](API\Runtime\Core\Misc\FPreloadableFile) > > RegisteredFiles;


description: Try to register the givenFPreloadableFileinstance to handle the next call to TryTakeArchive for its FileName. Will fail if the instance has not been initialized or if another instance has already registered for the Filename. Return whether the instance is currently registered. Returns true if the instance was already registered. Registered files are referenced-counted, and the reference will not be dropped until (1) (TryTakeArchive or UnRegister is called) and (2) (PreloadBytes mode only) the archive returned from TryTakeArchive is deleted.

code: static bool TryRegister ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FPreloadableFile](API\Runtime\Core\Misc\FPreloadableFile) > & PreloadableFile )


description: Look up anFPreloadableFileinstance registered for the given FileName, and return anFArchivefrom it. If found, removes the registration so no future call to TryTakeArchive can sue the sameFArchive. If the instance is in PreloadHandle mode, the Lower-LevelFArchivewill be detached from theFPreloadableFileand returned using DetachLowerLevel. If the instance is in PreloadBytes mode, a ProxyArchive will be returned that forwards call to theFPreloadableFileinstance.

code: static [FArchive](API\Runtime\Core\Serialization\FArchive) * TryTakeArchive ( const TCHAR * FileName )


description: Remove theFPreloadableFileinstance if it is registered for its FileName. Returns whether the instance was registered.

code: static bool UnRegister ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FPreloadableFile](API\Runtime\Core\Misc\FPreloadableFile) > & PreloadableFile )


code: FPreloadableFile ( FStringView FileName )


className: FPreloadableFile

description: Activate PreloadBytes mode by passing Flags::PreloadBytes to InitializeAsync. Activate PreloadHandle mode by passing Flags::PreloadHandle to InitializeAsync, optionally or'd with Flags::Prime.

code: class FPreloadableFile : public [FPreloadableArchive](API\Runtime\Core\Misc\FPreloadableArchive)


className: bSystemNoLongerTakingRequests

code: static bool bSystemNoLongerTakingRequests = false;


code: FPreLoadFile ( const TCHAR * InPath )


code: void * TakeOwnershipOfLoadedData ( int64 * OutFileSize )


code: static void * TakeOwnershipOfLoadedDataByPath ( const TCHAR * Filename, int64 * OutFileSize )


className: FPreLoadFile

code: struct FPreLoadFile : public [FDelayedAutoRegisterHelper](API\Runtime\Core\Misc\FDelayedAutoRegisterHelper)

AsyncReadHandle

type: IAsyncReadFileH...

Data

type: void *

SizeRequestHandle

type: IAsyncReadReque...


className: FPreviewPlatformMenuItem

description: Information for feature level menu item added by this platform

code: struct FPreviewPlatformMenuItem

ActiveIconPath

type: FString

IconText

type: FText


description: Convert this frame time to a value in seconds

code: double AsSeconds() const


description: Convert this frame time to a different frame rate

code: [FFrameTime](API\Runtime\Core\Misc\FFrameTime) ConvertTo ( [FFrameRate](API\Runtime\Core\Misc\FFrameRate) DesiredRate ) const


description: Any subframe value in the frame time will be ignored. Whether or not the returned timecode is a drop-frame timecode will be determined by the qualified frame time's frame rate and the CVar specifying whether to generate drop-frame timecodes by default for supported frame rates.


description: Create anFTimecodefrom this qualified frame time. Optionally supports creating a drop-frame timecode, which drops certain timecode display numbers to help account for NTSC frame rates which are fractional.

code: [FTimecode](API\Runtime\Core\Misc\FTimecode) ToTimecode ( bool bDropFrame ) const


description: Default construction forUObjectpurposes

code: FQualifiedFrameTime()


description: User construction from a frame time and its frame rate

code: FQualifiedFrameTime ( const [FFrameTime](API\Runtime\Core\Misc\FFrameTime) & InTime, const [FFrameRate](API\Runtime\Core\Misc\FFrameRate) & InRate )


description: User construction from a timecode and its frame rate

code: FQualifiedFrameTime ( const [FTimecode](API\Runtime\Core\Misc\FTimecode) & InTimecode, const [FFrameRate](API\Runtime\Core\Misc\FFrameRate) & InRate )


className: FQualifiedFrameTime

description: A frame time qualified by a frame rate context

code: struct FQualifiedFrameTime

Rate

type: FFrameRate

description: The rate that this frame time is in

Time

type: FFrameTime

description: The frame time


description:
Creates the thread pool with the specified number of threads
Whether the pool creation was successful or not

code: virtual bool Create ( uint32 InNumQueuedThreads, uint32 StackSize, EThreadPriority ThreadPriority, const TCHAR * Name )


description: Tells the pool to clean up all background threads

code: virtual void Destroy()


description: Queued task are not scheduled against the wrapped thread-pool until resumed

code: void Pause()


className: FQueuedLowLevelThreadPool::operator new

code: void * operator new ( size_t size )


description: InPriorityMapper Thread-safe function used to map any priority from this Queue to the priority that should be used when scheduling the task on the underlying thread pool.

code: FQueuedLowLevelThreadPool ( [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< EQueuedWorkPriority(EQueuedWorkPriority)> InPriorityMapper, [LowLevelTasks::FScheduler](API\Runtime\Core\Async\Fundamental\FScheduler) * InScheduler )


description: Resume a specified amount of queued work, or -1 to unpause.

code: void Resume ( int32 InNumQueuedWork )


description: RetractQueuedWork

code: void AddQueuedWork ( [IQueuedWork](API\Runtime\Core\Misc\IQueuedWork) * InQueuedWork, EQueuedWorkPriority InQueuedWorkPriority )


description:
Allocates a thread pool
A new thread pool.

code: static [FQueuedThreadPool](API\Runtime\Core\Misc\FQueuedThreadPool) * Allocate()


className: FQueuedLowLevelThreadPool

description: ThreadPool wrapper implementation allowing to schedule thread-pool tasks on the the low level backend which is also used by the taskgraph.

code: class FQueuedLowLevelThreadPool : public [FQueuedThreadPool](API\Runtime\Core\Misc\FQueuedThreadPool)


code: bool Create ( uint32 InNumQueuedThreads, uint32 StackSize, EThreadPriority ThreadPriority, const TCHAR * Name )


code: void Destroy()


description: Get the number of queued threads

code: int32 GetNumThreads() const


className: OverrideStackSize

description: Stack size for threads created for the thread pool. Can be overridden by other projects. If 0 means to use the value passed in the Create method.

code: static uint32 OverrideStackSize = 0;


description: AddQueuedWork

code: bool RetractQueuedWork ( [IQueuedWork](API\Runtime\Core\Misc\IQueuedWork) * InQueuedWork )


description: RetractQueuedWork

code: virtual void AddQueuedWork ( [IQueuedWork](API\Runtime\Core\Misc\IQueuedWork) * InQueuedWork, EQueuedWorkPriority InQueuedWorkPriority )


className: FQueuedThreadPool

description: This interface is used by all queued thread pools. It used as a callback by FQueuedThreads and is used to queue asynchronous work for callers.

code: class FQueuedThreadPool


description: Apply sort predicate to reorder the queued tasks

code: void Sort ( [TFunctionRef](API\Runtime\Core\GenericPlatform\TFunctionRef)< bool(const [IQueuedWork](API\Runtime\Core\Misc\IQueuedWork) *Lhs, const [IQueuedWork](API\Runtime\Core\Misc\IQueuedWork) *Rhs)> Predicate )


description: InWrappedQueuedThreadPool Underlying thread pool to schedule task to. InMaxConcurrency Maximum number of concurrent tasks allowed, -1 will limit concurrency to number of threads available in the underlying thread pool. InPriorityMapper Thread-safe function used to map any priority from this Queue to the priority that should be used when scheduling the task on the underlying thread pool.

code: FQueuedThreadPoolDynamicWrapper ( [FQueuedThreadPool](API\Runtime\Core\Misc\FQueuedThreadPool) * InWrappedQueuedThreadPool, int32 InMaxConcurrency, [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< EQueuedWorkPriority(EQueuedWorkPriority)> InPriorityMapper )


className: FQueuedThreadPoolDynamicWrapper

description: ThreadPool wrapper implementation allowing to schedule up to MaxConcurrency tasks at a time making sub-partitioning another thread-pool a breeze and allowing more fine-grained control over scheduling by giving full control of task reordering.

code: class FQueuedThreadPoolDynamicWrapper : public [FQueuedThreadPoolWrapper](API\Runtime\Core\Misc\FQueuedThreadPoolWrapper)


code: virtual bool Create ( uint32 InNumQueuedThreads, uint32 StackSize, EThreadPriority ThreadPriority, const TCHAR * Name )


description: InPriorityMapper Thread-safe function used to map any priority from this Queue to the priority that should be used when scheduling the task on the task graph.

code: FQueuedThreadPoolTaskGraphWrapper ( [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< [ENamedThreads::Type](API\Runtime\Core\Async\ENamedThreads__Type)(EQueuedWorkPriority)> InPriorityMapper )


code: virtual void Destroy()


description: InDesiredThread The task-graph desired thread and priority.

code: FQueuedThreadPoolTaskGraphWrapper ( [ENamedThreads::Type](API\Runtime\Core\Async\ENamedThreads__Type) InDesiredThread )


className: FQueuedThreadPoolTaskGraphWrapper

description: ThreadPool wrapper implementation allowing to schedule thread-pool tasks on the task graph.

code: class FQueuedThreadPoolTaskGraphWrapper : public [FQueuedThreadPool](API\Runtime\Core\Misc\FQueuedThreadPool)


code: ~FQueuedThreadPoolTaskGraphWrapper()


description: Can be overriden to allocate a more specialized version if needed.

code: virtual [FScheduledWork](API\Runtime\Core\Misc\FQueuedThreadPoolWrapper\FScheduledWork) * AllocateScheduledWork()


description: Returns text to identify the Work, for debug/log purposes only

code: virtual const TCHAR &42; GetDebugName&40;&41; const


code: FScheduledWork & operator&61; &40; const FScheduledWork & &41;


code: FScheduledWork & operator&61; &40; const FScheduledWork && &41;


code: FScheduledWork &40; const FScheduledWork & &41;


code: FScheduledWork &40; const FScheduledWork && &41;


className: FScheduledWork

code: class FScheduledWork : public [IQueuedWork](API\Runtime\Core\Misc\IQueuedWork), public [IExecutionResource](API\Runtime\Core\Experimental\Misc\IExecutionResource)


description: Can be overriden to dynamically control the maximum concurrency.

code: virtual int32 GetMaxConcurrency() const


description: Get the number of queued threads

code: virtual int32 GetNumThreads() const


description: Can be overriden to know when work has been unscheduled.

code: virtual void OnUnscheduled ( const [IQueuedWork](API\Runtime\Core\Misc\IQueuedWork) * )


description: Can be overriden to know when work has been scheduled.

code: virtual void OnScheduled ( const [IQueuedWork](API\Runtime\Core\Misc\IQueuedWork) * )


description: Queued task are not scheduled against the wrapped thread-pool until resumed

code: void Pause()


description: Resume a specified amount of queued work, or -1 to unpause.

code: void Resume ( int32 InNumQueuedWork )


description: AddQueuedWork

code: virtual bool RetractQueuedWork ( [IQueuedWork](API\Runtime\Core\Misc\IQueuedWork) * InQueuedWork )


description: Dynamically adjust the maximum number of concurrent tasks, -1 for unlimited.

code: void SetMaxConcurrency ( int32 MaxConcurrency )


code: FQueuedThreadPoolWrapper ( [FQueuedThreadPool](API\Runtime\Core\Misc\FQueuedThreadPool) * InWrappedQueuedThreadPool, int32 InMaxConcurrency, [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< EQueuedWorkPriority(EQueuedWorkPriority)> InPriorityMapper )


className: FQueuedThreadPoolWrapper

description: ThreadPool wrapper implementation allowing to schedule up to MaxConcurrency tasks at a time making sub-partitioning another thread-pool a breeze and allowing more fine-grained control over scheduling by effectively giving another set of priorities.

code: class FQueuedThreadPoolWrapper : public [FQueuedThreadPool](API\Runtime\Core\Misc\FQueuedThreadPool)

Lock

description: A critical section is used since we need reentrancy support from the same thread.

QueuedWork

type: FThreadPoolPrio...


code: FReadScopeLock &40; FReadScopeLock && &41;


code: FReadScopeLock &40; const FReadScopeLock & &41;


className: FReadScopeLock

description: Keeps a FRWLock read-locked while this scope lives

code: class FReadScopeLock


code: FRecursionScopeMarker ( uint16 & InCounter )


className: FRecursionScopeMarker

code: class FRecursionScopeMarker


code: namespace Freeze { void Freeze::IntrinsicToString ( const [FSHAHash](API\Runtime\Core\Misc\FSHAHash) & Object, const [FTypeLayoutDesc](API\Runtime\Core\Serialization\FTypeLayoutDesc) & TypeDesc, const [FPlatformTypeLayoutParameters](API\Runtime\Core\Serialization\FPlatformTypeLayoutParameters) & LayoutParams, [FMemoryToStringContext](API\Runtime\Core\Serialization\FMemoryToStringContext) & OutContext ) }


description: Simple accessor function.

code: [FRemoteConfigAsyncIOInfo](API\Runtime\Core\Misc\FRemoteConfigAsyncIOInfo) * FindConfig ( const TCHAR * Filename )


description: Waits on the async read if it hasn't finished yet... times out if the operation has taken too long.

code: void FinishRead ( const TCHAR * Filename )


description: Finishes all pending async IO tasks.

code: static void Flush()


description: Returns a reference to the globalFRemoteConfigobject.

code: static [FRemoteConfig](API\Runtime\Core\Misc\FRemoteConfig) * Get()


description: Returns true if the specified config file has been flagged as being remote.

code: bool IsRemoteFile ( const TCHAR * Filename )


description: Returns true if the task has completed.

code: bool IsFinished ( const TCHAR * InFilename )


description: Queues up a new async task for reading a remote config file.

code: bool Read ( const TCHAR * GeneratedIniFile, const TCHAR * DefaultIniFile )


description: Replaces chars used by the ini parser with "special chars".

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


description: Replaces "special chars" that have been inserted to avoid problems with the ini parser with equivalent regular chars.

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


description: Returns true if the specified file is remote and still needs to be read.

code: bool ShouldReadRemoteFile ( const TCHAR * Filename )


description: Queues up a new async task for writing a remote config file.

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


description: Constructor

code: FRemoteConfig()


className: FRemoteConfig

description: Manages remote config files.

code: class FRemoteConfig


code: FRemoteConfigAsyncCachedWriteTask ( const TCHAR * InFileName, [FString](API\Runtime\Core\Containers\FString) * InContents )


className: FRemoteConfigAsyncCachedWriteTask

description: Info for cached write tasks

code: class FRemoteConfigAsyncCachedWriteTask


code: FRemoteConfigAsyncIOInfo ( const TCHAR * InDefaultIniFile )


description: Constructors

code: FRemoteConfigAsyncIOInfo()


className: FRemoteConfigAsyncIOInfo

description: Stores info relating to remote config files

code: struct FRemoteConfigAsyncIOInfo

bReadIOFailed

description: If the last read operation failed, this flag will be set to true

Buffer

description: Stores the contents of the remote config file

bWasProcessed

description: True if this file has been processed

DefaultIniFile

description: Name of the corresponding default config file

StartReadTime

type: double

description: Time at which the last read was initiated

StartWriteTime

description: Time at which the last write was initiated

TimeStamp

type: FDateTime

description: Time stamp of the remote config file


description: Returns true if the all tasks in the queue have completed (or, if the queue is empty).

code: bool AreAllTasksFinished ( bool bDoRemoval )


description: Returns a reference to the globalFRemoteConfigAsyncTaskManagerobject.

code: static [FRemoteConfigAsyncTaskManager](API\Runtime\Core\Misc\FRemoteConfigAsyncTaskManager) * Get()


description: Safely retrieve the read data from the completed async task.

code: bool GetReadData ( const TCHAR * InFilename, [FRemoteConfigAsyncIOInfo](API\Runtime\Core\Misc\FRemoteConfigAsyncIOInfo) & OutIOInfo )


description: Returns true if the task has completed


description: Add an async IO task to the queue and kick it off.

code: bool StartTask ( const TCHAR * InFilename, const TCHAR * RemotePath, [FRemoteConfigAsyncIOInfo](API\Runtime\Core\Misc\FRemoteConfigAsyncIOInfo) & InIOInfo, [FString](API\Runtime\Core\Containers\FString) * InContents, bool bInIsRead )


description: Handles cached write tasks.

code: void Tick()


className: FRemoteConfigAsyncTaskManager

description: Manages async IO tasks for remote config files

code: class FRemoteConfigAsyncTaskManager


description: Abandon routine

code: void Abandon()


description: Indicates to the thread pool that this task is abandonable.

code: bool CanAbandon()


description: Returns the local IO info object


description: Performs the actual IO operations.

code: void DoWork()


description: Returns true if the read IO operation succeeded.

code: bool IsReadSuccess() const


className: FRuntimeErrorDelegate

description: The style of delegate called when a runtime issue occurs.

code: typedef TBaseDelegate_FourParams< void, [ELogVerbosity::Type](API\Runtime\Core\Logging\ELogVerbosity__Type), const ANSICHAR *, int32, const [FText](API\Runtime\Core\Internationalization\FText) & > FRuntimeErrorDelegate


description: Constructor.

code: FRemoteConfigAsyncWorker ( const TCHAR * InFilename, [FRemoteConfigAsyncIOInfo](API\Runtime\Core\Misc\FRemoteConfigAsyncIOInfo) & InIOInfo, [FString](API\Runtime\Core\Containers\FString) * InContents, bool bInIsRead )


description:
Prints out a runtime warning or error (typically by 'throwing' a BP script exception with the BP callstack)
false in all cases.

code: static void LogRuntimeIssue ( [ELogVerbosity::Type](API\Runtime\Core\Logging\ELogVerbosity__Type) Verbosity, const ANSICHAR * FileName, int32 LineNumber, const [FText](API\Runtime\Core\Internationalization\FText) & Message )


className: FRemoteConfigAsyncWorker

description: Async task that handles the IO of a remote config file

code: class FRemoteConfigAsyncWorker


className: FRuntimeErrors

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

code: struct FRuntimeErrors


className: OnRuntimeIssueLogged

description: A delegate this is called when a runtime issue is raised.


description:
Acquires read access, will check if there are any writers
true if no errors were detected

code: bool AcquireReadAccess() const


description:
Acquires write access, will check if there are readers or other writers
true if no errors were detected

code: bool AcquireWriteAccess() const


code: [FRWAccessDetector](API\Runtime\Core\Misc\FRWAccessDetector) & operator= ( [FRWAccessDetector](API\Runtime\Core\Misc\FRWAccessDetector) && Other )


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


description:
Releases read access, will check if there are any writers
true if no errors were detected

code: bool ReleaseReadAccess() const


description:
Releases write access, will check if there are readers or other writers
true if no errors were detected

code: bool ReleaseWriteAccess() const


className: WriterBits

description: We need to do an atomic operation to know there are multiple writers, this is why we reserve more than one bit for them. While firing the check upon acquire write access, the other writer thread could continue and hopefully fire a check upon releasing access so we get both faulty callstacks.

code: static constexpr uint32 WriterBits = 0xfff00000;


description:
Raises a runtime error and returns false.
false in all cases.

code: static bool LogRuntimeIssueReturningFalse ( const ANSICHAR * Expr, const ANSICHAR * File, int32 Line )


className: WriterIncrementValue

code: static constexpr uint32 WriterIncrementValue = 0x100000;


code: FRWAccessDetector ( [FRWAccessDetector](API\Runtime\Core\Misc\FRWAccessDetector) && Other )


code: FRWAccessDetector ( const [FRWAccessDetector](API\Runtime\Core\Misc\FRWAccessDetector) & Other )


className: FRWAccessDetector

description: Read write multithread access detector, will check on concurrent write/write and read/write access, but will not on concurrent read access. Note this detector is not re-entrant, seeFRWRecursiveAccessDetectorandFRWFullyRecursiveAccessDetector. ButFRWAccessDetectorshould be the default one to start with.

code: struct FRWAccessDetector

AtomicValue

type: std::atomic< ui...


className: FRWFullyRecursiveAccessDetector

description: Same asFRWRecursiveAccessDetector, but support re-entrance on read access when holding a write access.

code: struct FRWFullyRecursiveAccessDetector : public [FRWRecursiveAccessDetector](API\Runtime\Core\Misc\FRWRecursiveAccessDetector)


className: FRWRecursiveAccessDetector

description: Same asFRWAccessDetector, but support re-entrance on the write access SeeFRWFullyRecursiveAccessDetectorfor read access re-entrance when holding a write access

code: struct FRWRecursiveAccessDetector : public [FRWAccessDetector](API\Runtime\Core\Misc\FRWAccessDetector)


description: NOTE: As the name suggests, this function should be used with caution. It releases the read lockbeforeacquiring a new write lock. This is not an atomic operation and the caller should not treat it as such. E.g. Pointers read from protected data structures prior to this call may be invalid after the function is called.


code: FRWScopeLock &40; FRWScopeLock && &41;


code: FRWScopeLock &40; const FRWScopeLock & &41;


code: FRWScopeLock ( FRWLock & InLockObject, FRWScopeLockType InLockType )


className: FRWScopeLock

description: Notes:

code: class FRWScopeLock


code: void AddAccess ( [EType](API\Runtime\Core\Misc\UE__AccessDetection__EType) Type )


className: FScope

description: Detects access to global core systems while running deterministic code that should be isolated from the local environment

code: class FScope


description:
Retrieve the event, usually for passing around.
The event.


description:
Checks if the event has been triggered (used for special early out cases of scope event) if this returns true once it will return true forever
returns true if the scoped event has been triggered once

code: bool IsReady()


description: Triggers the event.

code: void Trigger()


description: Default constructor.

code: FScopedEvent()


description: Destructor.

code: ~FScopedEvent()


className: FScopedEvent

description: Usage: {FScopedEventMyEvent; SendReferenceOrPointerToSomeOtherThread(&MyEvent); // Other thread calls MyEvent->Trigger(); // MyEvent destructor is here, we wait here. }

code: class FScopedEvent


code: FScopedScriptExceptionHandler ( const FScriptExceptionHandlerFunc & InFunc )


className: FScopedScriptExceptionHandler

description: Scoped struct used to push and pop a script exception handler

code: struct FScopedScriptExceptionHandler


description: Construct this scope from an amount of work to do, and a message to display

code: FScopedSlowTask ( float InAmountOfWork, const [FText](API\Runtime\Core\Internationalization\FText) & InDefaultMessage, bool bInEnabled, [FFeedbackContext](API\Runtime\Core\Misc\FFeedbackContext) & InContext )


className: FScopedSlowTask

description: Progress.EnterProgressFrame(1.f); DoSecondThing(); }

code: struct FScopedSlowTask : public [FSlowTask](API\Runtime\Core\Misc\FSlowTask)


code: template<typename FuncType> [TScopeGuard](API\Runtime\Core\Misc\TScopeGuard)< FuncType > operator+ ( FuncType && InFunc )


className: FScopeGuardSyntaxSupport

code: struct FScopeGuardSyntaxSupport


description: Default constructor (hidden on purpose).


description: Constructor that performs a lock on the synchronization object

code: FScopeLock ( FCriticalSection * InSynchObject )


description: Copy constructor( hidden on purpose).

code: FScopeLock &40; const FScopeLock & InScopeLock &41;


description: Destructor that performs a release on the synchronization object.

code: ~FScopeLock()


className: FScopeLock

description: ` { // Synchronize thread access to the following dataFScopeLockScopeLock(SynchObject); // Access data that is shared among multiple threads ... // When ScopeLock goes out of scope, other threads can access data } _

code: class FScopeLock


description: Constructor that tries to lock the critical section. Note that you must call IsLocked to test that the lock was acquired.

code: FScopeTryLock ( FCriticalSection * InCriticalSection )


code: FScopeTryLock &40; FScopeTryLock const & InScopeLock &41;


description: Destructor that will release the lock if it was ever acquired.

code: ~FScopeTryLock()


className: FScopeTryLock

description: ` { // Try to acquire a lock on CriticalSection for the current scope.FScopeTryLockScopeTryLock(CriticalSection); // Check that the lock was acquired. if (ScopeTryLock.IsLocked()) { // If the lock was acquired, we can safely access resources protected // by the lock. } // When ScopeTryLock goes out of scope, the critical section will be // released if it was ever acquired. } _

code: class FScopeTryLock


description: Constructor that performs a unlock on the synchronization object

code: FScopeUnlock ( FCriticalSection * InSynchObject )


description: Copy constructor( hidden on purpose).

code: FScopeUnlock &40; const FScopeUnlock & InScopeLock &41;


description: Destructor that performs a lock on the synchronization object.

code: ~FScopeUnlock()


className: FScopeUnlock

description: ` { // Access data that is shared among multiple threadsFScopeUnlockScopeUnlock(SynchObject); ... // When ScopeUnlock goes out of scope, other threads can no longer access data } _

code: class FScopeUnlock


description: Handler for a script exception that emits an ensure (for warnings or errors)

code: static void AssertionExceptionHandler ( [ELogVerbosity::Type](API\Runtime\Core\Logging\ELogVerbosity__Type) Verbosity, const TCHAR * ExceptionMessage, const TCHAR * StackMessage )


className: DefaultExceptionHandler

description: Default script exception handler

code: static FScriptExceptionHandlerFunc DefaultExceptionHandler = &FScriptExceptionHandler::LoggingExceptionHandler;


description: Get the exception handler for the current thread

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


description: Handle an exception using the active exception handler

code: void HandleException ( [ELogVerbosity::Type](API\Runtime\Core\Logging\ELogVerbosity__Type) Verbosity, const TCHAR * ExceptionMessage, const TCHAR * StackMessage )


description: Handler for a script exception that emits a log message

code: static void LoggingExceptionHandler ( [ELogVerbosity::Type](API\Runtime\Core\Logging\ELogVerbosity__Type) Verbosity, const TCHAR * ExceptionMessage, const TCHAR * StackMessage )


description: Push an exception handler onto the stack

code: void PushExceptionHandler ( const FScriptExceptionHandlerFunc & InFunc )


description: Pop an exception handler from the stack

code: void PopExceptionHandler()


className: FScriptExceptionHandler

description: Exception handler stack used for script exceptions.

code: class FScriptExceptionHandler : public [TThreadSingleton< FScriptExceptionHandler >](API\Runtime\Core\HAL\TThreadSingleton)


description: Routes a command to the self-registered execs.

code: static bool StaticExec ( [UWorld](API\Runtime\Engine\Engine\UWorld) * Inworld, const TCHAR * Cmd, [FOutputDevice](API\Runtime\Core\Misc\FOutputDevice) & Ar )


description: Destructor, unregistering this instance.

code: virtual ~FSelfRegisteringExec()


description: Constructor, registering this instance.

code: FSelfRegisteringExec()


className: FSelfRegisteringExec

description: Exec handler that registers itself and is being routed via StaticExec. Note: Not intended for use with UObjects!

code: class FSelfRegisteringExec : public [FExec](API\Runtime\Core\Misc\FExec)


className: bHasSucceededOnce

code: static bool bHasSucceededOnce = false;


description: Get the host-platform-specific path to the UAT running script


className: HeadProcess

code: static [FSerializedUATProcess](API\Runtime\Core\Misc\FSerializedUATProcess) * HeadProcess = nullptr;


description: Run UAT, serially with otherFSerializedUATProcessobjects. Because the actual call is delayed, this will always return true, and the LaunchFailedDelegate will be called later if an error happens

code: virtual bool Launch()


description:
Returns a delegate that is executed when the process has been canceled.
The delegate.

code: FSimpleDelegate & OnLaunchFailed()


className: Serializer

code: static FCriticalSection Serializer;


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


className: FSerializedUATProcess

code: class FSerializedUATProcess : public [FMonitoredProcess](API\Runtime\Core\Misc\FMonitoredProcess)


description: Finalize hash and report.

code: void Final()


description: Finalize hash and return it.


className: FullFileSHAHashMap

description: Global maps of filename to hash value

code: static [TMap](API\Runtime\Core\Containers\TMap)< [FString](API\Runtime\Core\Containers\FString), uint8 * > FullFileSHAHashMap;


description: Report functions: as pre-formatted and raw data.

code: void GetHash ( uint8 * puDest )


description:
Gets the stored SHA hash from the platform, if it exists. This function must be able to be called from any thread.
true if the hash was found, false otherwise

code: static bool GetFileSHAHash ( const TCHAR * Pathname, uint8 Hash, bool bIsFullPackageHash )


description:
Calculate the hash on a single block and return it
Resulting digest

code: static [FSHAHash](API\Runtime\Core\Misc\FSHAHash) HashBuffer ( const void * Data, uint64 DataSize )


description: Calculate the hash on a single block and return it

code: static void HashBuffer ( const void * Data, uint64 DataSize, uint8 * OutHash )


description: Generate the HMAC (Hash-based Message Authentication Code) for a block of data.https://en.wikipedia.org/wiki/Hash-based_message_authentication_code

code: static void HMACBuffer ( const void * Key, uint32 KeySize, const void * Data, uint64 DataSize, uint8 * OutHash )


description: Shared hashes.sha reading code (each platform gets a buffer to the data, then passes it to this function for processing)

code: static void InitializeFileHashesFromBuffer ( uint8 * Buffer, uint64 BufferSize, bool bDuplicateKeyMemory )


className: ScriptSHAHashMap

description: Global map of filename to hash value, but for script-only SHA hashes

code: static [TMap](API\Runtime\Core\Containers\TMap)< [FString](API\Runtime\Core\Containers\FString), uint8 * > ScriptSHAHashMap;


description: Update the hash value.

code: void Update ( const uint8 * data, uint64 len )


description: Update the hash value with string.

code: void UpdateWithString ( const TCHAR * data, uint32 len )


description: Constructor and Destructor.


code: void AppendString ( [FString](API\Runtime\Core\Containers\FString) & Out ) const


code: void FromString ( const FStringView & Src )


code: static constexpr int32 GetStringLen()


code: void ToString ( TCHAR * Dest, bool bNullTerminate ) const


description:
Manually reset events stay triggered until reset. Named events share the same underlying event.
true if the event was created, false otherwise.

code: virtual bool Create ( bool bIsManualReset )


className: FSHAHash

description: Stores an SHA hash generated byFSHA1.

code: class FSHAHash


description: Reset

code: virtual bool IsManualReset()


description: Reset

code: virtual void Trigger()


description:
A wait time of MAX_uint32 is treated as infinite wait.
true if the event was triggered, false if the wait timed out.

code: virtual bool Wait ( uint32 WaitTime, const bool bIgnoreThreadIdleStats )


description: Trigger

code: virtual void Reset()


description: Default constructor.

code: FSingleThreadEvent()


className: FSingleThreadEvent

description: Fake event object used when running with only one thread.

code: class FSingleThreadEvent : public [FEvent](API\Runtime\Core\HAL\FEvent)


description: Tick function.

code: void Tick()


className: FSingleThreadRunnable

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

code: class FSingleThreadRunnable


description: Indicate that we are to enter a frame that will take up the specified amount of work. Completes any previous frames (potentially contributing to parent scopes' progress).

code: void EnterProgressFrame ( float ExpectedWorkThisFrame, const [FText](API\Runtime\Core\Internationalization\FText) & Text )


description: Function that finishes any remaining work and removes itself from the global scope stack

code: void Destroy()


description: Whenever we encounter edge condition requiring to force a UI refresh

code: static void ForceRefresh &40; FFeedbackContext & Context &41;


description: Whenever we encounter edge condition requiring to force a UI refresh (Like if another popup would show when the slow task finishes and you want it to show 100%)

code: void ForceRefresh()


description: Get the frame message or default message if empty

code: const [FText](API\Runtime\Core\Internationalization\FText) & GetCurrentMessage() const


description: Function that initializes the scope by adding it to its context's stack

code: void Initialize()


description: Creates a new dialog for this slow task, if there is currently not one open

code: void MakeDialog ( bool bShowCancelButton, bool bAllowInPIE )


description: Creates a new dialog for this slow task after the given time threshold. If the task completes before this time, no dialog will be shown.

code: void MakeDialogDelayed ( float Threshold, bool bShowCancelButton, bool bAllowInPIE )


description: True if the user has requested that the slow task be canceled

code: bool ShouldCancel() const


description: True if a slow task should be created. False if a slow task should not be created because another was created recently.


description: Let the UI refresh but doesn't advance progress. This should be called at regular intervals even when no progress is being made to keep the UI responsive.

code: void TickProgress()


description: Prevent copying

code: FSlowTask &40; const FSlowTask & &41;


description: Construct this scope from an amount of work to do, and a message to display

code: FSlowTask ( float InAmountOfWork, const [FText](API\Runtime\Core\Internationalization\FText) & InDefaultMessage, bool bInEnabled, [FFeedbackContext](API\Runtime\Core\Misc\FFeedbackContext) & InContext )


className: FSlowTask

description: Data type used to store information about a currently running slow task. Direct use is not advised, useFScopedSlowTaskinstead

code: struct FSlowTask

CompletedWork

type: float

description: The amount of work we have already completed in this scope

CurrentFrameScope

description: The amount of work the current frame is responsible for

DefaultMessage

description: Default message to display to the user when not overridden by a frame

FrameMessage

description: Message pertaining to the current frame's work

OpenDialogThreshold

type: TOptional< floa...

description: Threshold before dialog is opened

StartTime

description: The time that this scope was created

TotalAmountOfWork

description: The amount of work to do in this scope

Visibility

type: ESlowTaskVisibi...

description: The visibility of this slow task


description: Get the fraction of work that has been completed for the specified index in the stack (0=total progress)

code: float GetProgressFraction ( int32 Index ) const


className: FSlowTaskStack

description: A stack of feedback scopes

code: struct FSlowTaskStack : public [TArray< FSlowTask * >](API\Runtime\Core\Containers\TArray)


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


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


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


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


description: Initialization constructor.

code: FStaticSelfRegisteringExec ( bool(*)([UWorld](API\Runtime\Engine\Engine\UWorld) *Inworld, const TCHAR *Cmd, [FOutputDevice](API\Runtime\Core\Misc\FOutputDevice) &Ar) InStaticExecFunc )


className: FSpinLock

description: A mutex that doesn't put the thread into a WAIT state but instead repeatedly tries to aquire the lock. WARNING: Should be used only for very short locks Use with `TScopeLock_

code: class FSpinLock


className: FStaticSelfRegisteringExec

description: Registers a static Exec function usingFSelfRegisteringExec.

code: class FStaticSelfRegisteringExec : public [FSelfRegisteringExec](API\Runtime\Core\Misc\FSelfRegisteringExec)


description: Implementation of Exec that is only called in non-shipping targets

code: virtual bool Exec_Dev ( [UWorld](API\Runtime\Engine\Engine\UWorld) * InWorld, const TCHAR * Cmd, [FOutputDevice](API\Runtime\Core\Misc\FOutputDevice) & Ar )


description: Initialization constructor.

code: FStaticSelfRegisteringExec_Dev ( bool(*)([UWorld](API\Runtime\Engine\Engine\UWorld) *Inworld, const TCHAR *Cmd, [FOutputDevice](API\Runtime\Core\Misc\FOutputDevice) &Ar) InStaticExecFunc )


description: Registers a static Exec_Dev function usingFSelfRegisteringExec.

code: class FStaticSelfRegisteringExec_Dev : public [FSelfRegisteringExec](API\Runtime\Core\Misc\FSelfRegisteringExec)


description: Initialization constructor.

code: FStaticSelfRegisteringExec_Editor ( bool(*)([UWorld](API\Runtime\Engine\Engine\UWorld) *Inworld, const TCHAR *Cmd, [FOutputDevice](API\Runtime\Core\Misc\FOutputDevice) &Ar) InStaticExecFunc )


description: Registers a static Exec_Editor function usingFSelfRegisteringExec.

code: class FStaticSelfRegisteringExec_Editor : public [FSelfRegisteringExec](API\Runtime\Core\Misc\FSelfRegisteringExec)


className: EType

code: enum EType { Int, UInt, Double, String, StringLiteralANSI, StringLiteralWIDE, StringLiteralUCS2, StringLiteralUTF8, }


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


code: [FStringFormatArg](API\Runtime\Core\Misc\FStringFormatArg) & operator= ( [FStringFormatArg](API\Runtime\Core\Misc\FStringFormatArg) && Other )


description: Not default constructible

code: FStringFormatArg()


code: FStringFormatArg ( const ANSICHAR * Value )


description: Implementation of Exec that is only called in editor

code: virtual bool Exec_Editor ( [UWorld](API\Runtime\Engine\Engine\UWorld) * InWorld, const TCHAR * Cmd, [FOutputDevice](API\Runtime\Core\Misc\FOutputDevice) & Ar )


code: FStringFormatArg ( const WIDECHAR * Value )


code: FStringFormatArg ( const UCS2CHAR * Value )


code: FStringFormatArg ( const [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * Value )


code: FStringFormatArg ( const [FStringFormatArg](API\Runtime\Core\Misc\FStringFormatArg) & Other )


code: FStringFormatArg ( [FStringFormatArg](API\Runtime\Core\Misc\FStringFormatArg) && Other )


code: FStringFormatArg ( const int32 Value )


code: FStringFormatArg ( const int64 Value )


code: FStringFormatArg ( const uint32 Value )


code: FStringFormatArg ( const uint64 Value )


code: FStringFormatArg ( const float Value )


code: FStringFormatArg ( const double Value )


code: FStringFormatArg ( [FString](API\Runtime\Core\Containers\FString) Value )


code: FStringFormatArg ( FStringView Value )


className: FStringFormatArg

description: An argument supplied toFString::Format

code: struct FStringFormatArg

type: union FStringFo...

description: Todo: convert this to aTVariant

DoubleValue

description: Value as double

IntValue

description: Value as integer

StringLiteralANSIValue

type: const ANSICHAR ...

description: Value as an ANSI string literal

type: const UCS2CHAR ...

description: Value as a UCS2 string literal

type: const UTF8CHAR ...

description: Value as a UTF8 string literal

StringLiteralWIDEValue

type: const WIDECHAR ...

description: Value as a WIDE string literal

StringValue

description: Value as anFString

Type

type: EType

description: The type of this arg

UIntValue

description: Value as uint


description:
Format the specified string using the specified arguments. Replaces instances of { Argument } with keys in the map matching 'Argument'
A string containing the formatted text

code: [FString](API\Runtime\Core\Containers\FString) Format ( const TCHAR * InExpression, const [TMap](API\Runtime\Core\Containers\TMap)< [FString](API\Runtime\Core\Containers\FString), [FStringFormatArg](API\Runtime\Core\Misc\FStringFormatArg) > & InArgs ) const


description:
Format the specified string using the specified arguments. Replaces instances of {0} with indices from the given array matching the index specified in the token
A string containing the formatted text

code: [FString](API\Runtime\Core\Containers\FString) Format ( const TCHAR * InExpression, const [TArray](API\Runtime\Core\Containers\TArray)< [FStringFormatArg](API\Runtime\Core\Misc\FStringFormatArg) > & InArgs ) const


description:
Format the specified string using the specified arguments. Replaces instances of { Argument } with keys in the map matching 'Argument'
A string containing the formatted text, or an error where InExpression is ill-formed, or contains undefined arguments

code: [TValueOrError](API\Runtime\Core\Math\TValueOrError)< [FString](API\Runtime\Core\Containers\FString), [FExpressionError](API\Runtime\Core\Misc\FExpressionError) > FormatStrict ( const TCHAR * InExpression, const [TMap](API\Runtime\Core\Containers\TMap)< [FString](API\Runtime\Core\Containers\FString), [FStringFormatArg](API\Runtime\Core\Misc\FStringFormatArg) > & InArgs ) const


description:
Format the specified string using the specified arguments. Replaces instances of {0} with indices from the given array matching the index specified in the token
A string containing the formatted text, or an error where InExpression is ill-formed, or contains undefined arguments

code: [TValueOrError](API\Runtime\Core\Math\TValueOrError)< [FString](API\Runtime\Core\Containers\FString), [FExpressionError](API\Runtime\Core\Misc\FExpressionError) > FormatStrict ( const TCHAR * InExpression, const [TArray](API\Runtime\Core\Containers\TArray)< [FStringFormatArg](API\Runtime\Core\Misc\FStringFormatArg) > & InArgs ) const


className: FStringFormatter

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

code: class FStringFormatter


description: Accumulate another token into this one

code: void Accumulate ( const [FStringToken](API\Runtime\Core\Misc\FStringToken) & InToken )


description: Contextual information about this token

code: int32 GetCharacterIndex() const


code: const TCHAR * GetTokenEndPos() const


description: Get the position of the start and end of this token in the stream

code: const TCHAR * GetTokenStartPos() const


description: Check if this token is valid

code: bool IsValid() const


description: Get the string representation of this token


code: FStringToken ( const TCHAR * InStart, int32 Line, int32 Character )


className: FStringToken

description: Simple struct that defines a specific token contained in anFTokenStream

code: class FStringToken

LineNumber

description: Line number and Character index

TokenEnd

type: const TCHAR ...

description: The end of the token

TokenStart

description: The start of the token


description:
Adds a new member to the end of the struct.
The offset of the member from the start of the struct.

code: int32 AddMember ( int32 MemberSize, int32 MemberAlignment )


description:
Returns the current alignment of the struct.
The alignment of the struct.

code: int32 GetAlignment() const


description:
Returns the current size of the struct.
The size of the struct.

code: int32 GetSize() const


className: FStructBuilder

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

code: class FStructBuilder


className: MonikerCount

code: static constexpr int32 MonikerCount = 1;


className: FSubExpressionEnd

code: struct FSubExpressionEnd


className: Monikers

code: static const TCHAR * Monikers = { TEXT(")") };


code: static const TCHAR * Monikers = { TEXT("(") };


description: Makes the change to the object

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


className: FSubExpressionStart

code: struct FSubExpressionStart


description: What style of change is this


description: Reverts change to the object

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


className: FTestHotFixPayload

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

code: struct FTestHotFixPayload

Message

type: FString

Result

type: bool


className: FSwapChange

description: To useFSwapChangeyou must implementExecute(). This function must do two things: 1) apply the change to the givenUObject2) return a newFSwapChangethat does the "opposite" action

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


description: Helper function to add callbacks for function tokens

code: void AddFunctionTokenCallback ( [FString](API\Runtime\Core\Containers\FString) InFunctionName, FTokenFunctionHandler InCallback )


description: Common function to construct the expression parser


description: Evaluate the given compiled result, and optionally populate OutErrorText with any error information

code: virtual bool EvaluateCompiledExpression ( const [ExpressionParser::CompileResultType](API\Runtime\Core\Misc\CompileResultType) & InCompiledResult, const [ITextFilterExpressionContext](API\Runtime\Core\Misc\ITextFilterExpressionContext) & InContext, [FText](API\Runtime\Core\Internationalization\FText) * OutErrorText ) const


description: Get the last error returned from lexing or compiling the current filter text


description: Get the filter expression tokens created from the current filter text

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


description: Get the filter terms that we're currently using


description: Get the complexity of the current filter terms


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


description: Set the filter terms to be compiled for evaluation later. Returns true if the filter was actually changed

code: bool SetFilterText ( const [FText](API\Runtime\Core\Internationalization\FText) & InFilterText )


description: Sets up grammar used for evaluation

code: void SetupGrammar()


description: Test our compiled filter using the given context

code: bool TestTextFilter ( const [ITextFilterExpressionContext](API\Runtime\Core\Misc\ITextFilterExpressionContext) & InContext ) const


description: Construction and assignment

code: FTextFilterExpressionEvaluator ( const ETextFilterExpressionEvaluatorMode InMode )


code: FTextFilterExpressionEvaluator ( const [FTextFilterExpressionEvaluator](API\Runtime\Core\Misc\FTextFilterExpressionEvaluator) & Other )


className: FTextFilterExpressionEvaluator

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

code: class FTextFilterExpressionEvaluator

CompiledFilter

type: TOptional<Expr...

description: The compiled filter created from the current filter text (compiled from FilterText)

type: TOptional<Text...

description: If there is only one token that is basic string it will be stored here to avoid recompile per item compared.

ExpressionEvaluatorMode

type: ETextFilterExpr...

description: Defines whether or not the expression parser can evaluate complex expressions

ExpressionTokens

type: TArray<FExpres...

description: The filter expression tokens created from the current filter text (lexed from FilterText)

FilterErrorText

type: FText

description: The last error returned from lexing or compiling the current filter text

FilterText

description: The the filter terms that we're currently using (compiled into CompiledFilter)

FilterType

description: The cached complexity of the current filter terms

Grammar

type: FExpressionGram...

JumpTable

type: TOperatorJumpTa...

TokenDefinitions

type: FTokenDefinitio...

description: Expression parser

TokenFunctionHandlers

type: TMap<FString, ...

description: Mapping of function names to their callbacks


description: Get the internal uppercase string of this filter string as anFName


description: Get the internal uppercase string of this filter string

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


description: Are the two given strings able to be compared numberically?

code: bool CanCompareNumeric ( const [FTextFilterString](API\Runtime\Core\Misc\FTextFilterString) & InOther ) const


description: Compare this string against the otherFString, using the text comparison mode provided

code: bool CompareFString ( const [FString](API\Runtime\Core\Containers\FString) & InOther, const ETextFilterTextComparisonMode InTextComparisonMode ) const


description: Compare this string against the otherFName, using the text comparison mode provided

code: bool CompareName ( const [FName](API\Runtime\Core\UObject\FName) & InOther, const ETextFilterTextComparisonMode InTextComparisonMode ) const


description: Compare this string against the other, using the text comparison mode provided

code: bool CompareText ( const [FTextFilterString](API\Runtime\Core\Misc\FTextFilterString) & InOther, const ETextFilterTextComparisonMode InTextComparisonMode ) const


description: Compare this string against the other, converting them to numbers and using the comparison operator provided - you should have tested CanCompareNumeric first!

code: bool CompareNumeric ( const [FTextFilterString](API\Runtime\Core\Misc\FTextFilterString) & InOther, const ETextFilterComparisonOperation InComparisonOperation ) const


description: Is the internal string empty?

code: bool IsEmpty() const


description: Move and copy assignment

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


code: [FTextFilterString](API\Runtime\Core\Misc\FTextFilterString) & operator= ( [FTextFilterString](API\Runtime\Core\Misc\FTextFilterString) && Other )


description: Default constructor

code: FTextFilterString()


description: Move and copy constructors

code: FTextFilterString ( const [FTextFilterString](API\Runtime\Core\Misc\FTextFilterString) & Other )


code: FTextFilterString ( [FTextFilterString](API\Runtime\Core\Misc\FTextFilterString) && Other )


description: Construct from a string

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


code: FTextFilterString ( [FString](API\Runtime\Core\Containers\FString) && InString )


code: FTextFilterString ( const TCHAR * InString )


description: Construct from a name

code: FTextFilterString ( const [FName](API\Runtime\Core\UObject\FName) & InName )


className: FTextFilterString

description: String used by the text filter. The given string will be stored as uppercase since filter text always performs case-insensitive string comparisons, so this will minimize ToUpper calls.

code: class FTextFilterString


code: const [FTextFilterString](API\Runtime\Core\Misc\FTextFilterString) & GetString() const


code: bool EvaluateAsComplexExpression ( const [ITextFilterExpressionContext](API\Runtime\Core\Misc\ITextFilterExpressionContext) * InContext, const [FTextFilterString](API\Runtime\Core\Misc\FTextFilterString) & InKey, const ETextFilterComparisonOperation InComparisonOperation ) const


className: EInvertResult

code: enum EInvertResult { No, Yes, }


code: bool EvaluateAsBasicStringExpression ( const [ITextFilterExpressionContext](API\Runtime\Core\Misc\ITextFilterExpressionContext) * InContext ) const


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


code: [FTextToken](API\Runtime\Core\Misc\FTextToken) & operator= ( [FTextToken](API\Runtime\Core\Misc\FTextToken) && Other )


code: FTextToken ( [FTextToken](API\Runtime\Core\Misc\FTextToken) && Other )


code: FTextToken ( const [FTextToken](API\Runtime\Core\Misc\FTextToken) & Other )


code: FTextToken ( [FTextFilterString](API\Runtime\Core\Misc\FTextFilterString) InString, ETextFilterTextComparisonMode InTextComparisonMode, const [EInvertResult](API\Runtime\Core\Misc\FTextToken\EInvertResult) InInvertResult )


description: Updates the current command and will only return TRUE when it has fulfilled its role (Load map has completed and wait time has expired)

code: virtual bool Update()


code: FThreadedAutomationLatentCommand ( [TUniqueFunction](API\Runtime\Core\Templates\TUniqueFunction)< void()> InFunction )


className: FThreadedAutomationLatentCommand

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

code: class FThreadedAutomationLatentCommand : public [IAutomationLatentCommand](API\Runtime\Core\Misc\IAutomationLatentCommand)

Function

type: TUniqueFunction...

Future

type: TFuture< void >


description: Get the next work item in priority order.

code: [IQueuedWork](API\Runtime\Core\Misc\IQueuedWork) * Dequeue ( EQueuedWorkPriority * OutDequeuedWorkPriority )


description: Get the total number of queued items.

code: int32 Num() const


description: Enqueue a work item at specified priority

code: void Enqueue ( [IQueuedWork](API\Runtime\Core\Misc\IQueuedWork) * InQueuedWork, EQueuedWorkPriority InPriority )


description: Get the next work item in priority order without actually dequeuing.

code: [IQueuedWork](API\Runtime\Core\Misc\IQueuedWork) * Peek ( EQueuedWorkPriority * OutDequeuedWorkPriority ) const


description: Empty the queue.

code: void Reset()


description: Search and remove a queued work item from the list

code: bool Retract ( [IQueuedWork](API\Runtime\Core\Misc\IQueuedWork) * InQueuedWork )


description: Sort Priority Bucket given Predicate

code: void Sort ( EQueuedWorkPriority InPriorityBucket, [TFunctionRef](API\Runtime\Core\GenericPlatform\TFunctionRef)< bool(const [IQueuedWork](API\Runtime\Core\Misc\IQueuedWork) *A, const [IQueuedWork](API\Runtime\Core\Misc\IQueuedWork) *B)> Predicate )


className: FThreadPoolPriorityQueue

description: This class is NOT thread-safe and must be properly protected.

code: class FThreadPoolPriorityQueue


description:
Compresses an image
true if the image was compressed successfully, otherwise false if an error occurred

code: bool CompressImage ( const [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & InUncompressedData, const int32 InWidth, const int32 InHeight, [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & OutCompressedData )


description:
Decompresses an image
true if the image was decompressed successfully, otherwise false if an error occurred

code: bool DecompressImage ( const [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & InCompressedData, const int32 InWidth, const int32 InHeight, [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & OutUncompressedData )


description:
Get name of compressor
Name of thumbnail compressor


description:
Is lossless compression
true if compression is lossless

code: bool IsLosslessCompression() const


className: FThumbnailCompressionInterface

description: Thumbnail compression interface for packages. The engine registers a class that can compress and decompress thumbnails that the package linker uses while loading and saving data.

code: class FThumbnailCompressionInterface


description: Create aFTimecodefrom a specific frame number at the given frame rate.

code: static [FTimecode](API\Runtime\Core\Misc\FTimecode) FromFrameNumber ( const [FFrameNumber](API\Runtime\Core\Misc\FFrameNumber) & InFrameNumber, const [FFrameRate](API\Runtime\Core\Misc\FFrameRate) & InFrameRate )


description: Create aFTimecodefrom a specific frame number at the given frame rate. Optionally supports creating a drop frame timecode, which drops certain timecode display numbers to help account for NTSC frame rates which are fractional.

code: static [FTimecode](API\Runtime\Core\Misc\FTimecode) FromFrameNumber ( const [FFrameNumber](API\Runtime\Core\Misc\FFrameNumber) & InFrameNumber, const [FFrameRate](API\Runtime\Core\Misc\FFrameRate) & InFrameRate, bool InbDropFrame )


description: Create aFTimecodefrom a timespan at the given frame rate.

code: static [FTimecode](API\Runtime\Core\Misc\FTimecode) FromTimespan ( const [FTimespan](API\Runtime\Core\Misc\FTimespan) & InTimespan, const [FFrameRate](API\Runtime\Core\Misc\FFrameRate) & InFrameRate, bool InbRollover )


description: Create aFTimecodefrom a timespan at the given frame rate. Optionally supports creating a drop frame timecode, which drops certain timecode display numbers to help account for NTSC frame rates which are fractional.

code: static [FTimecode](API\Runtime\Core\Misc\FTimecode) FromTimespan ( const [FTimespan](API\Runtime\Core\Misc\FTimespan) & InTimespan, const [FFrameRate](API\Runtime\Core\Misc\FFrameRate) & InFrameRate, bool InbDropFrame, bool InbRollover )


description: Drop frame is only support for frame rate of 29.97 or 59.94.

code: static bool IsDropFormatTimecodeSupported ( const [FFrameRate](API\Runtime\Core\Misc\FFrameRate) & InFrameRate )


description: Drop frame timecode is only supported for NTSC_30 (29.97 FPS) or NTSC_60 (59.94 FPS) frame rates.

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


description: Converts this Timecode back into a Frame Number at the given framerate, taking into account if this is a drop-frame format timecode.

code: [FFrameNumber](API\Runtime\Core\Misc\FFrameNumber) ToFrameNumber ( const [FFrameRate](API\Runtime\Core\Misc\FFrameRate) & InFrameRate ) const


description: Get the Qualified Timecode formatted in HH:MM:SS:FF or HH:MM:SS;FF depending on if this represents drop-frame timecode or not.

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


description: Converts this Timecode back into a timespan at the given framerate, taking into account if this is a drop-frame format timecode.

code: [FTimespan](API\Runtime\Core\Misc\FTimespan) ToTimespan ( const [FFrameRate](API\Runtime\Core\Misc\FFrameRate) & InFrameRate ) const


description: If the frame rate support drop frame format and the app wish to use drop frame format by default.

code: static bool UseDropFormatTimecode ( const [FFrameRate](API\Runtime\Core\Misc\FFrameRate) & InFrameRate )


description: Bydefault, should we generate a timecode in drop frame format when the frame rate does support it.


description: Default construction forUObjectpurposes

code: FTimecode()


description: Be aware that the Cycles may not correspond to the System Time. SeeFDateTimeand "leap seconds".

code: FTimecode ( double InSeconds, const [FFrameRate](API\Runtime\Core\Misc\FFrameRate) & InFrameRate, bool InbRollover )


code: FTimecode ( double InSeconds, const [FFrameRate](API\Runtime\Core\Misc\FFrameRate) & InFrameRate, bool InbDropFrame, bool InbRollover )


className: FTimecode

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

code: struct FTimecode

bDropFrameFormat

description: If true, this Timecode represents a Drop Frame timecode used to account for fractional frame rates in NTSC play rates.

Frames

description: How many frames does this timecode represent

Hours

description: How many hours does this timecode represent

Minutes

description: How many minutes does this timecode represent

Seconds

description: How many seconds does this timecode represent


description: User construction from a number of hours minutes seconds and frames.

code: FTimecode ( int32 InHours, int32 InMinutes, int32 InSeconds, int32 InFrames, bool InbDropFrame )


description: Intended for use in waiting functions, e.g. `FEvent::Wait()_ returns the whole number (rounded up) of remaining milliseconds, clamped into [0, MAX_uint32] range


className: FTimeout::operator bool

code: operator bool() const


code: FTimeout ( [FTimespan](API\Runtime\Core\Misc\FTimespan) Value )


className: FTimeout

description: FTimeoutTimeout(FTimespan::FromMilliseconds(2)); while (!Timeout) { ... }

code: class FTimeout


description: Assign the specified components to this time span.

code: void Assign ( int32 Days, int32 Hours, int32 Minutes, int32 Seconds, int32 FractionNano )


description: ImportTextItem

code: bool ExportTextItem ( [FString](API\Runtime\Core\Containers\FString) & ValueStr, [FTimespan](API\Runtime\Core\Misc\FTimespan) const & DefaultValue, [UObject](API\Runtime\CoreUObject\UObject\UObject) * Parent, int32 PortFlags, [UObject](API\Runtime\CoreUObject\UObject\UObject) * ExportRootScope ) const


description: FromSeconds

code: static [FTimespan](API\Runtime\Core\Misc\FTimespan) FromDays ( double Days )


description: FromSeconds

code: static [FTimespan](API\Runtime\Core\Misc\FTimespan) FromHours ( double Hours )


description: FromMilliseconds

code: static [FTimespan](API\Runtime\Core\Misc\FTimespan) FromMicroseconds ( double Microseconds )


description: FromSeconds

code: static [FTimespan](API\Runtime\Core\Misc\FTimespan) FromMilliseconds ( double Milliseconds )


description: FromSeconds

code: static [FTimespan](API\Runtime\Core\Misc\FTimespan) FromMinutes ( double Minutes )


description: FromMinutes

code: static [FTimespan](API\Runtime\Core\Misc\FTimespan) FromSeconds ( double Seconds )


description:
Get the days component of this time span.
Days component.

code: int32 GetDays() const


description: MinValue


description: GetTotalMicroseconds

code: int32 GetFractionMicro() const


description: GetTotalMilliseconds

code: int32 GetFractionMilli() const


description:
Gets the fractional seconds (in nanosecond resolution).
Number of nanoseconds in fractional part.

code: int32 GetFractionNano() const


description:
Gets the fractional ticks (in 100 nanosecond resolution).
Number of ticks in fractional part.

code: int32 GetFractionTicks() const


description: GetTotalHours

code: int32 GetHours() const


description: GetTotalSeconds

code: int32 GetSeconds() const


description: GetTotalMinutes

code: int32 GetMinutes() const


description:
Get the number of ticks represented by this time span.
Number of ticks.

code: int64 GetTicks() const


description: GetDays

code: double GetTotalDays() const


description: GetFractionMicro

code: double GetTotalMicroseconds() const


description: GetFractionMilli

code: double GetTotalMilliseconds() const


description: GetMinutes

code: double GetTotalMinutes() const


description: ExportTextItem

code: bool ImportTextItem ( const TCHAR *& Buffer, int32 PortFlags, [UObject](API\Runtime\CoreUObject\UObject\UObject) * Parent, [FOutputDevice](API\Runtime\Core\Misc\FOutputDevice) * ErrorText )


description: Zero

code: bool IsZero() const


description: Zero


description: ZeroValue


description: Serializes this date and time for network transmission

code: bool NetSerialize ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar, class [UPackageMap](API\Runtime\CoreUObject\UObject\UPackageMap) * Map, bool & bOutSuccess )


description:
Return the result of adding the given time span to this time span.
A time span whose value is the sum of this time span and the given time span.

code: [FTimespan](API\Runtime\Core\Misc\FTimespan) operator+ ( const [FTimespan](API\Runtime\Core\Misc\FTimespan) & Other ) const


description:
Adds the given time span to this time span.
This time span.

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


description:
Check whether this time span is greater than the given time span.
true if this time span is greater, false otherwise.

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


description:
Compare this time span with the given time span for equality.
true if the time spans are equal, false otherwise.

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


description: GetSeconds

code: double GetTotalSeconds() const


description:
Check whether this time span is greater than or equal to the given time span.
true if this time span is greater or equal, false otherwise.

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


description:
Check whether this time span is less than the given time span.
true if this time span is less, false otherwise.

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


description: GetHours

code: double GetTotalHours() const


description:
Check whether this time span is less than or equal to the given time span.
true if this time span is less or equal, false otherwise.

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


description:
Compare this time span with the given time span for inequality.
true if the time spans are not equal, false otherwise.

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


description:
Return the result of dividing the this time span by the given scalar.
A time span whose value is the quotient of this time span and the given scalar.

code: [FTimespan](API\Runtime\Core\Misc\FTimespan) operator/ ( double Scalar ) const


description:
Divide this time span by the given scalar.
This time span.

code: [FTimespan](API\Runtime\Core\Misc\FTimespan) & operator/= ( double Scalar )


description:
Return the result of calculating the modulus of this time span with another time span.
A time span representing the remainder of the modulus operation.

code: [FTimespan](API\Runtime\Core\Misc\FTimespan) operator% ( const [FTimespan](API\Runtime\Core\Misc\FTimespan) & Other ) const


description:
Calculate this time span modulo another.
This time span.

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


description:
Return the result of multiplying the this time span with the given scalar.
A time span whose value is the product of this time span and the given scalar.

code: [FTimespan](API\Runtime\Core\Misc\FTimespan) operator* ( double Scalar ) const


description:
The value of this time span must be greater thanFTimespan::MinValue(), or else an overflow will occur.
Inverse of this time span.


description:
Multiply this time span with the given scalar.
This time span.

code: [FTimespan](API\Runtime\Core\Misc\FTimespan) & operator*= ( double Scalar )


description:
Return the result of subtracting the given time span from this time span.
A time span whose value is the difference of this time span and the given time span.

code: [FTimespan](API\Runtime\Core\Misc\FTimespan) operator- ( const [FTimespan](API\Runtime\Core\Misc\FTimespan) & Other ) const


description:
Subtract the given time span from this time span.
This time span.

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


description: ToString

code: static bool Parse ( const [FString](API\Runtime\Core\Containers\FString) & TimespanString, [FTimespan](API\Runtime\Core\Misc\FTimespan) & OutTimespan )


description:
Ratio between two time spans (handles zero values).
The quotient, i.e. Dividend / Divisor.

code: static double Ratio ( [FTimespan](API\Runtime\Core\Misc\FTimespan) Dividend, [FTimespan](API\Runtime\Core\Misc\FTimespan) Divisor )


description: Parse


description:
Serialize this time span from or into the specified archive.
true on success, false otherwise.

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


description: Parse

code: [FString](API\Runtime\Core\Containers\FString) ToString ( const TCHAR * Format ) const


description: MinValue


description: Default constructor (zero initialization).

code: FTimespan()


description: Zero

code: FTimespan ( int64 InTicks )


description: FromSeconds

code: FTimespan ( int32 Hours, int32 Minutes, int32 Seconds )


description: FromSeconds

code: FTimespan ( int32 Days, int32 Hours, int32 Minutes, int32 Seconds )


description: Create and initialize a new time interval with the specified number of days, hours, minutes and seconds.

code: FTimespan ( int32 Days, int32 Hours, int32 Minutes, int32 Seconds, int32 FractionNano )


className: FTimespan

description: FDateTime

code: struct FTimespan


code: static bool FromCStringAnsi ( const ANSICHAR * String )


code: static bool FromCStringUtf8 ( const [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * String )


code: static bool FromCStringWide ( const WIDECHAR * String )


className: FToBoolHelper

description: Helper class used to convert CString into a boolean value.

code: struct FToBoolHelper