className: EAssumeOwnershipTag

code: enum EAssumeOwnershipTag { AssumeOwnership, }


module: Core

code: bool operator!= ( const [FIoBuffer](API\Runtime\Core\IO\FIoBuffer) & Rhs ) const


description:
NOTE: It is only valid to call this if theFIoBuffercurrently owns the internal memory allocation, as the point of the call is to take ownership of it. If theFIoBufferis only wrapping the allocation then it will return a failedFIoStatusinstead.
A status wrapper around the memory pointer. Even if the status is valid the pointer might still be null.

code: [TIoStatusOr](API\Runtime\Core\IO\TIoStatusOr)< uint8 * > Release()


code: CORE_API FIoBuffer ( [EAssumeOwnershipTag](API\Runtime\Core\IO\FIoBuffer\EAssumeOwnershipTag), FMemoryView Memory )


code: CORE_API FIoBuffer ( [EWrapTag](API\Runtime\Core\IO\FIoBuffer\EWrapTag), const void * Data, uint64 InSize )


code: CORE_API FIoBuffer ( FMemoryView Memory, const [FIoBuffer](API\Runtime\Core\IO\FIoBuffer) & OuterBuffer )


code: CORE_API FIoBuffer ( [ECloneTag](API\Runtime\Core\IO\FIoBuffer\ECloneTag), FMemoryView Memory )


code: CORE_API FIoBuffer ( [EWrapTag](API\Runtime\Core\IO\FIoBuffer\EWrapTag), FMemoryView Memory )


code: CORE_API FIoBuffer ( const void * Data, uint64 InSize, const [FIoBuffer](API\Runtime\Core\IO\FIoBuffer) & OuterBuffer )


code: CORE_API FIoBuffer ( [EAssumeOwnershipTag](API\Runtime\Core\IO\FIoBuffer\EAssumeOwnershipTag), const void * Data, uint64 InSize )


code: CORE_API FIoBuffer ( [ECloneTag](API\Runtime\Core\IO\FIoBuffer\ECloneTag), const void * Data, uint64 InSize )


className: FIoBuffer

description: Reference to buffer data used by I/O dispatcher APIs

code: class FIoBuffer


className: FIoChunkDecodingParams

description: Parameters for decoding a set of encoded blocks(s).

code: struct FIoChunkDecodingParams : public [FIoChunkEncodingParams](API\Runtime\Core\IO\FIoChunkEncodingParams)

EncodedBlockSize

type: TConstArrayView...


code: static bool Decode ( const [FIoChunkDecodingParams](API\Runtime\Core\IO\FIoChunkDecodingParams) & Params, FMemoryView EncodedBlocks, FMutableMemoryView OutRawData )


code: static bool Decode ( FMemoryView EncodedData, [FName](API\Runtime\Core\UObject\FName) CompressionFormat, FMemoryView EncryptionKey, FMutableMemoryView OutRawData, uint64 Offset )


className: DefaultBlockSize

code: static constexpr uint32 DefaultBlockSize = (64 << 10);


code: static bool Encode ( const [FIoChunkEncodingParams](API\Runtime\Core\IO\FIoChunkEncodingParams) & Params, FMemoryView RawData, [FIoBuffer](API\Runtime\Core\IO\FIoBuffer) & OutEncodedData )


code: static bool Encode ( const [FIoChunkEncodingParams](API\Runtime\Core\IO\FIoChunkEncodingParams) & Params, FMemoryView RawData, [FIoBuffer](API\Runtime\Core\IO\FIoBuffer) & OutHeader, [FIoBuffer](API\Runtime\Core\IO\FIoBuffer) & OutEncodedBlocks )


className: ExpectedMagic

code: static constexpr uint32 ExpectedMagic = 0x2e696f;


code: static const FHeader &42; Decode &40; FMemoryView HeaderData &41;


code: TConstArrayView< uint32 > GetBlocks&40;&41; const


code: uint64 GetTotalHeaderSize&40;&41; const


className: FHeader

description: Header describing the encoded I/O chunk.

code: struct FHeader

BlockSizeExponent

type: uint64:  8


code: static [TIoStatusOr](API\Runtime\Core\IO\TIoStatusOr)< FIoOffsetAndLength > GetChunkRange ( const [FIoChunkDecodingParams](API\Runtime\Core\IO\FIoChunkDecodingParams) & Params, uint64 RawSize )


code: static [TIoStatusOr](API\Runtime\Core\IO\TIoStatusOr)< FIoOffsetAndLength > GetChunkRange ( uint64 TotalRawSize, uint32 RawBlockSize, TConstArrayView< uint32 > EncodedBlockSize, uint64 RawOffset, uint64 RawSize )


code: static uint64 GetTotalEncodedSize ( TConstArrayView< uint32 > EncodedBlockSize )


code: static [FIoStatus](API\Runtime\Core\IO\FIoStatus) HashBlocks ( const [FHeader](API\Runtime\Core\IO\FIoChunkEncoding\FHeader) & Header, FMemoryView EncodedData, [TArray](API\Runtime\Core\Containers\TArray)< [FIoHash](API\Runtime\Core\IO\FIoHash) > & OutHashes )


className: MaxSize

code: static constexpr uint64 MaxSize = (uint64(1) << 40);


className: MaxBlockCount

code: static constexpr uint32 MaxBlockCount = (1 << 24);


className: FIoChunkEncoding

description: Encodes data into a set of encrypted and compressed blocks. The chunk encoding information is enocoded into a 16 byte header followed by N block sizes.

code: class FIoChunkEncoding


className: FIoChunkEncodingParams

description: Defines how the I/O chunk gets encoded into a set of compressed and encrypted block(s).

code: struct FIoChunkEncodingParams

CompressionFormat

type: FName

EncryptionKey

type: FMemoryView


code: static [FIoChunkHash](API\Runtime\Core\IO\FIoChunkHash) CreateFromIoHash ( const [FIoHash](API\Runtime\Core\IO\FIoHash) & IoHash )


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


code: bool operator== ( const [FIoChunkHash](API\Runtime\Core\IO\FIoChunkHash) & Rhs ) const


code: bool operator!= ( const [FIoChunkHash](API\Runtime\Core\IO\FIoChunkHash) & Rhs ) const


description:
Creates an I/O chunk ID from a 24 character long hexadecimal string.
The corresponding I/O chunk ID or an invalid ID if the input string is not in the correct format.

code: static [FIoChunkId](API\Runtime\Core\IO\FIoChunkId) FromHex ( FStringView Hex )


className: InvalidChunkId

code: static const [FIoChunkId](API\Runtime\Core\IO\FIoChunkId) InvalidChunkId = FIoChunkId::CreateEmptyId();


code: bool operator== ( const [FIoChunkId](API\Runtime\Core\IO\FIoChunkId) & Rhs ) const


code: bool operator!= ( const [FIoChunkId](API\Runtime\Core\IO\FIoChunkId) & Rhs ) const


code: void Set ( const void * InIdPtr, SIZE_T InSize )


code: void ToString ( [FString](API\Runtime\Core\Containers\FString) & Output ) const


className: FIoChunkId

description: Identifier to a chunk of data.

code: class FIoChunkId


className: Signature

code: enum { Signature = 0x496f436e }


className: FIoContainerHeader

code: struct FIoContainerHeader

ContainerId

type: FIoContainerId

LocalizedPackages

type: TArray<FIoCont...

OptionalSegmentPackageIds

type: TArray<FPackag...

OptionalSegmentStoreEntries

type: TArray< uint8 >

RedirectsNameMap

type: TArray<FDispla...


className: FIoContainerHeaderLocalizedPackage

SourcePackageId

type: FPackageId

SourcePackageName

type: FMappedName


className: FIoContainerHeaderPackageRedirect


code: static [FIoContainerId](API\Runtime\Core\IO\FIoContainerId) FromName ( const [FName](API\Runtime\Core\UObject\FName) & Name )


className: InvalidId

code: static constexpr uint64 InvalidId = uint64(-1);


code: [FIoContainerId](API\Runtime\Core\IO\FIoContainerId) & operator= ( const [FIoContainerId](API\Runtime\Core\IO\FIoContainerId) & Other )


code: bool operator== ( [FIoContainerId](API\Runtime\Core\IO\FIoContainerId) Other ) const


code: bool operator< ( [FIoContainerId](API\Runtime\Core\IO\FIoContainerId) Other ) const


code: bool operator!= ( [FIoContainerId](API\Runtime\Core\IO\FIoContainerId) Other ) const


code: FIoContainerId ( const [FIoContainerId](API\Runtime\Core\IO\FIoContainerId) & Other )


code: FIoContainerId &40; const uint64 InId &41;


code: FIoContainerId ( [FIoContainerId](API\Runtime\Core\IO\FIoContainerId) && Other )


className: FIoContainerId

description: Container ID.

code: class FIoContainerId


className: FIoContainerSettings

code: struct FIoContainerSettings

bGenerateDiffPatch

type: bool

ContainerFlags

type: EIoContainerFla...

EncryptionKeyGuid

type: FGuid

SigningKey

type: FRSAKeyHandle


code: static [FIoDirectoryIndexHandle](API\Runtime\Core\IO\FIoDirectoryIndexHandle) FromIndex ( uint32 Index )


className: InvalidHandle

code: static constexpr uint32 InvalidHandle = ~uint32(0);


code: bool operator== ( [FIoDirectoryIndexHandle](API\Runtime\Core\IO\FIoDirectoryIndexHandle) Other ) const


code: bool operator< ( [FIoDirectoryIndexHandle](API\Runtime\Core\IO\FIoDirectoryIndexHandle) Other ) const


className: RootHandle

code: static constexpr uint32 RootHandle = 0;


code: FIoDirectoryIndexHandle &40; uint32 InHandle &41;


className: FIoDirectoryIndexHandle

code: class FIoDirectoryIndexHandle


code: [FIoDirectoryIndexHandle](API\Runtime\Core\IO\FIoDirectoryIndexHandle) GetChildDirectory ( [FIoDirectoryIndexHandle](API\Runtime\Core\IO\FIoDirectoryIndexHandle) Directory ) const


code: FStringView GetDirectoryName ( [FIoDirectoryIndexHandle](API\Runtime\Core\IO\FIoDirectoryIndexHandle) Directory ) const


code: [FIoDirectoryIndexHandle](API\Runtime\Core\IO\FIoDirectoryIndexHandle) GetFile ( [FIoDirectoryIndexHandle](API\Runtime\Core\IO\FIoDirectoryIndexHandle) Directory ) const


code: FStringView GetFileName ( [FIoDirectoryIndexHandle](API\Runtime\Core\IO\FIoDirectoryIndexHandle) File ) const


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


code: [FIoDirectoryIndexHandle](API\Runtime\Core\IO\FIoDirectoryIndexHandle) GetNextDirectory ( [FIoDirectoryIndexHandle](API\Runtime\Core\IO\FIoDirectoryIndexHandle) Directory ) const


code: [FIoDirectoryIndexHandle](API\Runtime\Core\IO\FIoDirectoryIndexHandle) GetNextFile ( [FIoDirectoryIndexHandle](API\Runtime\Core\IO\FIoDirectoryIndexHandle) File ) const


code: [FIoStatus](API\Runtime\Core\IO\FIoStatus) Initialize ( [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & InBuffer, [FAES::FAESKey](API\Runtime\Core\Misc\FAES\FAESKey) InDecryptionKey )


code: bool IterateDirectoryIndex ( [FIoDirectoryIndexHandle](API\Runtime\Core\IO\FIoDirectoryIndexHandle) Directory, const [FString](API\Runtime\Core\Containers\FString) & Path, FDirectoryIndexVisitorFunction Visit ) const


code: uint32 GetFileData ( [FIoDirectoryIndexHandle](API\Runtime\Core\IO\FIoDirectoryIndexHandle) File ) const


code: FIoDirectoryIndexReader &40; FIoDirectoryIndexReader && &41;


code: FIoDirectoryIndexReader &40; const FIoDirectoryIndexReader & &41;


className: FIoDirectoryIndexReader

code: class FIoDirectoryIndexReader


description: Polling methods.

code: bool DoesChunkExist ( const [FIoChunkId](API\Runtime\Core\IO\FIoChunkId) & ChunkId ) const


className: FIoContainerMountedEvent

code: class FIoContainerMountedEvent : public TBaseMulticastDelegate_OneParam< void, const FIoDispatcherMountedContainer & >


className: FIoContainerUnmountedEvent

code: class FIoContainerUnmountedEvent : public TBaseMulticastDelegate_OneParam< void, const FIoDispatcherMountedContainer & >


code: static [FIoDispatcher](API\Runtime\Core\IO\FIoDispatcher) & Get()


code: [TIoStatusOr](API\Runtime\Core\IO\TIoStatusOr)< uint64 > GetSizeForChunk ( const [FIoChunkId](API\Runtime\Core\IO\FIoChunkId) & ChunkId ) const


code: static void InitializePostSettings()


code: void Mount ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IIoDispatcherBackend](API\Runtime\Core\IO\IIoDispatcherBackend) > Backend, int32 Priority )


description: Events.


code: [FIoDispatcher](API\Runtime\Core\IO\FIoDispatcher) & operator= ( const [FIoDispatcher](API\Runtime\Core\IO\FIoDispatcher) & )


code: [TIoStatusOr](API\Runtime\Core\IO\TIoStatusOr)< [FIoMappedRegion](API\Runtime\Core\IO\FIoMappedRegion) > OpenMapped ( const [FIoChunkId](API\Runtime\Core\IO\FIoChunkId) & ChunkId, const [FIoReadOptions](API\Runtime\Core\IO\FIoReadOptions) & Options )


code: FIoDispatcher ( const [FIoDispatcher](API\Runtime\Core\IO\FIoDispatcher) & )


className: FIoDispatcher

description: I/O dispatcher

code: class FIoDispatcher


className: FIoDispatcherMountedContainer

code: struct FIoDispatcherMountedContainer

Environment

type: FIoStoreEnviron...


className: FIoDispatcherBackendContext

code: struct FIoDispatcherBackendContext

SignatureErrorDelegate

type: FIoSignatureErr...

WakeUpDispatcherThreadDelegate

type: FWakeUpIoDispat...


className: ByteArray

code: typedef uint8[20] ByteArray


description: Returns a reference to the raw byte array for the hash.


description: Construct a hash from a view of 20 bytes.

code: static [FIoHash](API\Runtime\Core\IO\FIoHash) FromView ( FMemoryView Hash )


code: const [ByteArray](API\Runtime\Core\IO\FIoHash\ByteArray) & GetBytes() const


description: Calculate the hash of the buffer.

code: static [FIoHash](API\Runtime\Core\IO\FIoHash) HashBuffer ( FMemoryView View )


description: Calculate the hash of the buffer.

code: static [FIoHash](API\Runtime\Core\IO\FIoHash) HashBuffer ( const [FCompositeBuffer](API\Runtime\Core\Memory\FCompositeBuffer) & Buffer )


description: Calculate the hash of the buffer.

code: static [FIoHash](API\Runtime\Core\IO\FIoHash) HashBuffer ( const void * Data, uint64 Size )


description: Returns whether this is a zero hash.

code: bool IsZero() const


description: Reset this to a zero hash.

code: void Reset()


className: Zero

description: A zero hash.

code: static const [FIoHash](API\Runtime\Core\IO\FIoHash) Zero;


description: Construct a zero hash.

code: FIoHash()


description: Construct a hash from an array of 20 bytes.

code: FIoHash ( const [ByteArray](API\Runtime\Core\IO\FIoHash\ByteArray) & Hash )


description: Construct a hash from a BLAKE3-256 hash.

code: FIoHash ( const [FBlake3Hash](API\Runtime\Core\Hash\FBlake3Hash) & Hash )


description: Construct a hash from a 40-character hex string.

code: FIoHash ( FAnsiStringView HexHash )


description: Construct a zero hash.

code: FIoHash ( FWideStringView HexHash )


description: Construct a zero hash.

code: FIoHash ( FUtf8StringView HexHash )


className: FIoHash

description: When the data to hash is not in a contiguous region of memory, useFIoHashBuilderto hash data in blocks with FIoHashBuilder::Update(Block) followed byFIoHashBuilder::Finalize().

code: struct FIoHash


description: May be called any number of times, and more input may be added after.


className: FIoHashBuilder

description: Calculates a BLAKE3-160 hash.

code: class FIoHashBuilder : public [FBlake3](API\Runtime\Core\Hash\FBlake3)


className: FIoMappedRegion

description: Mapped region.

code: struct FIoMappedRegion

MappedFileHandle

type: IMappedFileHand...

MappedFileRegion

type: IMappedFileRegi...


code: void SetRange ( uint64 Offset, uint64 Size )


code: void SetTargetVa ( void * InTargetVa )


code: FIoReadOptions ( uint64 InOffset, uint64 InSize )


code: FIoReadOptions ( uint64 InOffset, uint64 InSize, void * InTargetVa )


code: const [FIoBuffer](API\Runtime\Core\IO\FIoBuffer) * GetResult() const


code: const [FIoBuffer](API\Runtime\Core\IO\FIoBuffer) & GetResultOrDie() const


code: [FIoRequest](API\Runtime\Core\IO\FIoRequest) & operator= ( const [FIoRequest](API\Runtime\Core\IO\FIoRequest) & Other )


code: [FIoRequest](API\Runtime\Core\IO\FIoRequest) & operator= ( [FIoRequest](API\Runtime\Core\IO\FIoRequest) && Other )


code: void UpdatePriority ( uint32 NewPriority )


code: FIoRequest ( const [FIoRequest](API\Runtime\Core\IO\FIoRequest) & Other )


code: FIoRequest ( [FIoRequest](API\Runtime\Core\IO\FIoRequest) && Other )


code: FIoRequest &40; FIoRequestImpl &42; InImpl &41;


code: void SetResult ( [FIoBuffer](API\Runtime\Core\IO\FIoBuffer) InBuffer )


code: FIoRequestImpl ( class FIoRequestAllocator & InAllocator )


className: FIoRequestImpl

code: class FIoRequestImpl : private [UE::FInheritedContextBase](API\Runtime\Core\Async\FInheritedContextBase)

BackendData

type: void *

ChunkId

type: FIoChunkId

NextRequest

type: FIoRequestImpl...

Options

type: FIoReadOptions


className: FIoSignatureErrorEvent

code: struct FIoSignatureErrorEvent

CriticalSection

type: FCriticalSectio...


className: FIoSignatureError

code: struct FIoSignatureError

ActualHash

type: FSHAHash

ContainerName

type: FString


className: Invalid

code: static const [FIoStatus](API\Runtime\Core\IO\FIoStatus) Invalid { EIoErrorCode::InvalidCode, TEXT("Invalid Code") };


className: MaxErrorMessageLength

code: static constexpr int32 MaxErrorMessageLength = 128;


className: Ok

code: static const [FIoStatus](API\Runtime\Core\IO\FIoStatus) Ok { EIoErrorCode::Ok, TEXT("OK") };


code: [FIoStatus](API\Runtime\Core\IO\FIoStatus) & operator= ( const [FIoStatus](API\Runtime\Core\IO\FIoStatus) & Other )


code: [FIoStatus](API\Runtime\Core\IO\FIoStatus) & operator= ( const EIoErrorCode InErrorCode )


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


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


className: Unknown

code: static const [FIoStatus](API\Runtime\Core\IO\FIoStatus) Unknown { EIoErrorCode::Unknown, TEXT("Unknown Status") };


code: CORE_API FIoStatus ( EIoErrorCode Code )


code: CORE_API FIoStatus ( EIoErrorCode Code, const FStringView & InErrorMessage )


className: FIoStatus

description: I/O status with error code and message.

code: class FIoStatus


className: FIoStatusBuilder::operator FIoStatus

code: CORE_API operator FIoStatus()


code: [FIoStatusBuilder](API\Runtime\Core\IO\FIoStatusBuilder) & operator<< ( FStringView String )


code: FIoStatusBuilder ( EIoErrorCode StatusCode )


code: CORE_API FIoStatusBuilder ( const [FIoStatus](API\Runtime\Core\IO\FIoStatus) & InStatus, FStringView String )


className: FIoStatusBuilder

description: Helper to make it easier to generate meaningful error messages.

code: class FIoStatusBuilder


className: FIoStoreCompressedBlockInfo

code: struct FIoStoreCompressedBlockInfo

AlignedSize

description: The size of the data this block takes in IoBuffer (i.e. after padding for decryption)

CompressedSize

description: The size of relevant data in the block (i.e. what you pass to decompress)

CompressionMethod

type: FName

OffsetInBuffer

description: Where in IoBuffer this block starts.

UncompressedSize

description: The size of theblockafter decompression. This is not adjusted for anyFIoReadOptionsused.


className: FIoStoreCompressedReadResult

code: struct FIoStoreCompressedReadResult

Blocks

type: TArray<FIoStor...

IoBuffer

type: FIoBuffer

TotalCompressedSize

description: This is the total size of compressed data, which is less than IoBuffer size due to padding for decryption.

UncompressedOffset

description: There is where the data starts in IoBuffer (for when you pass in a data range viaFIoReadOptions)

description: This is the total size requested viaFIoReadOptions.


code: void InitializeFileEnvironment ( FStringView InPath, int32 InOrder )


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


className: FIoStoreEnvironment

description: Helper used to manage creation of I/O store file handles etc

code: class FIoStoreEnvironment


code: void EnumerateChunks ( [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< bool([FIoStoreTocChunkInfo](API\Runtime\Core\IO\FIoStoreTocChunkInfo) &&)> && Callback ) const


code: void EnumerateCompressedBlocks ( [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< bool(const [FIoStoreTocCompressedBlockInfo](API\Runtime\Core\IO\FIoStoreTocCompressedBlockInfo) &)> && Callback ) const


code: void EnumerateCompressedBlocksForChunk ( const [FIoChunkId](API\Runtime\Core\IO\FIoChunkId) & Chunk, [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< bool(const [FIoStoreTocCompressedBlockInfo](API\Runtime\Core\IO\FIoStoreTocCompressedBlockInfo) &)> && Callback ) const


code: [TIoStatusOr](API\Runtime\Core\IO\TIoStatusOr)< [FIoStoreTocChunkInfo](API\Runtime\Core\IO\FIoStoreTocChunkInfo) > GetChunkInfo ( const uint32 TocEntryIndex ) const


code: [TIoStatusOr](API\Runtime\Core\IO\TIoStatusOr)< [FIoStoreTocChunkInfo](API\Runtime\Core\IO\FIoStoreTocChunkInfo) > GetChunkInfo ( const [FIoChunkId](API\Runtime\Core\IO\FIoChunkId) & Chunk ) const


code: uint32 GetCompressionBlockSize() const


code: const [TArray](API\Runtime\Core\Containers\TArray)< [FName](API\Runtime\Core\UObject\FName) > & GetCompressionMethods() const


code: const [FIoDirectoryIndexReader](API\Runtime\Core\IO\FIoDirectoryIndexReader) & GetDirectoryIndexReader() const


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


code: void GetFilenamesByBlockIndex ( const [TArray](API\Runtime\Core\Containers\TArray)< int32 > & InBlockIndexList, [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & OutFileList ) const


code: [FIoStatus](API\Runtime\Core\IO\FIoStatus) Initialize ( const TCHAR * ContainerPath, const [TMap](API\Runtime\Core\Containers\TMap)< [FGuid](API\Runtime\Core\Misc\FGuid), [FAES::FAESKey](API\Runtime\Core\Misc\FAES\FAESKey) > & InDecryptionKeys )


description: Reads the chunk off the disk, decrypting/decompressing as necessary.

code: [TIoStatusOr](API\Runtime\Core\IO\TIoStatusOr)< [FIoBuffer](API\Runtime\Core\IO\FIoBuffer) > Read ( const [FIoChunkId](API\Runtime\Core\IO\FIoChunkId) & Chunk, const [FIoReadOptions](API\Runtime\Core\IO\FIoReadOptions) & Options ) const


description: AsRead(), except returns a task that will contain the result after a .Wait/.BusyWait.

code: [UE::Tasks::TTask](API\Runtime\Core\Tasks\TTask)< [TIoStatusOr](API\Runtime\Core\IO\TIoStatusOr)< [FIoBuffer](API\Runtime\Core\IO\FIoBuffer) > > ReadAsync ( const [FIoChunkId](API\Runtime\Core\IO\FIoChunkId) & Chunk, const [FIoReadOptions](API\Runtime\Core\IO\FIoReadOptions) & Options ) const


description: Reads and decrypts if necessary the compressed blocks, but doesnotdecompress them. The totality of the data is stored in FIoStoreCompressedReadResult::FIoBuffer as a contiguous buffer, however each block is padded during encryption, so either useFIoStoreCompressedBlockInfo::AlignedSizeto advance through the buffer, or useFIoStoreCompressedBlockInfo::OffsetInBufferdirectly.

code: [TIoStatusOr](API\Runtime\Core\IO\TIoStatusOr)< [FIoStoreCompressedReadResult](API\Runtime\Core\IO\FIoStoreCompressedReadResult) > ReadCompressed ( const [FIoChunkId](API\Runtime\Core\IO\FIoChunkId) & Chunk, const [FIoReadOptions](API\Runtime\Core\IO\FIoReadOptions) & Options, bool bDecrypt ) const


className: FIoStoreTocChunkInfo

code: struct FIoStoreTocChunkInfo

bForceUncompressed

type: bool

ChunkType

type: EIoChunkType

Hash

type: FIoChunkHash


className: FIoStoreTocCompressedBlockInfo

code: struct FIoStoreTocCompressedBlockInfo


code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< class [IIoStoreWriter](API\Runtime\Core\IO\IIoStoreWriter) > CreateContainer ( const TCHAR * InContainerPath, const [FIoContainerSettings](API\Runtime\Core\IO\FIoContainerSettings) & InContainerSettings )


className: FProgress

code: struct FProgress

BeginCompressChunksByType

description: The type of chunk that landed in BeginCompress before any opt-outs.

CompressedChunksCount

description: Number of chunks that were passed to the compressor (i.e. passed the various opt-outs), and their types.

HashDbChunksCount

description: Number of chunks where we avoided reading and hashing, and instead used the result from the hashdb, and their types.

RefDbChunksCount

description: The number of chunk retrieved from the reference cache database, and their types.


code: [FIoStatus](API\Runtime\Core\IO\FIoStatus) Initialize ( const [FIoStoreWriterSettings](API\Runtime\Core\IO\FIoStoreWriterSettings) & InWriterSettings )


className: FIoStoreWriterContext

code: class FIoStoreWriterContext


className: FIoStoreWriterResult

code: struct FIoStoreWriterResult

ContainerFlags

type: EIoContainerFla...

ContainerId

type: FIoContainerId


className: FIoStoreWriterSettings

code: struct FIoStoreWriterSettings


className: FIoWriteOptions

code: struct FIoWriteOptions

DebugName

type: const TCHAR ...


code: static [FPackageId](API\Runtime\Core\IO\FPackageId) FromName ( const [FName](API\Runtime\Core\UObject\FName) & Name )


code: static [FPackageId](API\Runtime\Core\IO\FPackageId) FromValue ( const uint64 Value )


className: InvalidId

code: static constexpr uint64 InvalidId = 0;


code: bool operator== ( [FPackageId](API\Runtime\Core\IO\FPackageId) Other ) const


code: bool operator< ( [FPackageId](API\Runtime\Core\IO\FPackageId) Other ) const


code: bool operator!= ( [FPackageId](API\Runtime\Core\IO\FPackageId) Other ) const


className: FBackendAndPriority

code: typedef [TTuple](API\Runtime\Core\Misc\TTuple)< int32, [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IPackageStoreBackend](API\Runtime\Core\IO\IPackageStoreBackend) >> FBackendAndPriority


code: static [FPackageStore](API\Runtime\Core\IO\FPackageStore) & Get()


description: Returns the redirected package ID and source package name for the specified package ID if it's being redirected.

code: bool GetPackageRedirectInfo ( [FPackageId](API\Runtime\Core\IO\FPackageId) PackageId, [FName](API\Runtime\Core\UObject\FName) & OutSourcePackageName, [FPackageId](API\Runtime\Core\IO\FPackageId) & OutRedirectedToPackageId )


description: Returns the package store entry data with export info and imported packages for the specified package ID.

code: EPackageStoreEntryStatus GetPackageStoreEntry ( [FPackageId](API\Runtime\Core\IO\FPackageId) PackageId, [FPackageStoreEntry](API\Runtime\Core\IO\FPackageStoreEntry) & OutPackageStoreEntry )


description: Mount a package store backend.

code: void Mount ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IPackageStoreBackend](API\Runtime\Core\IO\IPackageStoreBackend) > Backend, int32 Priority )


className: ThreadReadCount

code: static thread_local int32 ThreadReadCount = 0;


className: FPackageStore

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

code: class FPackageStore


className: FPendingEntriesAddedEvent

description: Event broadcasted when pending entries are completed and added to the package store

code: class FPendingEntriesAddedEvent : public TBaseMulticastDelegate_NoParams< void >


className: FPackageStoreBackendContext

code: class FPackageStoreBackendContext

PendingEntriesAdded

type: FPendingEntries...


className: FPackageStoreEntry

description: Package store entry.

code: struct FPackageStoreEntry

ImportedPackageIds

type: TArrayView< con...


code: static [FPackageStoreEntryResource](API\Runtime\Core\IO\FPackageStoreEntryResource) FromCbObject ( const [FCbObject](API\Runtime\Core\Serialization\FCbObject) & Obj )


description: Returns the package ID.


description: Returns whether this package was saved as auto optional

code: bool IsAutoOptional() const


className: FPackageStoreEntryResource

description: This is a non-optimized serializable version of a package store entry. Used when cooking and when running cook-on-the-fly.

code: struct FPackageStoreEntryResource

Flags

type: EPackageStoreEn...

description: The package store entry flags.

type: TArray<FPackag...

description: Imported package IDs.

OptionalSegmentImportedPackageIds

description: Editor data imported package IDs.

PackageId

type: FPackageId

PackageName

description: The package name.

ShaderMapHashes

type: TArray<FSHAHas...

description: Referenced shader map hashes.


code: FPackageStoreReadScope ( [FPackageStore](API\Runtime\Core\IO\FPackageStore) & InPackageStore )


className: FPackageStoreReadScope

code: class FPackageStoreReadScope


code: void CancelIoRequest ( [FIoRequestImpl](API\Runtime\Core\IO\FIoRequestImpl) * Request )


code: bool DoesChunkExist ( const [FIoChunkId](API\Runtime\Core\IO\FIoChunkId) & ChunkId ) const


code: [TIoStatusOr](API\Runtime\Core\IO\TIoStatusOr)< uint64 > GetSizeForChunk ( const [FIoChunkId](API\Runtime\Core\IO\FIoChunkId) & ChunkId ) const


code: void Initialize ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< const [FIoDispatcherBackendContext](API\Runtime\Core\IO\FIoDispatcherBackendContext) > Context )


code: [TIoStatusOr](API\Runtime\Core\IO\TIoStatusOr)< [FIoMappedRegion](API\Runtime\Core\IO\FIoMappedRegion) > OpenMapped ( const [FIoChunkId](API\Runtime\Core\IO\FIoChunkId) & ChunkId, const [FIoReadOptions](API\Runtime\Core\IO\FIoReadOptions) & Options )


code: bool Resolve ( [FIoRequestImpl](API\Runtime\Core\IO\FIoRequestImpl) * Request )


code: void UpdatePriorityForIoRequest ( [FIoRequestImpl](API\Runtime\Core\IO\FIoRequestImpl) * Request )


className: IIoDispatcherBackend

code: struct IIoDispatcherBackend


code: void Append ( const [FIoChunkId](API\Runtime\Core\IO\FIoChunkId) & ChunkId, [IIoStoreWriteRequest](API\Runtime\Core\IO\IIoStoreWriteRequest) * Request, const [FIoWriteOptions](API\Runtime\Core\IO\FIoWriteOptions) & WriteOptions )


code: void Append ( const [FIoChunkId](API\Runtime\Core\IO\FIoChunkId) & ChunkId, [FIoBuffer](API\Runtime\Core\IO\FIoBuffer) Chunk, const [FIoWriteOptions](API\Runtime\Core\IO\FIoWriteOptions) & WriteOptions, uint64 OrderHint )


code: void EnableDiskLayoutOrdering ( const [TArray](API\Runtime\Core\Containers\TArray)< [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< [FIoStoreReader](API\Runtime\Core\IO\FIoStoreReader) >> & PatchSourceReaders )


code: void EnumerateChunks ( [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< bool([FIoStoreTocChunkInfo](API\Runtime\Core\IO\FIoStoreTocChunkInfo) &&)> && Callback ) const


code: void SetHashDatabase ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IIoStoreWriterHashDatabase](API\Runtime\Core\IO\IIoStoreWriterHashDatabase) > HashDatabase, bool bVerifyHashDatabase )


description: If a reference database is provided, the IoStoreWriter implementation may elect to reuse compressed blocks from previous containers instead of recompressing input data. This must be set before any writes are appended.

code: void SetReferenceChunkDatabase ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IIoStoreWriterReferenceChunkDatabase](API\Runtime\Core\IO\IIoStoreWriterReferenceChunkData-) > ReferenceChunkDatabase )


description: Can't be called between PrepareSourceBufferAsync and its completion!

code: void FreeSourceBuffer()


code: [TArrayView](API\Runtime\Core\Containers\TArrayView)< const [FFileRegion](API\Runtime\Core\Serialization\FFileRegion) > GetRegions()


description: Only valid after the completion event passed to PrepareSourceBufferAsync has fired.

code: const [FIoBuffer](API\Runtime\Core\IO\FIoBuffer) * GetSourceBuffer()


description: Launches any async operations necessary in order to access the buffer. CompletionEvent is set once it's ready, which may be immediate.

code: void PrepareSourceBufferAsync ( FGraphEventRef CompletionEvent )


code: bool FindHashForChunkId ( const [FIoChunkId](API\Runtime\Core\IO\FIoChunkId) & ChunkId, [FIoChunkHash](API\Runtime\Core\IO\FIoChunkHash) & OutHash ) const


className: IIoStoreWriteRequest

code: class IIoStoreWriteRequest


code: virtual ~IIoStoreWriterHashDatabase()


className: IIoStoreWriterHashDatabase

description: Allows theIIoStoreWriterto avoid loading and hashing chunks, saving pak/stage time, as the normal process involved loading the chunks, hashing them, freeing them, making some decisions, then loading themagainfor compression/writting. It's completely fine for this to not have all available hashes, but they have to match when provided!

code: class IIoStoreWriterHashDatabase


description: Quick synchronous existence check that returns the number of blocks for the chunk. This is used to set up the necessary structures without needing to read the source data for the chunk.

code: bool ChunkExists ( const TPair< [FIoContainerId](API\Runtime\Core\IO\FIoContainerId), [FIoChunkHash](API\Runtime\Core\IO\FIoChunkHash) > & InChunkKey, uint32 & OutNumChunkBlocks )


description: Returns the compression block size that was used to break up the IoChunks in the source containers. If this is different than what we want, then none of the chunks will ever match. Knowing this up front allows us to only match on hash

code: uint32 GetCompressionBlockSize() const


description: Chunks providedMUSTdecompress to bits that hash to the exact value provided in InChunkKey (i.e. be exactly the same bits), and also be the same number of blocks (i.e. same CompressionBlockSize)

code: bool RetrieveChunk ( const TPair< [FIoContainerId](API\Runtime\Core\IO\FIoContainerId), [FIoChunkHash](API\Runtime\Core\IO\FIoChunkHash) > & InChunkKey, [TUniqueFunction](API\Runtime\Core\Templates\TUniqueFunction)< void([TIoStatusOr](API\Runtime\Core\IO\TIoStatusOr)< [FIoStoreCompressedReadResult](API\Runtime\Core\IO\FIoStoreCompressedReadResult) >)> InCompletionCallback )


description: Called when the loader enters a package store read scope.

code: void BeginRead()


className: IIoStoreWriterReferenceChunkDatabase


description: Called when the loader exits a package store read scope.

code: void EndRead()


code: bool GetPackageRedirectInfo ( [FPackageId](API\Runtime\Core\IO\FPackageId) PackageId, [FName](API\Runtime\Core\UObject\FName) & OutSourcePackageName, [FPackageId](API\Runtime\Core\IO\FPackageId) & OutRedirectedToPackageId )


code: EPackageStoreEntryStatus GetPackageStoreEntry ( [FPackageId](API\Runtime\Core\IO\FPackageId) PackageId, [FPackageStoreEntry](API\Runtime\Core\IO\FPackageStoreEntry) & OutPackageStoreEntry )


description: Called when the backend is mounted

code: void OnMounted ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< const [FPackageStoreBackendContext](API\Runtime\Core\IO\FPackageStoreBackendContext) > Context )


description: Destructor.

code: virtual ~IPackageStoreBackend()


className: IPackageStoreBackend

description: Package store backend interface.

code: class IPackageStoreBackend


code: const T & operator[] ( uint32 Index ) const


className: TFilePackageStoreEntryCArrayView

description: Package store entry array view.

code: template<typename T> class TFilePackageStoreEntryCArrayView


code: [TIoStatusOr](API\Runtime\Core\IO\TIoStatusOr)< T > & operator= ( const [TIoStatusOr](API\Runtime\Core\IO\TIoStatusOr)< T > & Other )


code: [TIoStatusOr](API\Runtime\Core\IO\TIoStatusOr)< T > & operator= ( [TIoStatusOr](API\Runtime\Core\IO\TIoStatusOr)< T > && Other )


code: [TIoStatusOr](API\Runtime\Core\IO\TIoStatusOr)< T > & operator= ( const [FIoStatus](API\Runtime\Core\IO\FIoStatus) & OtherStatus )


code: [TIoStatusOr](API\Runtime\Core\IO\TIoStatusOr)< T > & operator= ( const T & OtherValue )


code: [TIoStatusOr](API\Runtime\Core\IO\TIoStatusOr)< T > & operator= ( T && OtherValue )


code: template<typename U> [TIoStatusOr](API\Runtime\Core\IO\TIoStatusOr)< T > & operator= ( const [TIoStatusOr](API\Runtime\Core\IO\TIoStatusOr)< U > & Other )


code: const [FIoStatus](API\Runtime\Core\IO\FIoStatus) & Status() const


code: TIoStatusOr ( const [TIoStatusOr](API\Runtime\Core\IO\TIoStatusOr) & Other )


code: TIoStatusOr ( [TIoStatusOr](API\Runtime\Core\IO\TIoStatusOr) && Other )


code: TIoStatusOr ( [FIoStatus](API\Runtime\Core\IO\FIoStatus) InStatus )


code: template<typename... ArgTypes> TIoStatusOr ( ArgTypes &&... Args )


code: template<typename U> TIoStatusOr ( const [TIoStatusOr](API\Runtime\Core\IO\TIoStatusOr)< U > & Other )


className: TIoStatusOr

description: Optional I/O result or error status.

code: template<typename T> class TIoStatusOr


className: ElementType

code: typedef OptionalType ElementType


className: bUsingIntrusiveUnsetState

code: static constexpr bool bUsingIntrusiveUnsetState = HasIntrusiveUnsetOptionalState<OptionalType>();


code: template<typename... ArgsType> OptionalType & Emplace ( ArgsType &&... Args )


description: The optional value when set; DefaultValue otherwise.

code: const OptionalType & Get ( const OptionalType & DefaultValue ) const


description: A pointer to the optional value when set, nullptr otherwise.

code: OptionalType * GetPtrOrNull()


code: const OptionalType * GetPtrOrNull() const


description: The optional value; undefined whenIsSet()returns false.

code: OptionalType & GetValue()


code: const OptionalType & GetValue() const


description: true when the value is meaningful; false if callingGetValue()is undefined.

code: bool IsSet() const


code: const OptionalType * operator->() const


className: TOptional::operator bool

code: operator bool() const


code: [TOptional](API\Runtime\Core\IO\TOptional) & operator= ( const [TOptional](API\Runtime\Core\IO\TOptional) & Other )


code: [TOptional](API\Runtime\Core\IO\TOptional) & operator= ( [TOptional](API\Runtime\Core\IO\TOptional) && Other )


code: [TOptional](API\Runtime\Core\IO\TOptional) & operator= ( const OptionalType & InValue )


code: [TOptional](API\Runtime\Core\IO\TOptional) & operator= ( OptionalType && InValue )


code: const OptionalType & operator*() const


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


className: ValueStorageType

code: typedef std::conditional_t< bUsingIntrusiveUnsetState, uint8[sizeof(OptionalType)], [UE::Core::Private::TNonIntrusiveOptionalStorage](API\Runtime\Core\Misc\TNonIntrusiveOptionalStorage)< sizeof(OptionalType)>> ValueStorageType


description: Construct an OptionalType with no value; i.e. unset

code: TOptional()


description: Construct an OptionalType with a valid value.

code: TOptional ( const OptionalType & InValue )


description: Construct an OptionalType with an invalid value.

code: TOptional ( [FNullOpt](API\Runtime\Core\Misc\FNullOpt) )


code: TOptional ( OptionalType && InValue )


description: Copy/Move construction

code: TOptional ( const [TOptional](API\Runtime\Core\IO\TOptional) & Other )


code: TOptional ( [TOptional](API\Runtime\Core\IO\TOptional) && Other )


code: template<typename... ArgTypes> TOptional ( EInPlace, ArgTypes &&... Args )


className: TOptional

description: When we have an optional valueIsSet()returns true, andGetValue()is meaningful. OtherwiseGetValue()is not meaningful.

code: template<typename OptionalType> struct TOptional


description: Enum that defines the verbosity levels of the logging system. Also defines some non-verbosity levels that are hacks that allow breaking on a given log line or setting the color.

code: namespace ELogVerbosity { enum Type { NoLogging = 0, Fatal, Error, Warning, Display, Log, Verbose, VeryVerbose, All = VeryVerbose, NumVerbosity, VerbosityMask = 0xf, SetColor = 0x40, BreakOnLog = 0x80, } }


description: Ordered according to their severity

code: namespace EMessageSeverity { enum Type { Error = 1, PerformanceWarning = 2, Warning = 3, Info = 4, } }


code: namespace EMessageToken { enum Type { Action, Actor, AssetName, Documentation, Image, Object, Severity, Text, Tutorial, URL, EdGraph, DynamicText, } }


description: Factory methods, tokens can only be constructed as shared refs

code: static [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FActionToken](API\Runtime\Core\Logging\FActionToken) > Create ( const [FText](API\Runtime\Core\Internationalization\FText) & InActionName, const [FText](API\Runtime\Core\Internationalization\FText) & InActionDescription, const FOnActionTokenExecuted & InAction, bool bInSingleUse )


description: Returns true if the action can be activated

code: bool CanExecuteAction() const


code: static [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FActionToken](API\Runtime\Core\Logging\FActionToken) > Create ( const [FText](API\Runtime\Core\Internationalization\FText) & InActionName, const [FText](API\Runtime\Core\Internationalization\FText) & InActionDescription, const FOnActionTokenExecuted & InAction, const FCanExecuteActionToken & InCanExecuteAction, bool bInSingleUse )


description: Executes the assigned action delegate.

code: void ExecuteAction()


description: Gets the action's description text.

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


description:
Get the type of this message token
the type of the token

code: virtual [EMessageToken::Type](API\Runtime\Core\Logging\EMessageToken__Type) GetType() const


description: Returns true if the action is properly set

code: bool IsValidAction() const


description: Hidden constructors.

code: FActionToken ( const [FText](API\Runtime\Core\Internationalization\FText) & InActionName, const [FText](API\Runtime\Core\Internationalization\FText) & InActionDescription, const FOnActionTokenExecuted & InAction, bool bInSingleUse )


code: FActionToken ( FPrivateToken, const [FText](API\Runtime\Core\Internationalization\FText) & InActionName, const [FText](API\Runtime\Core\Internationalization\FText) & InActionDescription, const FOnActionTokenExecuted & InAction, bool bInSingleUse )


code: FActionToken ( const [FText](API\Runtime\Core\Internationalization\FText) & InActionName, const [FText](API\Runtime\Core\Internationalization\FText) & InActionDescription, const FOnActionTokenExecuted & InAction, const FCanExecuteActionToken & InCanExecuteAction, bool bInSingleUse )


code: FActionToken ( FPrivateToken, const [FText](API\Runtime\Core\Internationalization\FText) & InActionName, const [FText](API\Runtime\Core\Internationalization\FText) & InActionDescription, const FOnActionTokenExecuted & InAction, const FCanExecuteActionToken & InCanExecuteAction, bool bInSingleUse )


className: FActionToken

description: Message token that performs an action when activated.

code: class FActionToken : public [IMessageToken](API\Runtime\Core\Logging\IMessageToken)


description: Factory method, tokens can only be constructed as shared refs

code: static [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FActorToken](API\Runtime\Core\Logging\FActorToken) > Create ( const [FString](API\Runtime\Core\Containers\FString) & InActorPath, const [FGuid](API\Runtime\Core\Misc\FGuid) & InActorGuid, const [FText](API\Runtime\Core\Internationalization\FText) & InMessage )


className: DefaultMessageTokenActivated

description: The default activation method, if any


description: Get the actor guid used by this token

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


description: Get the delegate for default token activation

code: static FOnMessageTokenActivated & DefaultOnMessageTokenActivated()


description: EndIMessageTokeninterface Get the actor name used by this token

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


description:
Get the activated delegate associated with this token, if any
a reference to the delegate

code: virtual const FOnMessageTokenActivated & GetOnMessageTokenActivated() const


description: BeginIMessageTokeninterface


description: Private constructor

code: FActorToken &40; const FString & InActorPath, const FGuid & InActorGuid, const FText & InMessage &41;


description: Private constructor

code: FActorToken ( FPrivateToken, const [FString](API\Runtime\Core\Containers\FString) & InActorPath, const [FGuid](API\Runtime\Core\Misc\FGuid) & InActorGuid, const [FText](API\Runtime\Core\Internationalization\FText) & InMessage )


className: FActorToken

description: Basic message token that defaults its activated method to select an actor in the opened level

code: class FActorToken : public [IMessageToken](API\Runtime\Core\Logging\IMessageToken)


code: static [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FAssetNameToken](API\Runtime\Core\Logging\FAssetNameToken) > Create ( const [FString](API\Runtime\Core\Containers\FString) & InAssetName, const [FText](API\Runtime\Core\Internationalization\FText) & InMessage )


className: FOnGotoAsset

code: typedef TBaseDelegate_OneParam< void, const [FString](API\Runtime\Core\Containers\FString) & > FOnGotoAsset


description: EndIMessageTokeninterface Get the filename used by this token

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


className: GotoAsset

description: The delegate we will use to go to our file


code: static [FOnGotoAsset](API\Runtime\Core\Logging\FAssetNameToken\FOnGotoAsset) & OnGotoAsset()


description: Private constructor

code: FAssetNameToken &40; const FString & InAssetName, const FText & InMessage &41;


description: Private constructor

code: FAssetNameToken ( FPrivateToken, const [FString](API\Runtime\Core\Containers\FString) & InAssetName, const [FText](API\Runtime\Core\Internationalization\FText) & InMessage )


className: FAssetNameToken

description: Basic message token that defaults its activated method to find a file Intended to hook into things like the content browser.

code: class FAssetNameToken : public [IMessageToken](API\Runtime\Core\Logging\IMessageToken)


code: static [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FDocumentationToken](API\Runtime\Core\Logging\FDocumentationToken) > Create ( const [FString](API\Runtime\Core\Containers\FString) & InDocumentationLink, const [FString](API\Runtime\Core\Containers\FString) & InPreviewExcerptLink, const [FString](API\Runtime\Core\Containers\FString) & InPreviewExcerptName )


description: EndIMessageTokeninterface Get the documentation link used by this token

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


description: Get the documentation excerpt link used by this token

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


description: Get the documentation excerpt name used by this token

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


description: Protected constructor

code: FDocumentationToken ( const [FString](API\Runtime\Core\Containers\FString) & InDocumentationLink, const [FString](API\Runtime\Core\Containers\FString) & InPreviewExcerptLink, const [FString](API\Runtime\Core\Containers\FString) & InPreviewExcerptName )


code: FDocumentationToken ( FPrivateToken, const [FString](API\Runtime\Core\Containers\FString) & InDocumentationLink, const [FString](API\Runtime\Core\Containers\FString) & InPreviewExcerptLink, const [FString](API\Runtime\Core\Containers\FString) & InPreviewExcerptName )


className: FDocumentationToken

description: Basic message token that defaults is activated method to access UDN documentation.

code: class FDocumentationToken : public [IMessageToken](API\Runtime\Core\Logging\IMessageToken)


code: static [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FDynamicTextToken](API\Runtime\Core\Logging\FDynamicTextToken) > Create ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FText](API\Runtime\Core\Internationalization\FText) > & InMessage )


description: EndIMessageTokeninterface

code: const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FText](API\Runtime\Core\Internationalization\FText) > & GetTextAttribute() const


description: BeginIMessageTokeninterface

code: virtual [EMessageToken::Type](API\Runtime\Core\Logging\EMessageToken__Type) GetType() const


description:
Get a string representation of this token
a string representing this token

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


className: FDynamicTextToken

description: Message token with a localized attribute text payload

code: class FDynamicTextToken : public [IMessageToken](API\Runtime\Core\Logging\IMessageToken)


description: Private constructor

code: FDynamicTextToken ( FPrivateToken, const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FText](API\Runtime\Core\Internationalization\FText) > & InMessage )


code: static [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FImageToken](API\Runtime\Core\Logging\FImageToken) > Create ( const [FName](API\Runtime\Core\UObject\FName) & InImageName )


description: EndIMessageTokeninterface Get the name of the image for this token

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


description: Private constructor

code: FImageToken ( FPrivateToken, const [FName](API\Runtime\Core\UObject\FName) & InImageName )


className: FImageToken

description: Basic message token with an icon/image payload

code: class FImageToken : public [IMessageToken](API\Runtime\Core\Logging\IMessageToken)


className: CompileTimeVerbosity

code: static constexpr [ELogVerbosity::Type](API\Runtime\Core\Logging\ELogVerbosity__Type) CompileTimeVerbosity = InCompileTimeVerbosity;


code: constexpr [ELogVerbosity::Type](API\Runtime\Core\Logging\ELogVerbosity__Type) GetCompileTimeVerbosity() const


code: FLogCategory ( const FLogCategoryName & InCategoryName )


className: FLogCategory

description: Template for log categories that transfers the compile-time constant default and compile time verbosity to theFLogCategoryBaseconstructor.

code: template<[ELogVerbosity::Type](API\Runtime\Core\Logging\ELogVerbosity__Type) InDefaultVerbosity, [ELogVerbosity::Type](API\Runtime\Core\Logging\ELogVerbosity__Type) InCompileTimeVerbosity> struct FLogCategory : public [FLogCategoryBase](API\Runtime\Core\Logging\FLogCategoryBase)


code: constexpr const FLogCategoryName & GetCategoryName() const


description: Gets the compile time verbosity.


description: Gets the working verbosity.

code: constexpr [ELogVerbosity::Type](API\Runtime\Core\Logging\ELogVerbosity__Type) GetVerbosity() const


description: Should not generally be used directly. Tests the runtime verbosity and maybe triggers a debug break, etc.

code: constexpr bool IsSuppressed ( [ELogVerbosity::Type](API\Runtime\Core\Logging\ELogVerbosity__Type) VerbosityLevel ) const


description: Called just after a logging statement being allow to print. Checks a few things and maybe breaks into the debugger.

code: void PostTrigger ( [ELogVerbosity::Type](API\Runtime\Core\Logging\ELogVerbosity__Type) VerbosityLevel )


description: Sets up the working verbosity and clamps to the compile time verbosity.

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


description: Constructor, registers with the log suppression system and sets up the default values.

code: FLogCategoryBase ( const FLogCategoryName & CategoryName, [ELogVerbosity::Type](API\Runtime\Core\Logging\ELogVerbosity__Type) DefaultVerbosity, [ELogVerbosity::Type](API\Runtime\Core\Logging\ELogVerbosity__Type) CompileTimeVerbosity )


description: Destructor, unregisters from the log suppression system.

code: ~FLogCategoryBase()


className: FLogCategoryBase

description: Base class for all log categories.

code: struct FLogCategoryBase


className: FWriteFn

code: typedef void([FCbWriter](API\Runtime\Core\Serialization\FCbWriter) &Writer, const void *Value) FWriteFn


code: template<typename ValueType> static void Write ( [FCbWriter](API\Runtime\Core\Serialization\FCbWriter) & Writer, const void * Value )


className: FLogField

code: struct FLogField

Name

type: const ANSICHAR ...

Value

type: const void *...

WriteValue

type: FWriteFn*


code: template<typename ValueType, typename... FieldArgTypes, std::enable_if_t< ValueCount< ValueType >> *> static void Create ( [FLogField](API\Runtime\Core\Logging\FLogField) * Fields, const ValueType & Value, FieldArgTypes &&... FieldArgs )


code: static void Create ( [FLogField](API\Runtime\Core\Logging\FLogField) * Fields )


code: template<typename NameType, typename ValueType, typename... FieldArgTypes> static void Create ( [FLogField](API\Runtime\Core\Logging\FLogField) * Fields, [TLogFieldName](API\Runtime\Core\Logging\TLogFieldName)< NameType > Name, const ValueType & Value, FieldArgTypes &&... FieldArgs )


code: template<typename... FieldArgTypes> static constexpr int32 GetCount()


className: ValueCount

code: static constexpr int32 ValueCount = 1;


className: ValueCount< TLogFieldName< T > >

code: static constexpr int32 ValueCount< TLogFieldName< T > > = 0;


className: FLogFieldCreator

description: Create log fields from values optionally preceded by names.

code: struct FLogFieldCreator


description: Formats the message using the format, template, and fields.

code: void FormatMessageTo ( FWideStringBuilderBase & Out ) const


code: void FormatMessageTo ( FUtf8StringBuilderBase & Out ) const


description: The optional name of the category for the log record. None when omitted.

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


description: The fields referenced by the format string, along with optional additional fields.

code: const [FCbObject](API\Runtime\Core\Serialization\FCbObject) & GetFields() const


description: The optional source file path for the code that created the log record. Null when omitted.

code: const ANSICHAR * GetFile() const


description: The format string that serves as the message for the log record. Example: TEXT("FieldName is {FieldName}")

code: const TCHAR * GetFormat() const


description: The optional source line number for the code that created the log record. 0 when omitted.

code: int32 GetLine() const


description: The optional template for the format string.

code: const FLogTemplate * GetTemplate() const


description: The key of the localized text. Null when non-localized.

code: const TCHAR * GetTextKey() const


description: The namespace of the localized text. Null when non-localized.

code: const TCHAR * GetTextNamespace() const


description: The time at which the log record was created.

code: const [FLogTime](API\Runtime\Core\Logging\FLogTime) & GetTime() const


description: The verbosity level of the log record. Must be a valid level with no flags or special values.


code: void SetCategory ( const [FName](API\Runtime\Core\UObject\FName) & InCategory )


code: void SetFields ( [FCbObject](API\Runtime\Core\Serialization\FCbObject) && InFields )


code: void SetFile ( const ANSICHAR * InFile )


code: void SetFormat ( const TCHAR * InFormat )


code: void SetTextKey ( const TCHAR * InTextKey )


code: void SetTemplate ( const FLogTemplate * InTemplate )


code: void SetTextNamespace ( const TCHAR * InTextNamespace )


code: void SetTime ( const [FLogTime](API\Runtime\Core\Logging\FLogTime) & InTime )


className: FLogRecord

description: Record of a log event.

code: class FLogRecord


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


code: void operator&61; &40; const FOverride & Other &41;


code: FOverride &40; FName InCategory, ELogVerbosity::Type InVerbosity &41;


className: FOverride

description: STructure to aggregate a category and verbosity pair

code: struct FOverride

Category

type: FName


description: Manages a TLS slot with the current overrides for category and verbosity.

code: static [FOverride](API\Runtime\Core\Logging\FLogScopedCategoryAndVerbosityOv-\FOverride) * GetTLSCurrent()


description: Back up the existing category and verbosity pair, then sets them.

code: FLogScopedCategoryAndVerbosityOverride ( [FName](API\Runtime\Core\UObject\FName) Category, [ELogVerbosity::Type](API\Runtime\Core\Logging\ELogVerbosity__Type) Verbosity )


description: Restore the category and verbosity overrides to the previous value.


className: FLogScopedCategoryAndVerbosityOverride

description: Helper class that uses thread local storage to set up the default category and verbosity for the low level logging functions. This is what allow a UE_LOG(LogHAL, Log, TEXT("...")); within a UE_LOG statement to know what the category and verbosity is. When one of these goes out of scope, it restores the previous values.


code: [FLogScopedVerbosityOverride](API\Runtime\Core\Logging\FLogScopedVerbosityOverride) & operator= ( const [FLogScopedVerbosityOverride](API\Runtime\Core\Logging\FLogScopedVerbosityOverride) & )


description: Disable accidental copies.

code: FLogScopedVerbosityOverride ( const [FLogScopedVerbosityOverride](API\Runtime\Core\Logging\FLogScopedVerbosityOverride) & )


description: Back up the existing verbosity for the category then sets new verbosity.

code: FLogScopedVerbosityOverride ( [FLogCategoryBase](API\Runtime\Core\Logging\FLogCategoryBase) * Category, [ELogVerbosity::Type](API\Runtime\Core\Logging\ELogVerbosity__Type) Verbosity )


description: Restore the verbosity overrides for the category to the previous value.

code: ~FLogScopedVerbosityOverride()


className: FLogScopedVerbosityOverride

description: Helper class that allows setting scoped verbosity for log category. Saved what was previous verbosity for the category, and recovers it when it goes out of scope. Use Macro LOG_SCOPE_VERBOSITY_OVERRIDE for this

code: class FLogScopedVerbosityOverride


description: Used byFLogCategoryBaseto register itself with the global category table

code: void AssociateSuppress ( struct [FLogCategoryBase](API\Runtime\Core\Logging\FLogCategoryBase) * Destination )


description: Used byFLogCategoryBaseto unregister itself from the global category table

code: void DisassociateSuppress ( struct [FLogCategoryBase](API\Runtime\Core\Logging\FLogCategoryBase) * Destination )


description: Singleton, returns a reference the global log suppression implementation.

code: static [FLogSuppressionInterface](API\Runtime\Core\Logging\FLogSuppressionInterface) & Get()


description: Called by appInit once the config files and commandline are set up. The log suppression system uses these to setup the boot time defaults.

code: void ProcessConfigAndCommandLine()


description: Returns null afterTearDown()has been called

code: static [FLogSuppressionInterface](API\Runtime\Core\Logging\FLogSuppressionInterface) * TryGet()


className: FLogSuppressionInterface

description: Interface to the log suppression system

code: class FLogSuppressionInterface


description: Returns the UTC time. 0 ticks when the time was not set.


className: FLogTime

description: Time that a log event occurred.

code: class FLogTime


description:
Add a message to the log.
The message for chaining calls

code: const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FTokenizedMessage](API\Runtime\Core\Logging\FTokenizedMessage) > & AddMessage ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FTokenizedMessage](API\Runtime\Core\Logging\FTokenizedMessage) > & InMessage )


description: Add an array of messages to the message log

code: void AddMessages ( const [TArray](API\Runtime\Core\Containers\TArray)< [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FTokenizedMessage](API\Runtime\Core\Logging\FTokenizedMessage) > > & InMessages )


code: [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FTokenizedMessage](API\Runtime\Core\Logging\FTokenizedMessage) > Error ( const [FText](API\Runtime\Core\Internationalization\FText) & InMessage )


description: Deprecated* CriticalError was removed because it can't trigger an assert at the callsite. Use 'checkf' instead.

code: [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FTokenizedMessage](API\Runtime\Core\Logging\FTokenizedMessage) > CriticalError ( const [FText](API\Runtime\Core\Internationalization\FText) & InMessage )


className: FGetLog

description: Delegate to retrieve a log interface. This allows systems that implementIMessageLogto receive messages.

code: typedef TBaseDelegate_OneParam< [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< class [IMessageLog](API\Runtime\Core\Logging\IMessageLog) >, const [FName](API\Runtime\Core\UObject\FName) & > FGetLog


className: FMessageSelectionChanged

description: Delegate used when message selection changes. This is used to select object in the scene according to objects referenced in message tokens.

code: typedef TBaseDelegate_OneParam< void, [TArray](API\Runtime\Core\Containers\TArray)< [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FTokenizedMessage](API\Runtime\Core\Logging\FTokenizedMessage) > > & > FMessageSelectionChanged


className: GetLog

description: Delegate for retrieving the message log


description: Helper function to retrieve a log color for a specified message severity

code: static const TCHAR *const GetLogColor ( [EMessageSeverity::Type](API\Runtime\Core\Logging\EMessageSeverity__Type) InSeverity )


description: Helper function to convert message log severity to log verbosity

code: static [ELogVerbosity::Type](API\Runtime\Core\Logging\ELogVerbosity__Type) GetLogVerbosity ( [EMessageSeverity::Type](API\Runtime\Core\Logging\EMessageSeverity__Type) InSeverity )


code: [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FTokenizedMessage](API\Runtime\Core\Logging\FTokenizedMessage) > Info ( const [FText](API\Runtime\Core\Internationalization\FText) & InMessage )


description:
Helper functions to allow easy adding of messages to the log. Each one will add a token for the severity (if valid) and the textual message (if any). Messages are buffered.
the message for chaining calls.

code: [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FTokenizedMessage](API\Runtime\Core\Logging\FTokenizedMessage) > Message ( [EMessageSeverity::Type](API\Runtime\Core\Logging\EMessageSeverity__Type) InSeverity, const [FText](API\Runtime\Core\Internationalization\FText) & InMessage )


className: MessageSelectionChanged

description: Delegate for message selection


description: Add a new page to the log. Pages will not be created until messages are added to them, so we dont generate lots of empty pages. This call will cause a flush so that the logs state is properly reflected.

code: void NewPage ( const [FText](API\Runtime\Core\Internationalization\FText) & InLabel )


description: Notify the user with a message if there are messages present. This call will cause a flush so that the logs state is properly reflected.

code: void Notify ( const [FText](API\Runtime\Core\Internationalization\FText) & InMessage, [EMessageSeverity::Type](API\Runtime\Core\Logging\EMessageSeverity__Type) InSeverityFilter, bool bForce )


description:
Check whether there are any messages present for this log. If the log is paged, this will check if there are any messages on the current page. This call will cause a flush so that the logs state is properly reflected.
The number of messages that pass our filter

code: int32 NumMessages ( [EMessageSeverity::Type](API\Runtime\Core\Logging\EMessageSeverity__Type) InSeverityFilter )


code: static [FGetLog](API\Runtime\Core\Logging\FMessageLog\FGetLog) & OnGetLog()


description: Opens the log for display to the user given certain conditions. This call will cause a flush so that the logs state is properly reflected.

code: void Open ( [EMessageSeverity::Type](API\Runtime\Core\Logging\EMessageSeverity__Type) InSeverityFilter, bool bOpenEvenIfEmpty )


code: [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FTokenizedMessage](API\Runtime\Core\Logging\FTokenizedMessage) > PerformanceWarning ( const [FText](API\Runtime\Core\Internationalization\FText) & InMessage )


description: Sets the current page to the one specified by the label. This call will cause a flush so that the logs state is properly reflected.

code: void SetCurrentPage ( const [FText](API\Runtime\Core\Internationalization\FText) & InLabel )


description: Should we mirror message log messages from this instance to the output log during flush?

code: [FMessageLog](API\Runtime\Core\Logging\FMessageLog) & SuppressLoggingToOutputLog ( bool bShouldSuppress )


code: [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FTokenizedMessage](API\Runtime\Core\Logging\FTokenizedMessage) > Warning ( const [FText](API\Runtime\Core\Internationalization\FText) & InMessage )


description: Constructor

code: FMessageLog ( const [FName](API\Runtime\Core\UObject\FName) & InLogName )


description: Destructor When this object goes out of scope, its buffered messages will be flushed.

code: ~FMessageLog()


description: Log function

code: template<typename FmtType, typename... Types> static void Logf ( const ANSICHAR * File, int32 Line, const FLogCategoryName & Category, [ELogVerbosity::Type](API\Runtime\Core\Logging\ELogVerbosity__Type) Verbosity, const FmtType & Fmt, Types... Args )


description: Internal version of log function. Should be used only in logging macros, as it relies on caller to call assert on fatal error

code: template<typename FmtType, typename... Types> static void Logf_Internal ( const ANSICHAR * File, int32 Line, const FLogCategoryName & Category, [ELogVerbosity::Type](API\Runtime\Core\Logging\ELogVerbosity__Type) Verbosity, const FmtType & Fmt, Types... Args )


code: static void LogV ( const ANSICHAR * File, int32 Line, const FLogCategoryName & Category, [ELogVerbosity::Type](API\Runtime\Core\Logging\ELogVerbosity__Type) Verbosity, const TCHAR * Fmt, va_list Args )


description: Sends a message to a remote tool.

code: static void SendNotificationString ( const TCHAR * Message )


description: Sends a formatted message to a remote tool.

code: template<typename FmtType, typename... Types> static void SendNotificationStringf ( const FmtType & Fmt, Types... Args )


className: FMsg

description: Define NO_LOGGING to strip out all writing to log files, OutputDebugString(), etc. This is needed for consoles that require no logging (Xbox, Xenon)FMsgThis struct contains functions for messaging with tools or debug logs.

code: struct FMsg


description: Factory method, tokens can only be constructed as shared refs

code: static [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FSeverityToken](API\Runtime\Core\Logging\FSeverityToken) > Create ( [EMessageSeverity::Type](API\Runtime\Core\Logging\EMessageSeverity__Type) InSeverity )


description: EndIMessageTokeninterface Get the severity of this token


description: BeginIMessageTokeninterface

code: virtual [EMessageToken::Type](API\Runtime\Core\Logging\EMessageToken__Type) GetType() const


description: Private constructor

code: FSeverityToken ( FPrivateToken, [EMessageSeverity::Type](API\Runtime\Core\Logging\EMessageSeverity__Type) InSeverity )


className: FStaticBasicLogDynamicData

description: Data about a static basic log that is created on-demand.

code: struct FStaticBasicLogDynamicData

bInitialized

type: std::atomic< bo...


className: FSeverityToken

description: Basic message token with a severity payload

code: class FSeverityToken : public [IMessageToken](API\Runtime\Core\Logging\IMessageToken)


description: Workaround forhttps://developercommunity.visualstudio.com/t/Incorrect-warning-C4700-with-unrelated-s/10285950.

code: constexpr FStaticBasicLogRecord ( const TCHAR * InFormat, const ANSICHAR * InFile, int32 InLine, [ELogVerbosity::Type](API\Runtime\Core\Logging\ELogVerbosity__Type) InVerbosity, [FStaticBasicLogDynamicData](API\Runtime\Core\Logging\FStaticBasicLogDynamicData) & InDynamicData )


className: FStaticBasicLogRecord

description: Data about a static basic log that is constant for every occurrence.

code: struct FStaticBasicLogRecord

DynamicData

type: FStaticBasicLog...


code: constexpr FStaticLocalizedLogRecord ( const TCHAR * InTextNamespace, const TCHAR * InTextKey, const TCHAR * InFormat, const ANSICHAR * InFile, int32 InLine, [ELogVerbosity::Type](API\Runtime\Core\Logging\ELogVerbosity__Type) InVerbosity, [FStaticLogDynamicData](API\Runtime\Core\Logging\FStaticLogDynamicData) & InDynamicData )


className: FStaticLocalizedLogRecord

description: Data about a static localized log that is constant for every occurrence.

code: struct FStaticLocalizedLogRecord

type: FStaticLogDynam...


className: FStaticLogDynamicData

description: Data about a static log that is created on-demand.

code: struct FStaticLogDynamicData

Template

type: std::atomic< FL...


code: constexpr FStaticLogRecord ( const TCHAR * InFormat, const ANSICHAR * InFile, int32 InLine, [ELogVerbosity::Type](API\Runtime\Core\Logging\ELogVerbosity__Type) InVerbosity, [FStaticLogDynamicData](API\Runtime\Core\Logging\FStaticLogDynamicData) & InDynamicData )


className: FStaticLogRecord

description: Data about a static log that is constant for every occurrence.

code: struct FStaticLogRecord


code: static [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FTextToken](API\Runtime\Core\Logging\FTextToken) > Create ( const [FText](API\Runtime\Core\Internationalization\FText) & InMessage, bool InIsSourceLinkOnLeft )


description: EndIMessageTokeninterface Private constructor

code: FTextToken ( FPrivateToken, const [FText](API\Runtime\Core\Internationalization\FText) & InMessage, bool InIsSourceLinkOnLeft )


className: FTextToken

description: Basic message token with a localized text payload

code: class FTextToken : public [IMessageToken](API\Runtime\Core\Logging\IMessageToken)


description:
Adds a token to a message.
this message, for chaining calls.

code: [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FTokenizedMessage](API\Runtime\Core\Logging\FTokenizedMessage) > AddToken ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IMessageToken](API\Runtime\Core\Logging\IMessageToken) > & InToken )


description: Creates a newFTokenizedMessagethe generated message for temporary storage or so other tokens can be added to it if required.

code: static [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FTokenizedMessage](API\Runtime\Core\Logging\FTokenizedMessage) > Create ( [EMessageSeverity::Type](API\Runtime\Core\Logging\EMessageSeverity__Type) InSeverity, const [FText](API\Runtime\Core\Internationalization\FText) & InMessageText )


description: Identifier for the message, if set, else NAME_None


description:
Gets the token action associated with this messages as a whole. Should link to an associated element.
A token action that was set viaSetMessageLink().

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IMessageToken](API\Runtime\Core\Logging\IMessageToken) > GetMessageLink() const


description:
Get the tokens in this message
an array of tokens

code: const [TArray](API\Runtime\Core\Containers\TArray)< [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IMessageToken](API\Runtime\Core\Logging\IMessageToken) > > & GetMessageTokens() const


description:
Gets the severity of this message
the severity of this message


description:
Helper function for getting a severity as text
a string representation of the severity

code: static [FText](API\Runtime\Core\Internationalization\FText) GetSeverityText ( [EMessageSeverity::Type](API\Runtime\Core\Logging\EMessageSeverity__Type) InSeverity )


description: Assigns Identifier for the message to the provided name

code: void SetIdentifier ( [FName](API\Runtime\Core\UObject\FName) InIdentifier )


description: Sets up a token action for the message as a whole (not to be displayed... intended to be invoked from a double click).

code: void SetMessageLink ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IMessageToken](API\Runtime\Core\Logging\IMessageToken) > & InToken )


description: Sets the severity of this message

code: void SetSeverity ( const [EMessageSeverity::Type](API\Runtime\Core\Logging\EMessageSeverity__Type) InSeverity )


description:
Get this tokenized message as a string
a string representation of this message


description: Private constructor - we want to only create these structures as shared references viaCreate()

code: FTokenizedMessage ( FPrivateToken )


className: FTokenizedMessage

description: This class represents a rich tokenized message, such as would be used for compiler output with 'hyperlinks' to source file locations

code: class FTokenizedMessage : public [TSharedFromThis< FTokenizedMessage >](API\Runtime\Core\Templates\TSharedFromThis)

MessageLink

type: TSharedPtr<IMe...

description: A token associated with the entire message (doesn't display)

MessageTokens

type: TArray<TShared...

description: The array of message tokens this message contains


description: Factory method, tokens can only be constructed as shared refs

code: static [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FTutorialToken](API\Runtime\Core\Logging\FTutorialToken) > Create ( const [FString](API\Runtime\Core\Containers\FString) & TutorialAssetName )


description:
Helper function for getting a severity as an icon name
the name of the icon for the severity

code: static [FName](API\Runtime\Core\UObject\FName) GetSeverityIconName ( [EMessageSeverity::Type](API\Runtime\Core\Logging\EMessageSeverity__Type) InSeverity )


description: Get the tutorial asset name stored in this token.

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


description:
Get the type of this message token
the type of the token

code: virtual [EMessageToken::Type](API\Runtime\Core\Logging\EMessageToken__Type) GetType() const


description: Protected constructor

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


code: FTutorialToken ( FPrivateToken, const [FString](API\Runtime\Core\Containers\FString) & InTutorialAssetName )


className: FTutorialToken

code: class FTutorialToken : public [IMessageToken](API\Runtime\Core\Logging\IMessageToken)


code: static [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FURLToken](API\Runtime\Core\Logging\FURLToken) > Create ( const [FString](API\Runtime\Core\Containers\FString) & InURL, const [FText](API\Runtime\Core\Internationalization\FText) & InMessage )


description: BeginIMessageTokeninterface


description: EndIMessageTokeninterface Get the URL used by this token

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


description: Private constructor

code: FURLToken &40; const FString & InURL, const FText & InMessage &41;


description: Private constructor

code: FURLToken ( FPrivateToken, const [FString](API\Runtime\Core\Containers\FString) & InURL, const [FText](API\Runtime\Core\Internationalization\FText) & InMessage )


className: FURLToken

description: Basic message token that defaults is activated method to traverse a URL

code: class FURLToken : public [IMessageToken](API\Runtime\Core\Logging\IMessageToken)


description: Appends a single message

code: void AddMessage ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< class [FTokenizedMessage](API\Runtime\Core\Logging\FTokenizedMessage) > & NewMessage, bool bMirrorToOutputLog )


description: Appends multiple messages

code: void AddMessages ( const [TArray](API\Runtime\Core\Containers\TArray)< [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< class [FTokenizedMessage](API\Runtime\Core\Logging\FTokenizedMessage) > > & NewMessages, bool bMirrorToOutputLog )


description: Adds a new page to the log. Old pages are only kept around if they contain messages, so if the current page is empty, this call does nothing.

code: void NewPage ( const [FText](API\Runtime\Core\Internationalization\FText) & Title )


description: Notify the user if there are any messages on the current page for this log. If there are no messages present, this call does nothing.

code: void NotifyIfAnyMessages ( const [FText](API\Runtime\Core\Internationalization\FText) & Message, [EMessageSeverity::Type](API\Runtime\Core\Logging\EMessageSeverity__Type) SeverityFilter, bool bForce )


description:
Checks to see if there are any messages according to the passed-in severity
The number of messages that pass our filter

code: int32 NumMessages ( [EMessageSeverity::Type](API\Runtime\Core\Logging\EMessageSeverity__Type) SeverityFilter )


description: Opens up the message log to this listing.

code: void Open()


description: Sets the current page to the one specified by the title.

code: void SetCurrentPage ( const [FText](API\Runtime\Core\Internationalization\FText) & Title )


code: void SetCurrentPage ( const uint32 InOldPageIndex )


description: Virtual destructor

code: virtual ~IMessageLog()


className: IMessageLog

description: A message log. Message logs can be written to from any module, incorporating rich tokenized information as well as text. Messages will be displayed to the standard log and the rich MessageLogListing if it is available.

code: class IMessageLog


description:
Get the activated delegate associated with this token, if any
a reference to the delegate

code: virtual const FOnMessageTokenActivated & GetOnMessageTokenActivated() const


description:
Set the activated delegate associated with this token
a reference to this token, for chaining

code: virtual [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IMessageToken](API\Runtime\Core\Logging\IMessageToken) > OnMessageTokenActivated ( FOnMessageTokenActivated InMessageTokenActivated )


description:
Get a string representation of this token
a string representing this token

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


description: Virtual destructor

code: virtual ~IMessageToken()


className: IMessageToken

description: A single message token for aFTokenizedMessageinstance

code: class IMessageToken : public [TSharedFromThis< IMessageToken >](API\Runtime\Core\Templates\TSharedFromThis)

CachedText

type: FText

description: Cached string representation of this token

MessageTokenActivated

type: FOnMessageToken...

description: A delegate for when this token is activated (e.g. hyperlink clicked)


className: Type

code: typedef typename [TCallTraits](API\Runtime\Core\GenericPlatform\TCallTraits)< T >::ParamType Type


className: TFieldArgType

code: template<typename T> struct TFieldArgType


className: TLogFieldName

description: Wrapper to identify field names interleaved with field values.

code: template<typename NameType> struct TLogFieldName

Name

type: NameType


code: namespace UEAsserts_Private { template<int32 VerbosityToCheck, typename CategoryType> bool UEAsserts_Private::IsLogActive ( const CategoryType & Category ) }


description: Verify that the name is likely a string literal and forward it on.

code: namespace UE { namespace Logging { namespace Private { template<typename NameType> constexpr [TLogFieldName](API\Runtime\Core\Logging\TLogFieldName)< NameType > UE::Logging::Private::CheckFieldName ( NameType && Name ) } } }


description: Fatal log with fields created from the arguments, which may be values or pairs of name/value.

code: namespace UE { namespace Logging { namespace Private { template<typename... FieldArgTypes, typename LogType> void UE::Logging::Private::FatalLogWithFields ( const [FLogCategoryBase](API\Runtime\Core\Logging\FLogCategoryBase) & Category, const LogType & Log, typename [TFieldArgType](API\Runtime\Core\Logging\TFieldArgType)< FieldArgTypes >::Type... FieldArgs ) } } }


description: Log if the category is active at this level of verbosity.

code: namespace UE { namespace Logging { namespace Private { template<typename LogCategoryType, [ELogVerbosity::Type](API\Runtime\Core\Logging\ELogVerbosity__Type) Verbosity, typename LogRecordType, typename... FieldArgTypes> void UE::Logging::Private::LogIfActive ( const LogCategoryType & Category, const LogRecordType & Log, FieldArgTypes &&... FieldArgs ) } } }


description: Log with fields created from the arguments, which may be values or pairs of name/value.

code: namespace UE { namespace Logging { namespace Private { template<typename... FieldArgTypes, typename LogType> void UE::Logging::Private::LogWithFields ( const [FLogCategoryBase](API\Runtime\Core\Logging\FLogCategoryBase) & Category, const LogType & Log, typename [TFieldArgType](API\Runtime\Core\Logging\TFieldArgType)< FieldArgTypes >::Type... FieldArgs ) } } }


code: namespace UE { template<typename ValueType> void UE::SerializeForLog ( [FCbWriter](API\Runtime\Core\Serialization\FCbWriter) & Writer, ValueType && Value ) }


code: double operator[] ( int32 Index ) const


code: AlignedDouble4 ( const [VectorRegister4Double](API\Runtime\Core\Math\VectorRegister4Double) & Vec )


description: Helper for conveniently aligning a double array for extraction fromVectorRegister4Double.

code: struct AlignedDouble4


code: float operator[] ( int32 Index ) const


code: AlignedFloat4 ( const [VectorRegister4Float](API\Runtime\Core\Math\VectorRegister4Float) & Vec )


description: Helper for conveniently aligning a float array for extraction fromVectorRegister4Float.

code: struct AlignedFloat4


className: ConcatenateRules

code: template<typename TransformTypeA, typename TransformTypeB> struct ConcatenateRules


className: ResultType

code: typedef TransformType ResultType


description: Partial specialization for concatenating two of the same types. Always results in the same type being returned.

code: template<typename TransformType> struct ConcatenateRules< TransformType, TransformType >


description: Returns true if 'a' is more lower-left than 'b'.

code: namespace ConvexHull2D { bool ConvexHull2D::ComparePoints ( const FVector & A, const FVector & B ) }


code: namespace ConvexHull2D { *Scan sorted vertex from left to right to compute lower hull Allocator void ConvexHull2D::ComputeConvexHull ( const [TArray](API\Runtime\Core\Containers\TArray)< VectorType, Allocator > & Points, [TArray](API\Runtime\Core\Containers\TArray)< int32, Allocator > & OutIndices ) }


description: Should be replaced by ComputeConvexHull and tested properly. Keep for backward compatibility until then.

code: namespace ConvexHull2D { template<typename Allocator> void ConvexHull2D::ComputeConvexHullLegacy ( const [TArray](API\Runtime\Core\Containers\TArray)< FVector, Allocator > & Points, [TArray](API\Runtime\Core\Containers\TArray)< int32, Allocator > & OutIndices ) }


code: namespace ConvexHull2D { template<typename Allocator> void ConvexHull2D::ComputeConvexHullLegacy2 ( const [TArray](API\Runtime\Core\Containers\TArray)< FVector2D, Allocator > & Points, [TArray](API\Runtime\Core\Containers\TArray)< int32, Allocator > & OutIndices ) }


description: Returns <0 if C is left of A-B

code: namespace ConvexHull2D { [FVector2D::FReal](API\Runtime\Core\Math\TVector2\FReal) ConvexHull2D::ComputeDeterminant2D ( const FVector2D & A, const FVector2D & B, const FVector2D & C ) }


description: Returns <0 if C is left of A-B

code: namespace ConvexHull2D { [FVector::FReal](API\Runtime\Core\Math\TVector\FReal) ConvexHull2D::ComputeDeterminant ( const FVector & A, const FVector & B, const FVector & C ) }


code: namespace ConvexHull2D { *Scan sorted vertex from left to right to compute lower hull ConvexHull2D::O ( N log H ) }


description: Extended axis enum for more specialized usage.

code: namespace EAxisList { enum Type { None = 0, X = 1, Y = 2, Z = 4, Screen = 8, XY = X | Y, XZ = X | Z, YZ = Y | Z, XYZ = X | Y | Z, All = XYZ | Screen, ZRotation = YZ, Rotate2D = Screen, } }


description: Generic axis enum (mirrored for property use in Object.h)

code: namespace EAxis { enum Type { None, X, Y, Z, } }


description: 1 - SortO(N log N)/**

code: namespace ConvexHull2D { *Scan sorted vertex from left to right to compute lower hull ConvexHull2D::O ( N ) }


description: Enumerates the valid types of range bounds.

code: namespace ERangeBoundTypes { enum Type { Exclusive, Inclusive, Open, } }


description: Consume a symbol from the specified consumer's stream, if one exists at the current read position

code: namespace ExpressionParser { template<typename TSymbol> [TOptional](API\Runtime\Core\IO\TOptional)< [FExpressionError](API\Runtime\Core\Misc\FExpressionError) > ExpressionParser::ConsumeSymbol ( FExpressionTokenConsumer & Consumer ) }


description: Evaluate the given expression, resulting in either a double value, or an error

code: [TValueOrError](API\Runtime\Core\Math\TValueOrError)< double, [FExpressionError](API\Runtime\Core\Misc\FExpressionError) > Evaluate ( const TCHAR * InExpression, double InExistingValue ) const


description: Constructor that sets up the parser's lexer and compiler

code: FBasicMathExpressionEvaluator()


className: FBasicMathExpressionEvaluator

description: A basic math expression evaluator

code: class FBasicMathExpressionEvaluator


description: Converts to a FBox.

code: FBox GetBox() const


description: Default constructor.

code: FBoxCenterAndExtent()


description: FBoxSphereBounds conversion constructor.

code: template<typename TExtent> FBoxCenterAndExtent ( const [UE::Math::TBoxSphereBounds](API\Runtime\Core\Math\TBoxSphereBounds)< [FReal](API\Runtime\Core\Math\FBoxCenterAndExtent\FReal), TExtent > & BoxSphere )


description: FBox conversion constructor.

code: FBoxCenterAndExtent ( const FBox & Box )


description: Center - radius as four contiguous floats conversion constructor.

code: FBoxCenterAndExtent ( const float PositionRadius )


description: Initialization constructor.

code: FBoxCenterAndExtent ( const FVector & InCenter, const FVector & InExtent )


className: FBoxCenterAndExtent

description: An unquantized bounding box.

code: class FBoxCenterAndExtent


className: Black

code: static const [FColor](API\Runtime\Core\Math\FColor) Black;


className: Blue

code: static const [FColor](API\Runtime\Core\Math\FColor) Blue;


className: Cyan

code: static const [FColor](API\Runtime\Core\Math\FColor) Cyan;


code: static float DequantizeUNorm16ToFloat ( int Value16 )


code: static float DequantizeUNorm8ToFloat ( int Value8 )


description: ToHex

code: static [FColor](API\Runtime\Core\Math\FColor) FromHex ( const [FString](API\Runtime\Core\Containers\FString) & HexString )


className: Emerald

code: static const [FColor](API\Runtime\Core\Math\FColor) Emerald;


description: Converts from RGBE to a linear float color as outlined in Gregory Ward's Real Pixels article, Graphics Gems II, page 80. Implementation details inhttps://cbloomrants.blogspot.com/2020/06/widespread-error-in-radiance-hdr-rgbe.html


className: Green

code: static const [FColor](API\Runtime\Core\Math\FColor) Green;


description:
Initialize this Color based on anFString. The String is expected to contain R=, G=, B=, A=. TheFColorwill be bogus when InitFromString returns false.
true if the R,G,B values were read successfully; false otherwise.

code: bool InitFromString ( const [FString](API\Runtime\Core\Containers\FString) & InSourceString )


className: Magenta

code: static const [FColor](API\Runtime\Core\Math\FColor) Magenta;


description: Converts temperature in Kelvins of a black body radiator to RGB chromaticity.

code: static [FColor](API\Runtime\Core\Math\FColor) MakeFromColorTemperature ( float Temp )


description: Makes a random but quite nice color.


description: Makes a random color based on a seed.

code: static [FColor](API\Runtime\Core\Math\FColor) MakeRandomSeededColor ( int32 Seed )


description: Makes a color red->green with the passed in scalar (e.g. 0 is red, 1 is green)

code: static [FColor](API\Runtime\Core\Math\FColor) MakeRedToGreenColorFromScalar ( float Scalar )


description: Return 8-bit color Quantized from 10-bit RGB , 2-bit A

code: static [FColor](API\Runtime\Core\Math\FColor) MakeRequantizeFrom1010102 ( int R, int G, int B, int A )


code: void operator+= ( const [FColor](API\Runtime\Core\Math\FColor) & C )


description: Operators.

code: bool operator== ( const [FColor](API\Runtime\Core\Math\FColor) & C ) const


code: bool operator!= ( const [FColor](API\Runtime\Core\Math\FColor) & C ) const


className: Orange

code: static const [FColor](API\Runtime\Core\Math\FColor) Orange;


className: Purple

code: static const [FColor](API\Runtime\Core\Math\FColor) Purple;


code: static uint16 QuantizeUNormFloatTo16 ( float UnitFloat )


description: Conversions to/from GPU UNorm floats, U8, U16 matches convention ofFColorFLinearColor::QuantizeRound

code: static uint8 QuantizeUNormFloatTo8 ( float UnitFloat )


className: Red

code: static const [FColor](API\Runtime\Core\Math\FColor) Red;


description:
Reinterprets the color as a linear color. This is the correct dequantizer for QuantizeRound. This matches the GPU spec conversion for U8<->float
The linear color representation.


code: static uint8 Requantize10to8 ( int Value10 )


code: static uint8 Requantize16to8 ( int Value16 )


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


code: bool Serialize ( [FStructuredArchive::FSlot](API\Runtime\Core\Serialization\FStructuredArchive\FSlot) Slot )


className: Silver

code: static const [FColor](API\Runtime\Core\Math\FColor) Silver;


description: ToString


description: Gets the color in a packed uint32 format packed in the order ABGR.

code: uint32 ToPackedABGR() const


description: Gets the color in a packed uint32 format packed in the order ARGB.

code: uint32 ToPackedARGB() const


description: Gets the color in a packed uint32 format packed in the order BGRA.

code: uint32 ToPackedBGRA() const


description: Gets the color in a packed uint32 format packed in the order RGBA.

code: uint32 ToPackedRGBA() const


description: ToHex


className: Transparent

code: static const [FColor](API\Runtime\Core\Math\FColor) Transparent;


className: Turquoise

code: static const [FColor](API\Runtime\Core\Math\FColor) Turquoise;


className: White

description: Some pre-inited colors, useful for debug code

code: static const [FColor](API\Runtime\Core\Math\FColor) White;


description: a newFColorbased of this color with the new alpha value. Usage: constFColor& MyColor = FColorList::Green.WithAlpha(128);

code: [FColor](API\Runtime\Core\Math\FColor) WithAlpha ( uint8 Alpha ) const


description: Constructors.

code: FColor()


className: Yellow

code: static const [FColor](API\Runtime\Core\Math\FColor) Yellow;


description: Note: Do not implement or make public. We don't want people needlessly and implicitly converting betweenFLinearColorandFColor. It's not a free conversion.

code: FColor &40; const FLinearColor & LinearColor &41;


description: Put these into the body for proper ordering with INTEL vs non-INTEL_BYTE_ORDER

code: constexpr FColor ( uint8 InR, uint8 InG, uint8 InB, uint8 InA )


className: FColor

description: FColorStores a color with 8 bits of precision per channel. Note: Linear color values should always be converted to gamma space before stored in anFColor, as 8 bits of precision is not enough to store linear space colors! This can be done with FLinearColor::ToFColor(true)

code: struct FColor

type: union FColor::@...

description: Variables.


className: Aquamarine

code: static const [FColor](API\Runtime\Core\Math\FColor) Aquamarine;


className: BakerChocolate

code: static const [FColor](API\Runtime\Core\Math\FColor) BakerChocolate;


className: Black

code: static const [FColor](API\Runtime\Core\Math\FColor) Black;


className: Blue

code: static const [FColor](API\Runtime\Core\Math\FColor) Blue;


className: BlueViolet

code: static const [FColor](API\Runtime\Core\Math\FColor) BlueViolet;


className: Brass

code: static const [FColor](API\Runtime\Core\Math\FColor) Brass;


className: Bronze

code: static const [FColor](API\Runtime\Core\Math\FColor) Bronze;


className: BrightGold

code: static const [FColor](API\Runtime\Core\Math\FColor) BrightGold;


className: BronzeII

code: static const [FColor](API\Runtime\Core\Math\FColor) BronzeII;


className: Brown

code: static const [FColor](API\Runtime\Core\Math\FColor) Brown;


className: CadetBlue

code: static const [FColor](API\Runtime\Core\Math\FColor) CadetBlue;


className: CoolCopper

code: static const [FColor](API\Runtime\Core\Math\FColor) CoolCopper;


className: Copper

code: static const [FColor](API\Runtime\Core\Math\FColor) Copper;


className: Coral

code: static const [FColor](API\Runtime\Core\Math\FColor) Coral;


className: CornFlowerBlue

code: static const [FColor](API\Runtime\Core\Math\FColor) CornFlowerBlue;


description: Initializes list of common colors.

code: void CreateColorMap()


className: Cyan

code: static const [FColor](API\Runtime\Core\Math\FColor) Cyan;


className: DarkBrown

code: static const [FColor](API\Runtime\Core\Math\FColor) DarkBrown;


className: DarkGreen

code: static const [FColor](API\Runtime\Core\Math\FColor) DarkGreen;


className: DarkGreenCopper

code: static const [FColor](API\Runtime\Core\Math\FColor) DarkGreenCopper;


className: DarkOliveGreen

code: static const [FColor](API\Runtime\Core\Math\FColor) DarkOliveGreen;


className: DarkOrchid

code: static const [FColor](API\Runtime\Core\Math\FColor) DarkOrchid;


className: DarkPurple

code: static const [FColor](API\Runtime\Core\Math\FColor) DarkPurple;


className: DarkSlateBlue

code: static const [FColor](API\Runtime\Core\Math\FColor) DarkSlateBlue;


className: DarkSlateGrey

code: static const [FColor](API\Runtime\Core\Math\FColor) DarkSlateGrey;


className: DarkTan

code: static const [FColor](API\Runtime\Core\Math\FColor) DarkTan;


className: DarkTurquoise

code: static const [FColor](API\Runtime\Core\Math\FColor) DarkTurquoise;


className: DarkWood

code: static const [FColor](API\Runtime\Core\Math\FColor) DarkWood;


className: DimGrey

code: static const [FColor](API\Runtime\Core\Math\FColor) DimGrey;


className: DustyRose

code: static const [FColor](API\Runtime\Core\Math\FColor) DustyRose;


className: Feldspar

code: static const [FColor](API\Runtime\Core\Math\FColor) Feldspar;


className: Firebrick

code: static const [FColor](API\Runtime\Core\Math\FColor) Firebrick;


className: ForestGreen

code: static const [FColor](API\Runtime\Core\Math\FColor) ForestGreen;


description: Returns index of color based on ColorName. If not found returns 0.

code: int32 GetColorIndex ( const TCHAR * ColorName ) const


description: Returns color's name based on index. If index is invalid, returns BadIndex.

code: const [FString](API\Runtime\Core\Containers\FString) & GetColorNameByIndex ( int32 ColorIndex ) const


description: Returns the number of colors.

code: int32 GetColorsNum() const


description: Returns a color based on index. If index is invalid, returns White.

code: const [FColor](API\Runtime\Core\Math\FColor) & GetFColorByIndex ( int32 ColorIndex ) const


description: Returns a color based on ColorName. If not found, returns White.

code: const [FColor](API\Runtime\Core\Math\FColor) & GetFColorByName ( const TCHAR * ColorName ) const


description: Returns a linear color based on ColorName. If not found, returns White.

code: const [FLinearColor](API\Runtime\Core\Math\FLinearColor) GetFLinearColorByName ( const TCHAR * ColorName ) const


className: Gold

code: static const [FColor](API\Runtime\Core\Math\FColor) Gold;


className: Goldenrod

code: static const [FColor](API\Runtime\Core\Math\FColor) Goldenrod;


className: Green

code: static const [FColor](API\Runtime\Core\Math\FColor) Green;


className: GreenCopper

code: static const [FColor](API\Runtime\Core\Math\FColor) GreenCopper;


className: Grey

code: static const [FColor](API\Runtime\Core\Math\FColor) Grey;


className: GreenYellow

code: static const [FColor](API\Runtime\Core\Math\FColor) GreenYellow;


className: HunterGreen

code: static const [FColor](API\Runtime\Core\Math\FColor) HunterGreen;


className: IndianRed

code: static const [FColor](API\Runtime\Core\Math\FColor) IndianRed;


code: void InitializeColor ( const TCHAR * ColorName, const [FColor](API\Runtime\Core\Math\FColor) * ColorPtr, int32 & CurrentIndex )


description: Returns true if color is valid common colors. If not found returns false.

code: bool IsValidColorName ( const TCHAR * ColorName ) const


className: Khaki

code: static const [FColor](API\Runtime\Core\Math\FColor) Khaki;


className: LightBlue

code: static const [FColor](API\Runtime\Core\Math\FColor) LightBlue;


className: LightGrey

code: static const [FColor](API\Runtime\Core\Math\FColor) LightGrey;


className: LightSteelBlue

code: static const [FColor](API\Runtime\Core\Math\FColor) LightSteelBlue;


className: LightWood

code: static const [FColor](API\Runtime\Core\Math\FColor) LightWood;


className: LimeGreen

code: static const [FColor](API\Runtime\Core\Math\FColor) LimeGreen;


description: Prints to log all colors information.

code: void LogColors()


className: Magenta

code: static const [FColor](API\Runtime\Core\Math\FColor) Magenta;


className: MandarianOrange

code: static const [FColor](API\Runtime\Core\Math\FColor) MandarianOrange;


className: Maroon

code: static const [FColor](API\Runtime\Core\Math\FColor) Maroon;


className: MediumBlue

code: static const [FColor](API\Runtime\Core\Math\FColor) MediumBlue;


className: MediumForestGreen

code: static const [FColor](API\Runtime\Core\Math\FColor) MediumForestGreen;


className: MediumGoldenrod

code: static const [FColor](API\Runtime\Core\Math\FColor) MediumGoldenrod;


className: MediumOrchid

code: static const [FColor](API\Runtime\Core\Math\FColor) MediumOrchid;


className: MediumSeaGreen

code: static const [FColor](API\Runtime\Core\Math\FColor) MediumSeaGreen;


className: MediumSlateBlue

code: static const [FColor](API\Runtime\Core\Math\FColor) MediumSlateBlue;


className: MediumAquamarine

code: static const [FColor](API\Runtime\Core\Math\FColor) MediumAquamarine;


className: MediumSpringGreen

code: static const [FColor](API\Runtime\Core\Math\FColor) MediumSpringGreen;


className: MediumTurquoise

code: static const [FColor](API\Runtime\Core\Math\FColor) MediumTurquoise;


className: MediumVioletRed

code: static const [FColor](API\Runtime\Core\Math\FColor) MediumVioletRed;


className: MediumWood

code: static const [FColor](API\Runtime\Core\Math\FColor) MediumWood;


className: MidnightBlue

code: static const [FColor](API\Runtime\Core\Math\FColor) MidnightBlue;


className: NavyBlue

code: static const [FColor](API\Runtime\Core\Math\FColor) NavyBlue;


className: NeonBlue

code: static const [FColor](API\Runtime\Core\Math\FColor) NeonBlue;


className: NeonPink

code: static const [FColor](API\Runtime\Core\Math\FColor) NeonPink;


className: NewMidnightBlue

code: static const [FColor](API\Runtime\Core\Math\FColor) NewMidnightBlue;


className: OldGold

code: static const [FColor](API\Runtime\Core\Math\FColor) OldGold;


className: NewTan

code: static const [FColor](API\Runtime\Core\Math\FColor) NewTan;


className: Orange

code: static const [FColor](API\Runtime\Core\Math\FColor) Orange;


className: OrangeRed

code: static const [FColor](API\Runtime\Core\Math\FColor) OrangeRed;


className: Orchid

code: static const [FColor](API\Runtime\Core\Math\FColor) Orchid;


className: PaleGreen

code: static const [FColor](API\Runtime\Core\Math\FColor) PaleGreen;


className: Pink

code: static const [FColor](API\Runtime\Core\Math\FColor) Pink;


className: Plum

code: static const [FColor](API\Runtime\Core\Math\FColor) Plum;


className: Quartz

code: static const [FColor](API\Runtime\Core\Math\FColor) Quartz;


className: Red

code: static const [FColor](API\Runtime\Core\Math\FColor) Red;


className: RichBlue

code: static const [FColor](API\Runtime\Core\Math\FColor) RichBlue;


className: Salmon

code: static const [FColor](API\Runtime\Core\Math\FColor) Salmon;


className: Scarlet

code: static const [FColor](API\Runtime\Core\Math\FColor) Scarlet;


className: SeaGreen

code: static const [FColor](API\Runtime\Core\Math\FColor) SeaGreen;


className: SemiSweetChocolate

code: static const [FColor](API\Runtime\Core\Math\FColor) SemiSweetChocolate;


className: Sienna

code: static const [FColor](API\Runtime\Core\Math\FColor) Sienna;


className: Silver

code: static const [FColor](API\Runtime\Core\Math\FColor) Silver;


className: SkyBlue

code: static const [FColor](API\Runtime\Core\Math\FColor) SkyBlue;


className: SlateBlue

code: static const [FColor](API\Runtime\Core\Math\FColor) SlateBlue;


className: SpicyPink

code: static const [FColor](API\Runtime\Core\Math\FColor) SpicyPink;


className: SpringGreen

code: static const [FColor](API\Runtime\Core\Math\FColor) SpringGreen;


className: SteelBlue

code: static const [FColor](API\Runtime\Core\Math\FColor) SteelBlue;


className: SummerSky

code: static const [FColor](API\Runtime\Core\Math\FColor) SummerSky;


className: Tan

code: static const [FColor](API\Runtime\Core\Math\FColor) Tan;


className: TColorsLookup

code: typedef [TArray](API\Runtime\Core\Containers\TArray)< const [FColor](API\Runtime\Core\Math\FColor) * > TColorsLookup


className: TColorsMap

code: typedef [TMap](API\Runtime\Core\Containers\TMap)< [FString](API\Runtime\Core\Containers\FString), const [FColor](API\Runtime\Core\Math\FColor) * > TColorsMap