code: void operator<< ( [FString](API\Runtime\Core\Containers\FString) & Value )


module: Core

code: void operator<< ( [FName](API\Runtime\Core\UObject\FName) & Value )


code: void operator<< ( [UObject](API\Runtime\CoreUObject\UObject\UObject) *& Value )


code: void operator<< ( [FText](API\Runtime\Core\Internationalization\FText) & Value )


code: void operator<< ( [FWeakObjectPtr](API\Runtime\CoreUObject\UObject\FWeakObjectPtr) & Value )


code: void operator<< ( [FSoftObjectPtr](API\Runtime\CoreUObject\UObject\FSoftObjectPtr) & Value )


code: void operator<< ( [FLazyObjectPtr](API\Runtime\CoreUObject\UObject\FLazyObjectPtr) & Value )


code: void operator<< ( [FObjectPtr](API\Runtime\CoreUObject\UObject\FObjectPtr) & Value )


code: void operator<< ( [FSoftObjectPath](API\Runtime\CoreUObject\UObject\FSoftObjectPath) & Value )


code: template<typename T> void operator<< ( [TEnumAsByte](API\Runtime\Core\Containers\TEnumAsByte)< T > & Value )


code: template<typename EnumType, std::enable_if_t< [TIsEnumClass](API\Runtime\Core\Templates\TIsEnumClass)< EnumType >::Value, int >> void operator<< ( EnumType & Value )


code: template<typename T> void operator<< ( [UE::StructuredArchive::Private::TNamedAttribute](API\Runtime\Core\Serialization\TNamedAttribute)< T > Item )


code: template<typename T> void operator<< ( [UE::StructuredArchive::Private::TOptionalNamedAttribute](API\Runtime\Core\Serialization\TOptionalNamedAttribute)< T > Item )


code: void Serialize ( [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & Data )


code: void Serialize ( void * Data, uint64 DataSize )


code: [TOptional](API\Runtime\Core\IO\TOptional)< [FStructuredArchiveSlot](API\Runtime\Core\Serialization\FStructuredArchiveSlot) > TryEnterAttribute ( [FArchiveFieldName](API\Runtime\Core\Serialization\FArchiveFieldName) AttributeName, bool bEnterWhenWriting )


className: FStructuredArchiveSlot

description: Contains a value in the archive; either a field or array/map element. A slot does not know it's name or location, and can merely have a value serialized into it. That value may be a literal (eg. int, float) or compound object (eg. object, array, map).

code: class FStructuredArchiveSlot : public [UE::StructuredArchive::Private::FSlotBase](API\Runtime\Core\Serialization\FSlotBase)


code: template<typename T> [FStructuredArchiveStream](API\Runtime\Core\Serialization\FStructuredArchiveStream) & operator<< ( T & Item )


className: FStructuredArchiveStream

description: Represents an unsized sequence of slots in the structured archive (similar to an array, but without a known size).

code: class FStructuredArchiveStream : public [UE::StructuredArchive::Private::FSlotBase](API\Runtime\Core\Serialization\FSlotBase)


className: FDestroyFunc

code: typedef void( FDestroyFunc


className: FAppendHashFunc

code: typedef uint32( FAppendHashFunc


className: FGetDefaultFunc

code: typedef const void *( FGetDefaultFunc


className: FGetTargetAlignmentFunc

code: typedef uint32( FGetTargetAlignmentFunc


code: static const [FTypeLayoutDesc](API\Runtime\Core\Serialization\FTypeLayoutDesc) * Find ( uint64 NameHash )


className: FToStringFunc

code: typedef void( FToStringFunc


className: FUnfrozenCopyFunc

code: typedef uint32( FUnfrozenCopyFunc


code: static const [FTypeLayoutDesc](API\Runtime\Core\Serialization\FTypeLayoutDesc) & GetInvalidTypeLayout()


code: uint32 GetOffsetToBase ( const [FTypeLayoutDesc](API\Runtime\Core\Serialization\FTypeLayoutDesc) & BaseTypeDesc ) const


code: static void Initialize ( [FTypeLayoutDesc](API\Runtime\Core\Serialization\FTypeLayoutDesc) & TypeDesc )


code: static void Register ( [FTypeLayoutDesc](API\Runtime\Core\Serialization\FTypeLayoutDesc) & TypeDesc )


code: bool IsDerivedFrom ( const [FTypeLayoutDesc](API\Runtime\Core\Serialization\FTypeLayoutDesc) & BaseTypeDesc ) const


className: FTypeLayoutDesc

code: struct FTypeLayoutDesc

AppendHashFunc

type: FAppendHashFunc...

DestroyFunc

type: FDestroyFunc&#...

Fields

type: constFFieldLay...

GetDefaultObjectFunc

type: FGetDefaultFunc...

GetTargetAlignmentFunc

type: FGetTargetAlign...

HashNext

type: constFTypeLayo...

Interface

type: ETypeLayoutInte...

IsInitialized

type: uint8:  1

Name

type: const TCHAR ...

ToStringFunc

type: FToStringFunc&...

UnfrozenCopyFunc

type: FUnfrozenCopyFu...

WriteFrozenMemoryImageFunc

type: FWriteFrozenMem...


className: FVoidPtrTable

code: class FVoidPtrTable : public [TPtrTableBase< void, void * >](API\Runtime\Core\Serialization\TPtrTableBase)


description: Downcast function for IPackageWriters that implement the ICookedPackageWriters inherited interface.

code: virtual [ICookedPackageWriter](API\Runtime\Core\Serialization\ICookedPackageWriter) * AsCookedPackageWriter()


description: Downcast function for ICookedPackageWriters that implement theIPackageStoreWriterinherited interface.

code: virtual [IPackageStoreWriter](API\Developer\IoStoreUtilities\IPackageStoreWriter) * AsPackageStoreWriter()


code: virtual EPackageWriterResult BeginCacheForCookedPlatformData ( [FBeginCacheForCookedPlatformDataInfo](API\Runtime\Core\Serialization\ICookedPackageWriter\FBeginCacheForCo-) & Info )


description: Package data may only be produced afterBeginCook()has been called and beforeEndCook()is called

code: void BeginCook ( const [FCookInfo](API\Runtime\Core\Serialization\ICookedPackageWriter\FCookInfo) & Info )


description: Append all data to the Exports archive that would normally be done in CommitPackage, used for diffing.

code: virtual void CompleteExportsArchiveForDiff ( [FPackageInfo](API\Runtime\Core\Serialization\IPackageWriter\FPackageInfo) & Info, [FLargeMemoryWriter](API\Runtime\Core\Serialization\FLargeMemoryWriter) & ExportsArchive )


description: Signal the end of a cooking pass.

code: void EndCook ( const [FCookInfo](API\Runtime\Core\Serialization\ICookedPackageWriter\FCookInfo) & Info )


className: EPackageHeaderFormat

code: enum EPackageHeaderFormat { PackageFileSummary, ZenPackageSummary, }


className: FBeginCacheCallback

description: Helper callback type for Writers that need to send the message on toUCookOnTheFlyServer.


className: FBeginCacheForCookedPlatformDataInfo

PackageName

type: FName

SaveableObjects

type: TConstArrayView...

TargetPlatform

type: constITargetPl...


className: FCookCapabilities

code: struct FCookCapabilities

bDiffModeSupported

type: bool

description: Whether this writer implements -diffonly and -linkerdiff.

HeaderFormat

type: EPackageHeaderF...

description: What header format is produced as output by this writer.


className: ECookMode

code: enum ECookMode { CookByTheBookMode, CookOnTheFlyMode, }


className: FCookInfo

code: struct FCookInfo

CookMode

type: ECookMode


className: FPreviousCookedBytesData

code: struct FPreviousCookedBytesData

Data

type: TUniquePtr< uin...


description: Return cook capabilities/settings this PackageWriter has/requires


description: Returns an Attachment that was previously commited for the given PackageName. Returns an empty object if not found.

code: [FCbObject](API\Runtime\Core\Serialization\FCbObject) GetOplogAttachment ( [FName](API\Runtime\Core\UObject\FName) PackageName, FUtf8StringView AttachmentKey )


description: Cooked package writers asynchronously hash the chunks for each package after CommitPackage. Once cooking has completed, use this to acquire the results. This is synced using voidUPackage::WaitForAsyncFileWrites()- do not access the results before that completes. Non-const so that the cooking process can Move the map of hashes.

code: [TMap](API\Runtime\Core\Containers\TMap)< [FName](API\Runtime\Core\UObject\FName), [TRefCountPtr](API\Runtime\Core\Templates\TRefCountPtr)< [FPackageHashes](API\Runtime\Core\Serialization\FPackageHashes) > > & GetPackageHashes()


description: Load the bytes of the previously-cooked package, used for diffing

code: virtual bool GetPreviousCookedBytes ( const [FPackageInfo](API\Runtime\Core\Serialization\IPackageWriter\FPackageInfo) & Info, [FPreviousCookedBytesData](API\Runtime\Core\Serialization\ICookedPackageWriter\FPreviousCookedBytesData) & OutData )


description: Return the timestamp of the previous cook, orFDateTime::MaxValueto indicate previous cook should be assumed newer than any other cook data.

code: virtual [FDateTime](API\Runtime\Core\Misc\FDateTime) GetPreviousCookTime() const


description: Delete outdated cooked data, etc.

code: void Initialize ( const [FCookInfo](API\Runtime\Core\Serialization\ICookedPackageWriter\FCookInfo) & Info )


description: Report whether an additional save is needed and set up for it if so. Used for diffing.

code: virtual bool IsAnotherSaveNeeded ( [FSavePackageResultStruct](API\Runtime\CoreUObject\UObject\FSavePackageResultStruct) & PreviousResult, [FSavePackageArgs](API\Runtime\CoreUObject\UObject\FSavePackageArgs) & SaveArgs )


description: Signal the given cooked package(s) have been checked for changes and have not been modified since the last cook.

code: void MarkPackagesUpToDate ( [TArrayView](API\Runtime\Core\Containers\TArrayView)< const [FName](API\Runtime\Core\UObject\FName) > UpToDatePackages )


description: Returns an AssetRegistry describing the previous cook results. This doesn't mean a cook saved off to another directory - it means the AssetRegistry that's living in the directory we are about to cook in to.


description: Remove all cooked packages from storage.

code: void RemoveCookedPackages()


description: Remove the given cooked package(s) from storage; they have been modified since the last cook.

code: void RemoveCookedPackages ( [TArrayView](API\Runtime\Core\Containers\TArrayView)< const [FName](API\Runtime\Core\UObject\FName) > PackageNamesToRemove )


description: Read PackageData written by WriteMPCookMessageForPackage on a CookWorker. Called only on CookDirector.

code: bool TryReadMPCookMessageForPackage ( [FName](API\Runtime\Core\UObject\FName) PackageName, [FCbObjectView](API\Runtime\Core\Serialization\FCbObjectView) Message )


description: Modify the SaveArgs if required before the first Save. Used for diffing.

code: virtual void UpdateSaveArguments ( [FSavePackageArgs](API\Runtime\CoreUObject\UObject\FSavePackageArgs) & SaveArgs )


description: Asynchronously create a CompactBinary Object message that replicates all of the package data from package save that is collected in memory and written at end of cook rather than being written to disk during package save. Used during MPCook to transfer this information from CookWorker to CookDirector. Called after CommitPackage, and only on CookWorkers.

code: [TFuture](API\Runtime\Core\Async\TFuture)< [FCbObject](API\Runtime\Core\Serialization\FCbObject) > WriteMPCookMessageForPackage ( [FName](API\Runtime\Core\UObject\FName) PackageName )


className: ICookedPackageWriter

description: Interface for cooking that writes cooked packages to storage usable by the runtime game.

code: class ICookedPackageWriter : public [IPackageWriter](API\Runtime\Core\Serialization\IPackageWriter)


description: Downcast function for IPackageWriters that implement the ICookedPackageWriters inherited interface.

code: virtual [ICookedPackageWriter](API\Runtime\Core\Serialization\ICookedPackageWriter) * AsCookedPackageWriter()


description: This must be called before any data is produced for a given package

code: void BeginPackage ( const [FBeginPackageInfo](API\Runtime\Core\Serialization\IPackageWriter\FBeginPackageInfo) & Info )


description: Finalize a package started withBeginPackage()

code: void CommitPackage ( [FCommitPackageInfo](API\Runtime\Core\Serialization\IPackageWriter\FCommitPackageInfo) && Info )


description: Create theFLargeMemoryWriterto which the Header and Exports are written during the save.

code: virtual [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< [FLargeMemoryWriter](API\Runtime\Core\Serialization\FLargeMemoryWriter) > CreateLinkerArchive ( [FName](API\Runtime\Core\UObject\FName) PackageName, [UObject](API\Runtime\CoreUObject\UObject\UObject) * Asset, uint16 MultiOutputIndex )


description: Returns an archive to be used when serializing exports.

code: virtual [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< [FLargeMemoryWriter](API\Runtime\Core\Serialization\FLargeMemoryWriter) > CreateLinkerExportsArchive ( [FName](API\Runtime\Core\UObject\FName) PackageName, [UObject](API\Runtime\CoreUObject\UObject\UObject) * Asset, uint16 MultiOutputIndex )


className: ECommitStatus

code: enum ECommitStatus { Success, Canceled, Error, }


className: EWriteOptions

code: enum EWriteOptions { None = 0, WritePackage = 0x01, WriteSidecars = 0x02, Write = WritePackage | WriteSidecars, ComputeHash = 0x04, SaveForDiff = 0x08, }


className: FBeginPackageInfo

description: Events the PackageWriter receives.

code: struct FBeginPackageInfo

LooseFilePath

type: FString


className: FAdditionalFileInfo

code: struct FAdditionalFileInfo

ChunkId

type: FIoChunkId

PackageName

description: Associated Package Name Entry


className: EType

code: enum EType { AppendToExports, BulkSegment, Mmap, Optional, NumTypes, }


className: FBulkDataInfo

code: struct FBulkDataInfo

BulkDataType

type: EType

description: Associated Package Name Entry


className: FCapabilities

code: struct FCapabilities

bDeclareRegionForEachAdditionalFile

description: Whether an entry should be created for each BulkData stored in the BulkData section This is necessary for some Writers that need to be able to load the BulkDatas individually.

bIgnoreHeaderDiffs

description: Applicable only to -diffonly saves; suppresses output and breakpoints for diffs in the header.


className: FCommitPackageInfo

code: struct FCommitPackageInfo

Attachments

type: TArray<FCommit...

PackageGuid

type: FGuid

Status

type: ECommitStatus

WriteOptions

type: EWriteOptions


className: FCommitAttachmentInfo

code: struct FCommitAttachmentInfo

Value

type: FCbObject


className: FLinkerAdditionalDataInfo

code: struct FLinkerAdditionalDataInfo

PackageName

description: Associated Package Name Entry


className: FPackageInfo

code: struct FPackageInfo

description: Associated Package Name Entry from BeginPackage


className: FPackageTrailerInfo

code: struct FPackageTrailerInfo


description: Return capabilities/settings this PackageWriter has/requires

code: virtual [FCapabilities](API\Runtime\Core\Serialization\IPackageWriter\FCapabilities) GetCapabilities() const


description: Report the size of the Footer that is added after Exports and BulkData but before the PackageTrailer

code: virtual int64 GetExportsFooterSize()


description: Report whether PreSave was already called by the PackageWriter before the currentUPackage::Savecall.

code: virtual bool IsPreSaveCompleted() const


description: Write separate files written by UObjects during cooking viaUObject::CookAdditionalFiles.

code: void WriteAdditionalFile ( const [FAdditionalFileInfo](API\Runtime\Core\Serialization\IPackageWriter\FAdditionalFileInfo) & Info, const [FIoBuffer](API\Runtime\Core\IO\FIoBuffer) & FileData )


description: Write bulk data for the current package

code: void WriteBulkData ( const [FBulkDataInfo](API\Runtime\Core\Serialization\IPackageWriter\FBulkDataInfo) & Info, const [FIoBuffer](API\Runtime\Core\IO\FIoBuffer) & BulkData, const [TArray](API\Runtime\Core\Containers\TArray)< [FFileRegion](API\Runtime\Core\Serialization\FFileRegion) > & FileRegions )


description: Write separate data written by UObjects viaFLinkerSave::AdditionalDataToAppend.

code: void WriteLinkerAdditionalData ( const [FLinkerAdditionalDataInfo](API\Runtime\Core\Serialization\IPackageWriter\FLinkerAdditionalDataInfo) & Info, const [FIoBuffer](API\Runtime\Core\IO\FIoBuffer) & Data, const [TArray](API\Runtime\Core\Containers\TArray)< [FFileRegion](API\Runtime\Core\Serialization\FFileRegion) > & FileRegions )


description: This may only be called after aBeginPackage()call has been made to signal the start of a package store transaction

code: void WritePackageData ( const [FPackageInfo](API\Runtime\Core\Serialization\IPackageWriter\FPackageInfo) & Info, [FLargeMemoryWriter](API\Runtime\Core\Serialization\FLargeMemoryWriter) & ExportsArchive, const [TArray](API\Runtime\Core\Containers\TArray)< [FFileRegion](API\Runtime\Core\Serialization\FFileRegion) > & FileRegions )


description: Write the PackageTrailer, a separate segment for some bulkdata that is written the end of the file.

code: void WritePackageTrailer ( const [FPackageTrailerInfo](API\Runtime\Core\Serialization\IPackageWriter\FPackageTrailerInfo) & Info, const [FIoBuffer](API\Runtime\Core\IO\FIoBuffer) & Data )


className: IPackageWriter

description: Interface for SavePackage to write packages to storage.

code: class IPackageWriter


className: ArrayType

code: typedef [TArray](API\Runtime\Core\Containers\TArray)< uint8, [TSizedDefaultAllocator](API\Runtime\Core\Containers\TSizedDefaultAllocator)< IndexSize >> ArrayType


description: This is overridden for the specific Archive Types

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


className: TBufferArchive

description: Buffer archiver.

code: template<int IndexSize> class TBufferArchive : public [TMemoryWriter< IndexSize >](API\Runtime\Core\Serialization\TMemoryWriter), public [TArray< uint8, TSizedDefaultAllocator< IndexSize > >](API\Runtime\Core\Containers\TArray)


code: TBufferArchive ( bool bIsPersistent, const [FName](API\Runtime\Core\UObject\FName) InArchiveName )


description: DO NOT USE DIRECTLY. These functions enable range-based for loop support.


description: Returns the value as a view.

code: const ViewType & AsView() const


description: Create an iterator for the fields of an array or object, otherwise an empty iterator.


description: The outer buffer might contain other data before and/or after this value. Use GetBuffer to request a buffer that exactly contains this value, or TryGetView for a contiguous view.

code: const [FSharedBuffer](API\Runtime\Core\Memory\FSharedBuffer) & GetOuterBuffer() const


code: constexpr [FCbIteratorSentinel](API\Runtime\Core\Serialization\FCbIteratorSentinel) end() const


description: Whether this reference has ownership of the memory in its buffer.

code: bool IsOwned() const


description: Clone the value, if necessary, to a buffer that this reference has ownership of.

code: void MakeOwned()


description: Find a field of an object by case-sensitive name comparison, otherwise a field with no value.

code: [FCbField](API\Runtime\Core\Serialization\FCbField) operator[] ( FUtf8StringView Name ) const


description: Reset this to a default value and null buffer.

code: void Reset()


description: Construct a default value.

code: TCbBuffer()


description: Construct a value from a pointer to its data and an optional externally-provided type.

code: TCbBuffer ( [FSharedBuffer](API\Runtime\Core\Memory\FSharedBuffer) ValueBuffer, ECbFieldType Type )


description: Construct a value that holds a reference to the buffer that contains it.

code: TCbBuffer ( const ViewType & Value, [FSharedBuffer](API\Runtime\Core\Memory\FSharedBuffer) OuterBuffer )


description: Construct a value that holds a reference to the buffer of the outer that contains it.

code: template<typename OtherViewType> TCbBuffer ( const ViewType & Value, [TCbBuffer](API\Runtime\Core\Serialization\TCbBuffer)< OtherViewType > OuterBuffer )


className: TCbBuffer

description: A wrapper that holds a reference to the buffer that contains its compact binary value.

code: template<typename ViewType> class TCbBuffer : public ViewType


description: Construct a value from an owned clone of its memory.

code: static Type Clone ( const void *const Data )


code: static Type Clone ( const ViewType & Value )


description: Construct a value from a read-only view of its memory and its optional outer buffer.

code: static Type MakeView ( const void *const Data, [FSharedBuffer](API\Runtime\Core\Memory\FSharedBuffer) OuterBuffer )


code: static Type MakeView ( const ViewType & Value, [FSharedBuffer](API\Runtime\Core\Memory\FSharedBuffer) OuterBuffer )


className: TCbBufferFactory

description: This uses the curiously recurring template pattern to construct the correct derived type, that must inherit fromTCbBufferand this type to expose the factory functions.

code: template<typename Type, typename ViewType> class TCbBufferFactory


description: Append the hash of every field in the range.

code: void AppendRangeHash ( [FIoHashBuilder](API\Runtime\Core\IO\FIoHashBuilder) & Builder ) const


code: constexpr [TCbFieldIterator](API\Runtime\Core\Serialization\TCbFieldIterator) begin() const


description: Copy the field range into a buffer of exactlyGetRangeSize()bytes.

code: void CopyRangeTo ( FMutableMemoryView Buffer ) const


description: Copy the field range into an archive, as if calling CopyTo on every field.

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


code: constexpr [FCbIteratorSentinel](API\Runtime\Core\Serialization\FCbIteratorSentinel) end() const


code: template<typename OtherFieldType> constexpr bool Equals ( const [TCbFieldIterator](API\Runtime\Core\Serialization\TCbFieldIterator)< OtherFieldType > & Other ) const


description: Returns the end of the last field, or null for an iterator at the end.

code: template<typename OtherFieldType> static const void * GetFieldsEnd ( const [TCbFieldIterator](API\Runtime\Core\Serialization\TCbFieldIterator)< OtherFieldType > & It )


description: Calculate the hash of every field in the range.


description: Returns the size of the fields in the range in bytes.

code: uint64 GetRangeSize() const


description: Invoke the visitor for every attachment in the field range.

code: void IterateRangeAttachments ( FCbFieldVisitor Visitor ) const


code: template<typename OtherFieldType> constexpr bool operator== ( const [TCbFieldIterator](API\Runtime\Core\Serialization\TCbFieldIterator)< OtherFieldType > & Other ) const


code: constexpr bool operator== ( const [FCbIteratorSentinel](API\Runtime\Core\Serialization\FCbIteratorSentinel) & ) const


code: template<typename OtherFieldType> constexpr bool operator!= ( const [TCbFieldIterator](API\Runtime\Core\Serialization\TCbFieldIterator)< OtherFieldType > & Other ) const


code: constexpr bool operator!= ( const [FCbIteratorSentinel](API\Runtime\Core\Serialization\FCbIteratorSentinel) & ) const


code: [TCbFieldIterator](API\Runtime\Core\Serialization\TCbFieldIterator) operator++ ( int )


description: Reset this to an empty field range.

code: void Reset()


description: A view is available if each field contains its type. Access the equivalent for other field ranges throughFCbFieldIterator::CloneRangeor CopyRangeTo.

code: bool TryGetRangeView ( FMemoryView & OutView ) const


description: Construct an empty field range.

code: constexpr TCbFieldIterator()


description: Construct a field range that contains exactly one field.

code: constexpr TCbFieldIterator ( FieldType InField )


description: Construct a field range from the first field and a pointer to the end of the last field.

code: constexpr TCbFieldIterator ( FieldType && InField, const void * InFieldsEnd )


className: TCbFieldIterator

description: The iterator represents a range of fields from the current field to the last field.

code: template<typename FieldType> class TCbFieldIterator : public FieldType


code: [TCbWriter](API\Runtime\Core\Serialization\TCbWriter) & operator= ( const [TCbWriter](API\Runtime\Core\Serialization\TCbWriter) & )


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


className: TCbWriter

description: FCbWriter

code: template<uint32 InlineBufferSize> class TCbWriter : public [FCbWriter](API\Runtime\Core\Serialization\FCbWriter)


description:
Retrieves a writable/serializable reference to the pointer
Returns a reference to the pointer

code: T *& Get()


description:
Whether or not there was an error during the previous serialization. This occurs if an object was successfully serialized, but with the wrong base class (which net serialization may have to recover from, if there was supposed to be data serialized along with the object)
Whether or not there was an error

code: bool IsError() const


description:
Whether or not the pointer is valid/non-null
Whether or not the pointer is valid

code: bool IsValid() const


description:
Returns the object pointer, for accessing members of the object
Returns the object pointer

code: T * operator->() const


description: Assigns a value to the object pointer

code: [TCheckedObjPtr](API\Runtime\Core\Serialization\TCheckedObjPtr) & operator= ( T * InObject )


className: TCheckedObjPtr

description: Wrapper forUObjectpointers, which checks that the base class is accurate, upon serializing (to prevent illegal casting)

code: template<class T> class TCheckedObjPtr


code: template<typename InternalType> static InternalType::DerivedType Test ( const typename InternalType::DerivedType * )


code: template<typename InternalType> static void Test ( ... )


className: Type

code: typedef decltype([Test](API\Runtime\Core\Serialization\TGetBaseTypeHelper\Test\1)< T >(nullptr)) Type


className: TGetBaseTypeHelper

code: template<typename T> struct TGetBaseTypeHelper


className: TGetDefaultObjectHelper< T, ETypeLayoutInterface::Virtual >::Do

code: static const void &42; Do&40;&41;


code: namespace TGetDefaultObjectHelper< T, ETypeLayoutInterface { template<typename T> struct TGetDefaultObjectHelper< T, ETypeLayoutInterface::Virtual > }


className: TGetDefaultObjectHelper

description: TGetDefaultObjectHelper< T, ETypeLayoutInterface::Virtual >

code: template<typename T, [ETypeLayoutInterface::Type](API\Runtime\Core\Serialization\ETypeLayoutInterface__Type) InterfaceType> struct TGetDefaultObjectHelper


className: TGetFreezeImageFieldHelper

code: template<typename T, bool bProvidesStaticStruct> struct TGetFreezeImageFieldHelper


className: TGetFreezeImageHelper

code: template<typename T, bool bUsePropertyFreezing> struct TGetFreezeImageHelper


code: static const [FTypeLayoutDesc](API\Runtime\Core\Serialization\FTypeLayoutDesc) & Do ( const T & Object )


className: TGetTypeLayoutHelper

code: template<typename T> struct TGetTypeLayoutHelper


className: TGetTypeLayoutHelper<                          bool >::Do

code: static const FTypeLayoutDesc & Do &40; const bool & &41;


className: TGetTypeLayoutHelper<                          bool >

code: template<> struct TGetTypeLayoutHelper< bool >


className: TGetTypeLayoutHelper<                          char >::Do

code: static const FTypeLayoutDesc & Do &40; const char & &41;


className: TGetTypeLayoutHelper<                          char >

code: template<> struct TGetTypeLayoutHelper< char >


className: TGetTypeLayoutHelper<                          const T >

code: template<typename T> struct TGetTypeLayoutHelper< const T > : public [TGetTypeLayoutHelper< T >](API\Runtime\Core\Serialization\TGetTypeLayoutHelper)


className: TGetTypeLayoutHelper<                          double >::Do

code: static const FTypeLayoutDesc & Do &40; const double & &41;


className: TGetTypeLayoutHelper<                          double >

code: template<> struct TGetTypeLayoutHelper< double >


className: TGetTypeLayoutHelper<                          ETypeLayoutInterface::Type >::Do

code: static const FTypeLayoutDesc & Do &40; const ETypeLayoutInterface::Type & &41;


code: namespace TGetTypeLayoutHelper< ETypeLayoutInterface { template<> struct TGetTypeLayoutHelper< ETypeLayoutInterface::Type > }


code: template<> struct TGetTypeLayoutHelper< FHashedNameDebugString >


className: TGetTypeLayoutHelper<                          FHashedNameDebugString >::Do

code: static const FTypeLayoutDesc & Do &40; const FHashedNameDebugString & &41;


className: TGetTypeLayoutHelper<                          float >::Do

code: static const FTypeLayoutDesc & Do &40; const float & &41;


className: TGetTypeLayoutHelper<                          float >

code: template<> struct TGetTypeLayoutHelper< float >


className: TGetTypeLayoutHelper<                          FThreadSafeCounter >::Do

code: static const FTypeLayoutDesc & Do &40; const FThreadSafeCounter & &41;


code: template<> struct TGetTypeLayoutHelper< FThreadSafeCounter >


className: TGetTypeLayoutHelper<                          int >::Do

code: static const FTypeLayoutDesc & Do &40; const int & &41;


className: TGetTypeLayoutHelper<                          int >

code: template<> struct TGetTypeLayoutHelper< int >


className: TGetTypeLayoutHelper<                          int8 >::Do

code: static const FTypeLayoutDesc & Do &40; const int8 & &41;


className: TGetTypeLayoutHelper<                          int8 >

code: template<> struct TGetTypeLayoutHelper< int8 >


className: TGetTypeLayoutHelper<                          long >::Do

code: static const FTypeLayoutDesc & Do &40; const long & &41;


className: TGetTypeLayoutHelper<                          long >

code: template<> struct TGetTypeLayoutHelper< long >


className: TGetTypeLayoutHelper<                          long long >::Do

code: static const FTypeLayoutDesc & Do &40; const long long & &41;


className: TGetTypeLayoutHelper<                          short >::Do

code: static const FTypeLayoutDesc & Do &40; const short & &41;


className: TGetTypeLayoutHelper<                          short >

code: template<> struct TGetTypeLayoutHelper< short >


className: TGetTypeLayoutHelper<                          wchar_t >::Do

code: static const FTypeLayoutDesc & Do &40; const wchar_t & &41;


className: TGetTypeLayoutHelper<                          wchar_t >

code: template<> struct TGetTypeLayoutHelper< wchar_t >


className: Value

code: static constexpr bool Value = TModels_V<CProvidesDefaultUObject, T>;


className: THasCustomDefaultObject

code: template<typename T> struct THasCustomDefaultObject


code: static constexpr bool Value = TModels_V<CTypeLayout, T>;


className: THasTypeLayout

code: template<typename T> struct THasTypeLayout


className: THasTypeLayout<                          bool >

code: template<> struct THasTypeLayout< bool >


className: TGetTypeLayoutHelper<                          long long >

code: template<> struct TGetTypeLayoutHelper< long long >


className: THasTypeLayout<                          double >

code: template<> struct THasTypeLayout< double >


code: namespace THasTypeLayout< ETypeLayoutInterface { template<> struct THasTypeLayout< ETypeLayoutInterface::Type > }


code: template<> struct THasTypeLayout< FHashedNameDebugString >


className: THasTypeLayout<                          float >

code: template<> struct THasTypeLayout< float >


className: THasTypeLayout<                          FThreadSafeCounter >

code: template<> struct THasTypeLayout< FThreadSafeCounter >


className: THasTypeLayout<                          char >

code: template<> struct THasTypeLayout< char >


className: THasTypeLayout<                          int >

code: template<> struct THasTypeLayout< int >


className: THasTypeLayout<                          int8 >

code: template<> struct THasTypeLayout< int8 >


className: THasTypeLayout<                          long >

code: template<> struct THasTypeLayout< long >


className: THasTypeLayout<                          long long >

code: template<> struct THasTypeLayout< long long >


className: THasTypeLayout<                          short >

code: template<> struct THasTypeLayout< short >


className: THasTypeLayout<                          unsigned char >

code: template<> struct THasTypeLayout< unsigned char >


className: THasTypeLayout<                          unsigned int >

code: template<> struct THasTypeLayout< unsigned int >


className: THasTypeLayout<                          unsigned long >

code: template<> struct THasTypeLayout< unsigned long >


className: THasTypeLayout<                          unsigned long long >

code: template<> struct THasTypeLayout< unsigned long long >


className: THasTypeLayout<                          unsigned short >

code: template<> struct THasTypeLayout< unsigned short >


className: THasTypeLayout<                          void * >

code: template<> struct THasTypeLayout< void * >


className: THasTypeLayout<                          wchar_t >

code: template<> struct THasTypeLayout< wchar_t >


className: FPtrTable

code: typedef [TPtrTableBase](API\Runtime\Core\Serialization\TPtrTableBase)< T, PtrType > FPtrTable


code: T * Get ( const [FPtrTable](API\Runtime\Core\Serialization\TIndexedPtrBase\FPtrTable) & PtrTable ) const


code: T * Get ( const [FPointerTableBase](API\Runtime\Core\Serialization\FPointerTableBase) * PtrTable ) const


className: IsFrozenMask

code: enum { IsFrozenMask = (1 << 0) }


code: [TIndexedPtrBase](API\Runtime\Core\Serialization\TIndexedPtrBase) & operator= ( T * Rhs )


code: [TIndexedPtrBase](API\Runtime\Core\Serialization\TIndexedPtrBase) & operator= ( const PtrType & Rhs )


code: [TIndexedPtrBase](API\Runtime\Core\Serialization\TIndexedPtrBase) & operator= ( PtrType && Rhs )


code: TIndexedPtrBase ( const [TIndexedPtrBase](API\Runtime\Core\Serialization\TIndexedPtrBase)< T, PtrType > & Rhs, const [FPtrTable](API\Runtime\Core\Serialization\TIndexedPtrBase\FPtrTable) & InTable )


className: TIndexedPtrBase

description: Note that IndexedPtr types don't declare a default intrinsic type layout. Instead any required pointer types need to be declared/implemented using DECLARE_EXPORTED_TEMPLATE_INTRINSIC_TYPE_LAYOUT/IMPLEMENT_TEMPLATE_INTRINSIC_TYPE_LAYOUT. The TypeDesc of indexed pointers are compared for equality when adding to pointer tables, and it's possible for inline type layouts to generate multiple copies when referenced from multiple modules

code: template<typename T, typename PtrType> class TIndexedPtrBase

Ptr

type: PtrType


code: static void Initialize ( [FTypeLayoutDesc](API\Runtime\Core\Serialization\FTypeLayoutDesc) & TypeDesc )


className: TInitializeBaseHelper

description: TInitializeBaseHelper< T, void >

code: template<typename T, typename BaseType> struct TInitializeBaseHelper


className: TInitializeBaseHelper< T, void >::Initialize

code: static void Initialize &40; FTypeLayoutDesc & TypeDesc &41;


className: TInitializeBaseHelper< T, void >

code: template<typename T> struct TInitializeBaseHelper< T, void >


className: Value

code: static Value = TIsContiguousContainer<FBufferArchive::ArrayType>::Value;


description: Copy constructor requires an unfrozen source.

code: TIndexedPtrBase ( const [TIndexedPtrBase](API\Runtime\Core\Serialization\TIndexedPtrBase)< T, PtrType > & Rhs )


code: template<> struct TIsContiguousContainer< FBufferArchive >


code: static Value = TIsContiguousContainer<FBufferArchive64::ArrayType>::Value;


code: template<> struct TIsContiguousContainer< FBufferArchive64 >


code: template<> struct TIsContiguousContainer< FMemoryImageString >


description: This is overridden for the specific Archive Types

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


code: virtual void Serialize ( void * Data, int64 Num )


description: Returns total size of the backing data storage.

code: virtual int64 TotalSize()


className: TMemoryHasher

description: Archive for hashing arbitrary data

code: template<typename HashBuilder, typename HashDigest> class TMemoryHasher : public [FMemoryArchive](API\Runtime\Core\Serialization\FMemoryArchive)

BuilderState

type: HashBuilder

description: Context data needed to build the hash


code: int32 CalculateSlackGrow &40; int32 NumElements, int32 NumAllocatedElements, int32 NumBytesPerElement &41; const


code: int32 CalculateSlackGrow &40; int32 NumElements, int32 NumAllocatedElements, int32 NumBytesPerElement, uint32 AlignmentOfElement &41; const


code: int32 CalculateSlackReserve &40; int32 NumElements, int32 NumBytesPerElement &41; const


code: int32 CalculateSlackReserve &40; int32 NumElements, int32 NumBytesPerElement, uint32 AlignmentOfElement &41; const


code: int32 CalculateSlackShrink &40; int32 NumElements, int32 NumAllocatedElements, int32 NumBytesPerElement &41; const


code: void ResizeAllocation &40; int32 PreviousNumElements, int32 NumElements, SIZE_T NumBytesPerElement &41;


code: void ResizeAllocation &40; int32 PreviousNumElements, int32 NumElements, SIZE_T NumBytesPerElement, uint32 AlignmentOfElement &41;


code: void WriteMemoryImage &40; FMemoryImageWriter & Writer, const FTypeLayoutDesc & TypeDesc, int32 NumAllocatedElements &41; const


description: Default constructor.


className: ForAnyElementType

code: class ForAnyElementType : public [FMemoryImageAllocatorBase](API\Runtime\Core\Serialization\FMemoryImageAllocatorBase)


code: ElementType &42; GetAllocation&40;&41; const


code: int32 CalculateSlackShrink &40; int32 NumElements, int32 NumAllocatedElements, int32 NumBytesPerElement, uint32 AlignmentOfElement &41; const


className: ForElementType

code: template<typename ElementType> class ForElementType : public [TMemoryImageAllocator< Alignment >::ForAnyElementType](API\Runtime\Core\Serialization\TMemoryImageAllocator\ForAnyElementType)


className: NeedsElementType

code: enum { NeedsElementType = false }


className: RequireRangeCheck

code: enum { RequireRangeCheck = true }


className: SupportsFreezeMemoryImage

code: enum { SupportsFreezeMemoryImage = true }


className: TMemoryImageAllocator

code: template<uint32 Alignment> class TMemoryImageAllocator


code: void Destroy ( const [FPointerTableBase](API\Runtime\Core\Serialization\FPointerTableBase) * PointerTable )


description: Returns true if the frozen/unfrozen state of the object was changed.

code: bool Freeze ( [FPointerTableBase](API\Runtime\Core\Serialization\FPointerTableBase) * PointerTable )


code: bool Unfreeze ( const [FPointerTableBase](API\Runtime\Core\Serialization\FPointerTableBase) * PointerTable )


code: template<typename TOther> TMemoryImageObject ( TOther * InObject )


code: template<typename TOther> TMemoryImageObject ( const [TMemoryImageObject](API\Runtime\Core\Serialization\TMemoryImageObject)< TOther > & Rhs )


code: TMemoryImageObject ( const [FTypeLayoutDesc](API\Runtime\Core\Serialization\FTypeLayoutDesc) & InTypeDesc, T * InObject, uint32 InFrozenSize )


className: TMemoryImageObject

code: template<typename T> struct TMemoryImageObject

Object

type: T *

TypeDesc

type: constFTypeLayo...


code: int64 GetFrozenOffsetFromThis() const


className: TMemoryImagePtr::operator T *

code: operator T *() const


code: [TMemoryImagePtr](API\Runtime\Core\Serialization\TMemoryImagePtr) & operator= ( T * InPtr )


code: [TMemoryImagePtr](API\Runtime\Core\Serialization\TMemoryImagePtr) & operator= ( const [TMemoryImagePtr](API\Runtime\Core\Serialization\TMemoryImagePtr)< T > & InPtr )


code: void SafeDelete ( const [FPointerTableBase](API\Runtime\Core\Serialization\FPointerTableBase) * PtrTable )


code: void WriteMemoryImageWithDerivedType ( [FMemoryImageWriter](API\Runtime\Core\Serialization\FMemoryImageWriter) & Writer, const [FTypeLayoutDesc](API\Runtime\Core\Serialization\FTypeLayoutDesc) * DerivedTypeDesc ) const


code: TMemoryImagePtr ( const [TMemoryImagePtr](API\Runtime\Core\Serialization\TMemoryImagePtr)< T > & InPtr )


className: TMemoryImagePtr

code: template<typename T> class TMemoryImagePtr

type: union TMemoryIm...

Frozen

type: FFrozenMemoryIm...


className: IndexSizeType

code: typedef typename [TBitsToSizeType](API\Runtime\Core\Containers\TBitsToSizeType)< IndexSize >::Type IndexSizeType


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


code: virtual void Serialize ( void * Data, int64 Num )


code: TMemoryWriter ( [TArray](API\Runtime\Core\Containers\TArray)< uint8, [TSizedDefaultAllocator](API\Runtime\Core\Containers\TSizedDefaultAllocator)< IndexSize >> & InBytes, bool bIsPersistent, bool bSetOffset, const [FName](API\Runtime\Core\UObject\FName) InArchiveName )


code: virtual int64 TotalSize()


className: TMemoryWriter

description: Archive for storing arbitrary data to the specified memory location

code: template<int IndexSize> class TMemoryWriter : public [FMemoryArchive](API\Runtime\Core\Serialization\FMemoryArchive)

ArchiveName

type: constFName

description: Archive name, used to debugging, by default set to NAME_None.

Bytes

type: TArray< uint8, ...


className: TNamedAttribute

description: Class to contain a named attribute for serialization. Intended to be created as a temporary and passed to object serialization methods.

code: template<typename T> struct TNamedAttribute

Name

type: FArchiveFieldNa...

Value

type: T &


className: TNamedValue

description: Class to contain a named value for serialization. Intended to be created as a temporary and passed to object serialization methods.

code: template<typename T> struct TNamedValue


className: TOptionalNamedAttribute

description: Class to contain a named attribute for serialization, with a default. Intended to be created as a temporary and passed to object serialization methods, which can choose not to serialize the attribute if it matches the default.

code: template<typename T> struct TOptionalNamedAttribute

Default

type: const T &


className: FPtrTable

code: typedef [TPtrTableBase](API\Runtime\Core\Serialization\TPtrTableBase)< T, PtrType > FPtrTable


className: TPatchedPtrBase::operator T *

code: operator T *() const


className: TPatchedPtrBase

code: template<typename T, typename PtrType> class TPatchedPtrBase


className: TPtrTable

code: template<typename T> class TPtrTable : public [TPtrTableBase< T, T * >](API\Runtime\Core\Serialization\TPtrTableBase)


code: uint32 AddIndexedPointer ( T * Ptr )


code: void AddPatchedPointer ( T * Ptr, uint64 Offset )


code: void ApplyPointerPatches ( void * FrozenBase ) const


code: [TArray](API\Runtime\Core\Containers\TArray)< PtrType >::RangedForIteratorType begin()


code: [TArray](API\Runtime\Core\Containers\TArray)< PtrType >::RangedForConstIteratorType begin() const


code: [TArray](API\Runtime\Core\Containers\TArray)< PtrType >::RangedForIteratorType end()


code: [TArray](API\Runtime\Core\Containers\TArray)< PtrType >::RangedForConstIteratorType end() const


code: T * GetIndexedPointer ( uint32 i ) const


code: static const [FTypeLayoutDesc](API\Runtime\Core\Serialization\FTypeLayoutDesc) & StaticGetPtrTypeLayoutDesc()


code: bool TryAddIndexedPtr ( const [FTypeLayoutDesc](API\Runtime\Core\Serialization\FTypeLayoutDesc) & TypeDesc, void * Ptr, int32 & OutIndex )


code: bool TryGetIndexedPtr ( const [FTypeLayoutDesc](API\Runtime\Core\Serialization\FTypeLayoutDesc) & TypeDesc, uint32 i, void *& OutPtr ) const


className: TPtrTableBase

code: template<typename T, typename PtrType> class TPtrTableBase : public [FPtrTableBase](API\Runtime\Core\Serialization\FPtrTableBase)


className: Super

code: typedef [TPtrTableBase](API\Runtime\Core\Serialization\TPtrTableBase)< T, [TRefCountPtr](API\Runtime\Core\Templates\TRefCountPtr)< T >> Super


className: TRefCountPtrTable

code: template<typename T> class TRefCountPtrTable : public [TPtrTableBase< T, TRefCountPtr< T > >](API\Runtime\Core\Serialization\TPtrTableBase)


className: TStaticGetTypeLayoutHelper<                          ETypeLayoutInterface::Type >::CallAppendHash

code: static uint32 CallAppendHash &40; const FTypeLayoutDesc & TypeDesc, const FPlatformTypeLayoutParameters & LayoutParams, FSHA1 & Hasher &41;


className: TStaticGetTypeLayoutHelper<                          ETypeLayoutInterface::Type >::CallDestroy

code: static void CallDestroy &40; void &42; Object, const FTypeLayoutDesc &, const FPointerTableBase &42; PtrTable, bool bIsFrozen &41;


className: TStaticGetTypeLayoutHelper<                          ETypeLayoutInterface::Type >::CallGetTargetAlignment

code: static uint32 CallGetTargetAlignment &40; const FTypeLayoutDesc & TypeDesc, const FPlatformTypeLayoutParameters & LayoutParams &41;


className: TStaticGetTypeLayoutHelper<                          ETypeLayoutInterface::Type >::CallToString

code: static void CallToString &40; const void &42; Object, const FTypeLayoutDesc & TypeDesc, const FPlatformTypeLayoutParameters & LayoutParams, FMemoryToStringContext & OutContext &41;


className: TStaticGetTypeLayoutHelper<                          ETypeLayoutInterface::Type >::CallUnfrozenCopy

code: static uint32 CallUnfrozenCopy &40; const FMemoryUnfreezeContent & Context, const void &42; Object, const FTypeLayoutDesc & TypeDesc, void &42; OutDst &41;


className: TStaticGetTypeLayoutHelper<                          ETypeLayoutInterface::Type >::CallWriteMemoryImage

code: static void CallWriteMemoryImage &40; FMemoryImageWriter & Writer, const void &42; Object, const FTypeLayoutDesc & TypeDesc, const FTypeLayoutDesc & DerivedTypeDesc &41;


className: TStaticGetTypeLayoutHelper<                          ETypeLayoutInterface::Type >::Do

code: static const FTypeLayoutDesc & Do&40;&41;


code: namespace TStaticGetTypeLayoutHelper< ETypeLayoutInterface { template<> struct TStaticGetTypeLayoutHelper< ETypeLayoutInterface::Type > }


code: static const [FTypeLayoutDesc](API\Runtime\Core\Serialization\FTypeLayoutDesc) & Do()


className: TStaticGetTypeLayoutHelper<                          bool >::CallAppendHash


className: TStaticGetTypeLayoutHelper

code: template<typename T> struct TStaticGetTypeLayoutHelper


className: TStaticGetTypeLayoutHelper<                          bool >::CallDestroy


className: TStaticGetTypeLayoutHelper<                          bool >::CallGetTargetAlignment


className: TStaticGetTypeLayoutHelper<                          bool >::CallUnfrozenCopy


className: TStaticGetTypeLayoutHelper<                          bool >::CallToString


className: TStaticGetTypeLayoutHelper<                          bool >::CallWriteMemoryImage


className: TStaticGetTypeLayoutHelper<                          bool >::Do


className: TStaticGetTypeLayoutHelper<                          bool >

code: template<> struct TStaticGetTypeLayoutHelper< bool >


className: TStaticGetTypeLayoutHelper<                          char >::CallDestroy


className: TStaticGetTypeLayoutHelper<                          char >::CallGetTargetAlignment


className: TStaticGetTypeLayoutHelper<                          char >::CallToString


className: TStaticGetTypeLayoutHelper<                          char >::CallUnfrozenCopy


className: TStaticGetTypeLayoutHelper<                          char >::Do


className: TStaticGetTypeLayoutHelper<                          char >::CallWriteMemoryImage


className: TStaticGetTypeLayoutHelper<                          char >::CallAppendHash


className: TStaticGetTypeLayoutHelper<                          char >

code: template<> struct TStaticGetTypeLayoutHelper< char >


className: TStaticGetTypeLayoutHelper<                          char16_t >::CallAppendHash


className: TStaticGetTypeLayoutHelper<                          char16_t >::CallDestroy


className: TStaticGetTypeLayoutHelper<                          char16_t >::CallGetTargetAlignment


className: TStaticGetTypeLayoutHelper<                          char16_t >::CallToString


className: TStaticGetTypeLayoutHelper<                          char16_t >::CallUnfrozenCopy


className: TStaticGetTypeLayoutHelper<                          char16_t >::CallWriteMemoryImage


className: TStaticGetTypeLayoutHelper<                          char16_t >::Do


className: TStaticGetTypeLayoutHelper<                          char16_t >

code: template<> struct TStaticGetTypeLayoutHelper< char16_t >


className: TStaticGetTypeLayoutHelper<                          const T >

description: Map 'const' types to non-const type.

code: template<typename T> struct TStaticGetTypeLayoutHelper< const T > : public [TStaticGetTypeLayoutHelper< T >](API\Runtime\Core\Serialization\TStaticGetTypeLayoutHelper)


className: TStaticGetTypeLayoutHelper<                          double >::CallAppendHash


className: TStaticGetTypeLayoutHelper<                          double >::CallDestroy


className: TStaticGetTypeLayoutHelper<                          double >::CallGetTargetAlignment


className: TStaticGetTypeLayoutHelper<                          double >::CallToString


className: TStaticGetTypeLayoutHelper<                          double >::CallUnfrozenCopy


className: TStaticGetTypeLayoutHelper<                          double >::Do


className: TStaticGetTypeLayoutHelper<                          double >::CallWriteMemoryImage


className: TStaticGetTypeLayoutHelper<                          double >

code: template<> struct TStaticGetTypeLayoutHelper< double >


className: TStaticGetTypeLayoutHelper<                          FHashedNameDebugString >::CallAppendHash


className: TStaticGetTypeLayoutHelper<                          FHashedNameDebugString >::CallDestroy


className: TStaticGetTypeLayoutHelper<                          FHashedNameDebugString >::CallGetTargetAlignment


className: TStaticGetTypeLayoutHelper<                          FHashedNameDebugString >::CallToString


className: TStaticGetTypeLayoutHelper<                          FHashedNameDebugString >::CallUnfrozenCopy


className: TStaticGetTypeLayoutHelper<                          FHashedNameDebugString >::CallWriteMemoryImage


className: TStaticGetTypeLayoutHelper<                          FHashedNameDebugString >::Do


className: TStaticGetTypeLayoutHelper<                          float >::CallDestroy


className: TStaticGetTypeLayoutHelper<                          float >::CallAppendHash


code: template<> struct TStaticGetTypeLayoutHelper< FHashedNameDebugString >


className: TStaticGetTypeLayoutHelper<                          float >::CallGetTargetAlignment


className: TStaticGetTypeLayoutHelper<                          float >::CallToString


className: TStaticGetTypeLayoutHelper<                          float >::CallUnfrozenCopy


className: TStaticGetTypeLayoutHelper<                          float >::CallWriteMemoryImage


className: TStaticGetTypeLayoutHelper<                          float >::Do


className: TStaticGetTypeLayoutHelper<                          float >

code: template<> struct TStaticGetTypeLayoutHelper< float >


className: TStaticGetTypeLayoutHelper<                          FThreadSafeCounter >::CallAppendHash

code: static uint32 CallAppendHash &40; const FTypeLayoutDesc & TypeDesc, const FPlatformTypeLayoutParameters & LayoutParams, FSHA1 & Hasher &41;


className: TStaticGetTypeLayoutHelper<                          FThreadSafeCounter >::CallDestroy

code: static void CallDestroy &40; void &42; Object, const FTypeLayoutDesc &, const FPointerTableBase &42; PtrTable, bool bIsFrozen &41;


className: TStaticGetTypeLayoutHelper<                          FThreadSafeCounter >::CallGetTargetAlignment

code: static uint32 CallGetTargetAlignment &40; const FTypeLayoutDesc & TypeDesc, const FPlatformTypeLayoutParameters & LayoutParams &41;


className: TStaticGetTypeLayoutHelper<                          FThreadSafeCounter >::CallToString

code: static void CallToString &40; const void &42; Object, const FTypeLayoutDesc & TypeDesc, const FPlatformTypeLayoutParameters & LayoutParams, FMemoryToStringContext & OutContext &41;


className: TStaticGetTypeLayoutHelper<                          FThreadSafeCounter >::CallUnfrozenCopy

code: static uint32 CallUnfrozenCopy &40; const FMemoryUnfreezeContent & Context, const void &42; Object, const FTypeLayoutDesc & TypeDesc, void &42; OutDst &41;


className: TStaticGetTypeLayoutHelper<                          FThreadSafeCounter >::CallWriteMemoryImage

code: static void CallWriteMemoryImage &40; FMemoryImageWriter & Writer, const void &42; Object, const FTypeLayoutDesc & TypeDesc, const FTypeLayoutDesc & DerivedTypeDesc &41;


code: template<> struct TStaticGetTypeLayoutHelper< FThreadSafeCounter >


className: TStaticGetTypeLayoutHelper<                          int >::CallDestroy


className: TStaticGetTypeLayoutHelper<                          FThreadSafeCounter >::Do

code: static const FTypeLayoutDesc & Do&40;&41;


className: TStaticGetTypeLayoutHelper<                          int >::CallAppendHash


className: TStaticGetTypeLayoutHelper<                          int >::CallGetTargetAlignment


className: TStaticGetTypeLayoutHelper<                          int >::CallToString


className: TStaticGetTypeLayoutHelper<                          int >::CallWriteMemoryImage


className: TStaticGetTypeLayoutHelper<                          int >::CallUnfrozenCopy


className: TStaticGetTypeLayoutHelper<                          int >::Do


className: TStaticGetTypeLayoutHelper<                          int >

code: template<> struct TStaticGetTypeLayoutHelper< int >


className: TStaticGetTypeLayoutHelper<                          int8 >::CallAppendHash


className: TStaticGetTypeLayoutHelper<                          int8 >::CallDestroy


className: TStaticGetTypeLayoutHelper<                          int8 >::CallGetTargetAlignment


className: TStaticGetTypeLayoutHelper<                          int8 >::CallToString


className: TStaticGetTypeLayoutHelper<                          int8 >::CallUnfrozenCopy


className: TStaticGetTypeLayoutHelper<                          int8 >::CallWriteMemoryImage


className: TStaticGetTypeLayoutHelper<                          int8 >::Do


className: TStaticGetTypeLayoutHelper<                          int8 >

code: template<> struct TStaticGetTypeLayoutHelper< int8 >


className: TStaticGetTypeLayoutHelper<                          long >::CallAppendHash


className: TStaticGetTypeLayoutHelper<                          long >::CallDestroy


className: TStaticGetTypeLayoutHelper<                          long >::CallGetTargetAlignment


className: TStaticGetTypeLayoutHelper<                          long >::CallUnfrozenCopy


className: TStaticGetTypeLayoutHelper<                          long >::CallToString


className: TStaticGetTypeLayoutHelper<                          long >::CallWriteMemoryImage


className: TStaticGetTypeLayoutHelper<                          long long >::CallDestroy


className: TStaticGetTypeLayoutHelper<                          long >::Do


className: TStaticGetTypeLayoutHelper<                          long >

code: template<> struct TStaticGetTypeLayoutHelper< long >


className: TStaticGetTypeLayoutHelper<                          long long >::CallAppendHash


className: TStaticGetTypeLayoutHelper<                          long long >::CallGetTargetAlignment


className: TStaticGetTypeLayoutHelper<                          long long >::CallToString


className: TStaticGetTypeLayoutHelper<                          long long >::CallUnfrozenCopy


className: TStaticGetTypeLayoutHelper<                          long long >::CallWriteMemoryImage


className: TStaticGetTypeLayoutHelper<                          long long >

code: template<> struct TStaticGetTypeLayoutHelper< long long >


className: TStaticGetTypeLayoutHelper<                          long long >::Do


className: TStaticGetTypeLayoutHelper<                          short >::CallAppendHash


className: TStaticGetTypeLayoutHelper<                          short >::CallDestroy


className: TStaticGetTypeLayoutHelper<                          short >::CallGetTargetAlignment


className: TStaticGetTypeLayoutHelper<                          short >::CallToString


className: TStaticGetTypeLayoutHelper<                          short >::CallUnfrozenCopy


className: TStaticGetTypeLayoutHelper<                          short >::CallWriteMemoryImage


className: TStaticGetTypeLayoutHelper<                          short >

code: template<> struct TStaticGetTypeLayoutHelper< short >


className: TStaticGetTypeLayoutHelper<                          short >::Do


className: TStaticGetTypeLayoutHelper<                          wchar_t >::CallAppendHash


className: TStaticGetTypeLayoutHelper<                          wchar_t >::CallToString


className: TStaticGetTypeLayoutHelper<                          wchar_t >::CallGetTargetAlignment


className: TStaticGetTypeLayoutHelper<                          wchar_t >::CallUnfrozenCopy


className: TStaticGetTypeLayoutHelper<                          wchar_t >::CallWriteMemoryImage


className: TStaticGetTypeLayoutHelper<                          wchar_t >

code: template<> struct TStaticGetTypeLayoutHelper< wchar_t >


className: TStaticGetTypeLayoutHelper<                          wchar_t >::CallDestroy


className: TStaticGetTypeLayoutHelper<                          wchar_t >::Do


code: [TUniqueMemoryImagePtr](API\Runtime\Core\Serialization\TUniqueMemoryImagePtr) & operator= ( T * InPtr )


code: [TUniqueMemoryImagePtr](API\Runtime\Core\Serialization\TUniqueMemoryImagePtr) & operator= ( [TUniqueMemoryImagePtr](API\Runtime\Core\Serialization\TUniqueMemoryImagePtr) && Other )


code: TUniqueMemoryImagePtr ( [TUniqueMemoryImagePtr](API\Runtime\Core\Serialization\TUniqueMemoryImagePtr) && Other )


className: TUniqueMemoryImagePtr

code: template<typename T> class TUniqueMemoryImagePtr : public [TMemoryImagePtr< T >](API\Runtime\Core\Serialization\TMemoryImagePtr)


className: Value

code: static constexpr bool Value = (TModels_V<CStaticClassProvider, T> || TModels_V<CStaticStructProvider, T>);


className: TUsePropertyFreezing

code: template<typename T> struct TUsePropertyFreezing


code: static Value = !TIsPolymorphic<T>::Value;


code: namespace TValidateInterfaceHelper< T, ETypeLayoutInterface { template<typename T> struct TValidateInterfaceHelper< T, ETypeLayoutInterface::Abstract > }


code: namespace TValidateInterfaceHelper< T, ETypeLayoutInterface { template<typename T> struct TValidateInterfaceHelper< T, ETypeLayoutInterface::NonVirtual > }


code: static Value = !TIsAbstract<T>::Value;


code: namespace TValidateInterfaceHelper< T, ETypeLayoutInterface { template<typename T> struct TValidateInterfaceHelper< T, ETypeLayoutInterface::Virtual > }


className: TValidateInterfaceHelper

code: template<typename T, [ETypeLayoutInterface::Type](API\Runtime\Core\Serialization\ETypeLayoutInterface__Type) InterfaceType> struct TValidateInterfaceHelper


code: namespace UE { namespace StructuredArchive { namespace Private { enum EEnteringAttributeState { NotEnteringAttribute, EnteringAttribute, } } } }


description: Make integer params for the given integer type.

code: namespace UE { namespace CompactBinary { namespace Private { template<typename IntType> static constexpr [FIntegerParams](API\Runtime\Core\Serialization\FIntegerParams) UE::CompactBinary::Private::MakeIntegerParams() } } }


code: namespace UE { namespace StructuredArchive { namespace Private { [FArchive](API\Runtime\Core\Serialization\FArchive) & UE::StructuredArchive::Private::GetUnderlyingArchiveImpl ( [FStructuredArchive](API\Runtime\Core\Serialization\FStructuredArchive) & StructuredArchive ) } } }


code: namespace UE { namespace StructuredArchive { namespace Private { [FElementId](API\Runtime\Core\Serialization\FElementId) UE::StructuredArchive::Private::GetCurrentSlotElementIdImpl ( [FStructuredArchive](API\Runtime\Core\Serialization\FStructuredArchive) & Ar ) } } }


code: namespace UE { namespace StructuredArchive { namespace Private { [FArchiveState](API\Runtime\Core\Serialization\FArchiveState) & UE::StructuredArchive::Private::GetUnderlyingArchiveStateImpl ( [FStructuredArchive](API\Runtime\Core\Serialization\FStructuredArchive) & StructuredArchive ) } } }


code: namespace UE { namespace StructuredArchive { namespace Private { template<typename T> [TOptionalNamedAttribute](API\Runtime\Core\Serialization\TOptionalNamedAttribute)< T > UE::StructuredArchive::Private::MakeOptionalNamedAttribute ( [FArchiveFieldName](API\Runtime\Core\Serialization\FArchiveFieldName) Name, T & Value, const typename [TIdentity](API\Runtime\Core\Templates\TIdentity)< T >::Type & Default ) } } }


code: namespace UE { namespace StructuredArchive { namespace Private { enum EElementType { Root, Record, Array, Stream, Map, AttributedValue, } } } }


code: namespace UE { namespace StructuredArchive { namespace Private { FArchiveFormatterType & UE::StructuredArchive::Private::GetFormatterImpl ( [FStructuredArchive](API\Runtime\Core\Serialization\FStructuredArchive) & Ar ) } } }


code: namespace UE { namespace StructuredArchive { namespace Private { template<typename T> [TNamedValue](API\Runtime\Core\Serialization\TNamedValue)< T > UE::StructuredArchive::Private::MakeNamedValue ( [FArchiveFieldName](API\Runtime\Core\Serialization\FArchiveFieldName) Name, T & Value ) } } }


className: EScopeLogTimeUnits

code: enum EScopeLogTimeUnits { ScopeLog_DontLog, ScopeLog_Milliseconds, ScopeLog_Seconds, }


code: double GetDisplayScopedTime ( double InScopedTime ) const


description: Initialization constructor.

code: FConditionalScopeLogTime ( bool bCondition, const WIDECHAR * InName, FTotalTimeAndCount * InCumulative, [EScopeLogTimeUnits](API\Runtime\Core\Stats\FConditionalScopeLogTime\EScopeLogTimeUnits) InUnits )


code: FConditionalScopeLogTime ( bool bCondition, const ANSICHAR * InName, FTotalTimeAndCount * InCumulative, [EScopeLogTimeUnits](API\Runtime\Core\Stats\FConditionalScopeLogTime\EScopeLogTimeUnits) InUnits )


description: Destructor.

code: ~FConditionalScopeLogTime()


className: FConditionalScopeLogTime

description: Utility class to log time passed in seconds, adding cumulative stats to passed in variable.

code: struct FConditionalScopeLogTime

Cumulative

type: FTotalTimeAndCo...

Name

type: constFString

StartTime

type: const double

Units

type: EScopeLogTimeUn...


code: template<typename TStatGroup> static [TStatId](API\Runtime\Core\Stats\TStatId) CreateMemoryStatId ( const [FString](API\Runtime\Core\Containers\FString) & StatNameOrDescription, [FPlatformMemory::EMemoryCounterRegion](API\Runtime\Core\GenericPlatform\FGenericPlatformMemory\EMemoryCounterRegion) MemRegion )


code: namespace UE { namespace StructuredArchive { namespace Private { template<typename T> [TNamedAttribute](API\Runtime\Core\Serialization\TNamedAttribute)< T > UE::StructuredArchive::Private::MakeNamedAttribute ( [FArchiveFieldName](API\Runtime\Core\Serialization\FArchiveFieldName) Name, T & Value ) } } }


code: template<typename TStatGroup> static [TStatId](API\Runtime\Core\Stats\TStatId) CreateMemoryStatId ( const [FName](API\Runtime\Core\UObject\FName) StatNameOrDescription, [FPlatformMemory::EMemoryCounterRegion](API\Runtime\Core\GenericPlatform\FGenericPlatformMemory\EMemoryCounterRegion) MemRegion )


description: Example:FDynamicStats::CreateStatId(FString::Printf(TEXT("MyDynamicStat_%i"),Index) )

code: template<typename TStatGroup> static [TStatId](API\Runtime\Core\Stats\TStatId) CreateStatId ( const [FString](API\Runtime\Core\Containers\FString) & StatNameOrDescription )


code: template<typename TStatGroup> static [TStatId](API\Runtime\Core\Stats\TStatId) CreateStatId ( const [FName](API\Runtime\Core\UObject\FName) StatNameOrDescription, bool IsTimer )


code: template<typename TStatGroup> static [TStatId](API\Runtime\Core\Stats\TStatId) CreateStatIdInt64 ( const [FString](API\Runtime\Core\Containers\FString) & StatNameOrDescription, bool bIsAccumulator )


code: template<typename TStatGroup> static [TStatId](API\Runtime\Core\Stats\TStatId) CreateStatIdDouble ( const [FString](API\Runtime\Core\Containers\FString) & StatNameOrDescription, bool bIsAccumulator )


className: FDynamicStats

description: Helper class used to generate dynamic stat ids.

code: struct FDynamicStats


code: FScopeCycleCounter ( [TStatId](API\Runtime\Core\Stats\TStatId), bool bAlways )


code: FScopeCycleCounter ( [TStatId](API\Runtime\Core\Stats\TStatId), EStatFlags, bool bAlways )


className: FScopeCycleCounter

code: class FScopeCycleCounter


code: FScopeLogTime ( const WIDECHAR * InName, FTotalTimeAndCount * InCumulative, [EScopeLogTimeUnits](API\Runtime\Core\Stats\FConditionalScopeLogTime\EScopeLogTimeUnits) InUnits )


code: FScopeLogTime ( const ANSICHAR * InName, FTotalTimeAndCount * InCumulative, [EScopeLogTimeUnits](API\Runtime\Core\Stats\FConditionalScopeLogTime\EScopeLogTimeUnits) InUnits )


className: FScopeLogTime

code: struct FScopeLogTime : public [FConditionalScopeLogTime](API\Runtime\Core\Stats\FConditionalScopeLogTime)


className: FSecondsCounterData

description: Useful when timing reentrant functions.

code: struct FSecondsCounterData


code: FSecondsCounterScope ( [FSecondsCounterData](API\Runtime\Core\Stats\FSecondsCounterData) & InData )


className: FSecondsCounterScope

description: Utility class to update aFSecondsCounterData. Does nothing in STATS disabled builds.

code: class FSecondsCounterScope


description: Ctor, capturing start time.

code: FSimpleScopeSecondsCounter ( double & InSeconds, bool bInEnabled )


description: Ctor, capturing start time.

code: FSimpleScopeSecondsCounter ( double & InSeconds, int32 * InRecursionDepth )


description: Dtor, updating seconds with time delta.

code: ~FSimpleScopeSecondsCounter()


className: FSimpleScopeSecondsCounter

description: Utility class to capture time passed in seconds, adding delta time to passed in variable. Not useful for reentrant functions

code: class FSimpleScopeSecondsCounter


description: Advances stats for the current frame.

code: static void AdvanceFrame ( bool bDiscardCallstack, const [FOnAdvanceRenderingThreadStats](API\Runtime\Core\Stats\FStats\FOnAdvanceRenderingThreadStats) & AdvanceRenderingThreadStatsDelegate )


description: true, if the command line has the LoadTimeStatsForCommandlet or LoadTimeFileForCommandlet token which enables stats in the commandlets. !!!CAUTION!!! You need to manually advance stats frame in order to maintain the data integrity and not to leak the memory.

code: static bool EnabledForCommandlet()


className: FOnAdvanceRenderingThreadStats

description: Delegate to fire every time we need to advance the stats for the rendering thread.

code: typedef TBaseDelegate_ThreeParams< void, bool, int64, int32 > FOnAdvanceRenderingThreadStats


className: GameThreadStatsFrame

description: Current game thread stats frame.

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


description: true, if the command line has the LoadTimeFileForCommandlet token which enables LoadTimeFile equivalent for commandlets.


description: true, if the command line has the LoadTimeStatsForCommandlet token which enables LoadTimeStats equivalent for commandlets. All collected stats will be dumped to the log file at the end of running the specified commandlet.


description: HasStatsForCommandletsToken

code: static void TickCommandletStats()


className: FStats

description: Helper struct that contains method available even when the stats are disabled.

code: struct FStats


description: Enabled measurements / profiling.

code: static void BeginMeasurements()


className: bEnabled

code: static bool bEnabled = false;


description: Prints the results into a provided log.

code: static void DumpMeasurements ( [FMessageLog](API\Runtime\Core\Logging\FMessageLog) & Log, bool bSortByDuration )


description: Ends measurements / profiling and returns the compacted profiling tree.

code: static [FStatsTreeElement](API\Runtime\Core\Stats\FStatsTreeElement) EndMeasurements ( [FStatsTreeElement](API\Runtime\Core\Stats\FStatsTreeElement) MeasurementsToMerge, bool bAddUntrackedElements )


className: Entries

code: static [TArray](API\Runtime\Core\Containers\TArray)< FHierarchicalStatEntry > Entries;


code: FScope &40; const ANSICHAR &42; InLabel &41;


className: FScope

description: Helper class to create a local scope for profiling. Calls the static methods onFStatsHierarchical. Users should use the DECLARE_SCOPE_HIERARCHICAL_COUNTER macro instead.

code: struct FScope


description: Returns the last recorded profiling tree.


description: Returns the name to use for untracked time.


className: FStatsHierarchical

description: Note: This system is not thread-safe. You want to call it from a single thread only.

code: class FStatsHierarchical


description: Returns true if measurements are enabled.

code: static bool IsEnabled()


description: Returns the average number of seconds recorded (total / num)

code: double AverageSeconds ( bool bInclusive ) const


description: Returns the contribution between 0.0 and 1.0 within the parent element. 1.0 means that 100% of the time of the parent element is spent in this child.

code: double Contribution ( bool bAgainstMaximum, bool bInclusive ) const


description: Returns the child or nullptr based on a given path

code: [FStatsTreeElement](API\Runtime\Core\Stats\FStatsTreeElement) * FindChild ( const [FString](API\Runtime\Core\Containers\FString) & InPath )


description: Returns all child elements.

code: const [TArray](API\Runtime\Core\Containers\TArray)< [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FStatsTreeElement](API\Runtime\Core\Stats\FStatsTreeElement) > > & GetChildren() const


description: Returns the name of this element.


description: Returns the name of this element as aFString.


description: Returns the number of maximum cycles for this element (and children)

code: uint32 MaxCycles ( bool bInclusive ) const


description: Returns the invocation path of this element. The path is a period-separated string of all of the nested profiling scopes. For example: main.MyClass::Method.Algo::Sort


description: Returns the number of invocations collected into this element

code: uint32 Num ( bool bInclusive ) const


description: Returns the total number of cycles recorded

code: uint32 TotalCycles ( bool bInclusive ) const


description: Returns the total number of seconds recorded

code: double TotalSeconds ( bool bInclusive ) const


code: void UpdatePostMeasurement ( double InCyclesPerTimerToRemove )


description: Default constructor.

code: FStatsTreeElement()


className: FStatsTreeElement

description: TheFStatsTreeElementrepresents a single node in a profiling tree. Each element contains a description including its name, path (invocation path / call-stack) and its duration in system cycles.

code: class FStatsTreeElement

Children

type: TArray<TShared...

description: Children of the tree

CyclesOfChildren

description: Derived data (computed by UpdatePoseMeasurement)

Name

type: FName

Path

type: FString

RatioAgainstMaximumExclusive

type: double


className: FScopeIdle

code: struct FScopeIdle

bIgnore

type: const bool

description: If true, we ignore this thread idle stats.

Start

type: const uint32

description: Starting cycle counter.


className: FScopeNonCriticalPath

code: struct FScopeNonCriticalPath


className: FThreadIdleStats

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

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

bInIdleScope

type: bool

IsCriticalPathCounter

type: int

Waits

description: Total cycles we waited for sleep or event.

WaitsCriticalPath

description: Total cycles we waited for sleep or event on the critical path.


className: FQuoteEscape

code: struct FQuoteEscape

Input

type: FStringView


className: TAtArgPos

code: template<int N> struct TAtArgPos


code: static constexpr [FResult](API\Runtime\Core\String\FResult) Check ( bool, int, const TCHAR * )


className: TFmtArgTypes

code: template<typename... Ts> struct TFmtArgTypes


className: TJoinBy

code: template<typename RangeType, typename ProjectionType, typename DelimiterType> struct TJoinBy

Delimiter

type: DelimiterType &...

Projection

type: ProjectionType

Range

type: RangeType &&


className: TJoinQuotedBy

code: template<typename RangeType, typename ProjectionType, typename DelimiterType, typename QuoteType> struct TJoinQuotedBy

Quote

type: QuoteType &&


className: TPresentErr

code: template<int N> struct TPresentErr


className: TErrMsg

code: template<typename T> struct TErrMsg


className: TValue

code: typedef TErrMsg< TAtArgPos< ArgN >> TValue


code: template<> struct TPresentErr< StatusIncompleteFormatSpecifierOrUnescapedPercent >


code: template<> struct TPresentErr< StatusCapitalSNeedsCharPtr >


code: template<> struct TPresentErr< StatusCapitalSNeedsTCHARPtr >


className: TPresentErr< StatusCNeedsTCHARArg >

code: template<> struct TPresentErr< StatusCNeedsTCHARArg >


className: TPresentErr< StatusDNeedsIntegerArg >

code: template<> struct TPresentErr< StatusDNeedsIntegerArg >


code: template<> struct TPresentErr< StatusDynamicLengthSpecNeedsIntegerArg >


code: template<> struct TPresentErr< StatusFNeedsFloatOrDoubleArg >


className: TPresentErr< StatusHHNeedsIntegerArg >

code: template<> struct TPresentErr< StatusHHNeedsIntegerArg >


className: TPresentErr< StatusHHNeedsIntegerSpec >

code: template<> struct TPresentErr< StatusHHNeedsIntegerSpec >


className: TPresentErr< StatusHNeedsIntegerArg >

code: template<> struct TPresentErr< StatusHNeedsIntegerArg >


className: TPresentErr< StatusHSNeedsCharPtrArg >

code: template<> struct TPresentErr< StatusHSNeedsCharPtrArg >


className: TPresentErr< StatusI64BadSpec >

code: template<> struct TPresentErr< StatusI64BadSpec >


className: TPresentErr< StatusI64NeedsIntegerArg >

code: template<> struct TPresentErr< StatusI64NeedsIntegerArg >


className: TPresentErr< StatusInvalidFormatSpec >

code: template<> struct TPresentErr< StatusInvalidFormatSpec >


className: TPresentErr< StatusLLNeedsIntegerArg >

code: template<> struct TPresentErr< StatusLLNeedsIntegerArg >


code: template<typename T> struct TErrMsg


className: TPresentErr< StatusLLNeedsIntegerSpec >

code: template<> struct TPresentErr< StatusLLNeedsIntegerSpec >


code: typedef TErrMsg< TAtArgPos< ArgN >> TValue


className: TPresentErr< StatusLNeedsIntegerArg >

code: template<> struct TPresentErr< StatusLNeedsIntegerArg >


className: TPresentErr< StatusNotEnoughArguments >

code: template<> struct TPresentErr< StatusNotEnoughArguments >


className: TPresentErr< StatusOk >

code: template<> struct TPresentErr< StatusOk >


className: TPresentErr< StatusPNeedsPointerArg >

code: template<> struct TPresentErr< StatusPNeedsPointerArg >


className: TPresentErr< StatusSNeedsTCHARPtrArg >

code: template<> struct TPresentErr< StatusSNeedsTCHARPtrArg >


className: TPresentErr< StatusZNeedsIntegerArg >

code: template<> struct TPresentErr< StatusZNeedsIntegerArg >


className: TPresentErr< StatusZNeedsIntegerSpec >

code: template<> struct TPresentErr< StatusZNeedsIntegerSpec >


code: namespace UE { namespace Core { namespace Private { namespace FormatStringSan { enum EFormatStringSanStatus { StatusOk, StatusSNeedsTCHARPtrArg, StatusHSNeedsCharPtrArg, StatusIncompleteFormatSpecifierOrUnescapedPercent, StatusCNeedsTCHARArg, StatusPNeedsPointerArg, StatusFNeedsFloatOrDoubleArg, StatusCapitalSNeedsCharPtr, StatusCapitalSNeedsTCHARPtr, StatusInvalidFormatSpec, StatusNotEnoughArguments, StatusDNeedsIntegerArg, StatusZNeedsIntegerSpec, StatusZNeedsIntegerArg, StatusDynamicLengthSpecNeedsIntegerArg, StatusLNeedsIntegerArg, StatusHNeedsIntegerArg, StatusHHNeedsIntegerSpec, StatusHHNeedsIntegerArg, StatusLLNeedsIntegerSpec, StatusLLNeedsIntegerArg, StatusI64BadSpec, StatusI64NeedsIntegerArg, } } } } }


code: namespace UE { namespace Core { namespace Private { namespace FormatStringSan { template<typename... Ts> constexpr [TFmtArgTypes](API\Runtime\Core\String\TFmtArgTypes)< Ts... > UE::Core::Private::FormatStringSan::GetFmtArgTypes ( Ts... ) } } } }


code: namespace UE { namespace String { enum EParseLinesOptions { None = 0, SkipEmpty = 1 << 0, Trim = 1 << 1, } } }


code: namespace UE { namespace String { enum EParseTokensOptions { None = 0, IgnoreCase = 1 << 0, SkipEmpty = 1 << 1, Trim = 1 << 2, } } }


description: Example: Builder << String::Escape(Value);

code: namespace UE { namespace String { [Private::FEscape](API\Runtime\Core\String\FEscape) UE::String::Escape ( FStringView Input ) } }


description:
Create an object that can be appended to a string builder to append every element of the range to the builder, separating the elements by the delimiter.
An anonymous object to append to a string builder.

code: namespace UE { namespace String { template<typename RangeType, typename DelimiterType> auto UE::String::Join ( RangeType && Range, DelimiterType && Delimiter ) } }


code: namespace UE { namespace String { template<typename RangeType, typename ProjectionType, typename DelimiterType> auto UE::String::JoinBy ( RangeType && Range, ProjectionType Projection, DelimiterType && Delimiter ) } }


description:
Append every element of the range to the builder, separating the elements by the delimiter.
The builder, to allow additional operations to be composed with this one.

code: namespace UE { namespace String { template<typename RangeType, typename ProjectionType, typename DelimiterType, typename CharType> [TStringBuilderBase](API\Runtime\Core\Containers\TStringBuilderBase)< CharType > & UE::String::JoinByTo ( RangeType && Range, ProjectionType Projection, DelimiterType && Delimiter, [TStringBuilderBase](API\Runtime\Core\Containers\TStringBuilderBase)< CharType > & Builder ) } }


description:
Create an object that can be appended to a string builder to append every element of the range to the builder, separating the elements by the delimiter and surrounding every element on both sides with a quote.
An anonymous object to append to a string builder.

code: namespace UE { namespace String { template<typename RangeType, typename DelimiterType, typename QuoteType> auto UE::String::JoinQuoted ( RangeType && Range, DelimiterType && Delimiter, QuoteType && Quote ) } }


code: namespace UE { namespace String { template<typename RangeType, typename ProjectionType, typename DelimiterType, typename QuoteType> auto UE::String::JoinQuotedBy ( RangeType && Range, ProjectionType Projection, DelimiterType && Delimiter, QuoteType && Quote ) } }


description:
Append every element of the range to the builder, separating the elements by the delimiter, and surrounding every element on each side with the given quote.
The builder, to allow additional operations to be composed with this one.

code: namespace UE { namespace String { template<typename RangeType, typename ProjectionType, typename DelimiterType, typename QuoteType, typename CharType> [TStringBuilderBase](API\Runtime\Core\Containers\TStringBuilderBase)< CharType > & UE::String::JoinQuotedByTo ( RangeType && Range, ProjectionType Projection, DelimiterType && Delimiter, QuoteType && Quote, [TStringBuilderBase](API\Runtime\Core\Containers\TStringBuilderBase)< CharType > & Builder ) } }


code: namespace UE { namespace String { template<typename RangeType, typename DelimiterType, typename QuoteType, typename CharType> [TStringBuilderBase](API\Runtime\Core\Containers\TStringBuilderBase)< CharType > & UE::String::JoinQuotedTo ( RangeType && Range, DelimiterType && Delimiter, QuoteType && Quote, [TStringBuilderBase](API\Runtime\Core\Containers\TStringBuilderBase)< CharType > & Builder ) } }


code: namespace UE { namespace String { template<typename RangeType, typename DelimiterType, typename CharType> [TStringBuilderBase](API\Runtime\Core\Containers\TStringBuilderBase)< CharType > & UE::String::JoinTo ( RangeType && Range, DelimiterType && Delimiter, [TStringBuilderBase](API\Runtime\Core\Containers\TStringBuilderBase)< CharType > & Builder ) } }


code: namespace UE { namespace String { [EParseLinesOptions](API\Runtime\Core\String\UE__String__EParseLinesOptions) & UE::String::operator&= ( [EParseLinesOptions](API\Runtime\Core\String\UE__String__EParseLinesOptions) & Lhs, [EParseLinesOptions](API\Runtime\Core\String\UE__String__EParseLinesOptions) Rhs ) } }


code: namespace UE { namespace String { [EParseTokensOptions](API\Runtime\Core\String\UE__String__EParseTokensOptions) & UE::String::operator&= ( [EParseTokensOptions](API\Runtime\Core\String\UE__String__EParseTokensOptions) & Lhs, [EParseTokensOptions](API\Runtime\Core\String\UE__String__EParseTokensOptions) Rhs ) } }


code: namespace UE { namespace String { [EParseLinesOptions](API\Runtime\Core\String\UE__String__EParseLinesOptions) & UE::String::operator^= ( [EParseLinesOptions](API\Runtime\Core\String\UE__String__EParseLinesOptions) & Lhs, [EParseLinesOptions](API\Runtime\Core\String\UE__String__EParseLinesOptions) Rhs ) } }


code: namespace UE { namespace String { [EParseTokensOptions](API\Runtime\Core\String\UE__String__EParseTokensOptions) & UE::String::operator^= ( [EParseTokensOptions](API\Runtime\Core\String\UE__String__EParseTokensOptions) & Lhs, [EParseTokensOptions](API\Runtime\Core\String\UE__String__EParseTokensOptions) Rhs ) } }


code: namespace UE { namespace String { constexpr [EParseTokensOptions](API\Runtime\Core\String\UE__String__EParseTokensOptions) UE::String::operator& ( [EParseTokensOptions](API\Runtime\Core\String\UE__String__EParseTokensOptions) Lhs, [EParseTokensOptions](API\Runtime\Core\String\UE__String__EParseTokensOptions) Rhs ) } }


code: namespace UE { namespace String { constexpr [EParseLinesOptions](API\Runtime\Core\String\UE__String__EParseLinesOptions) UE::String::operator& ( [EParseLinesOptions](API\Runtime\Core\String\UE__String__EParseLinesOptions) Lhs, [EParseLinesOptions](API\Runtime\Core\String\UE__String__EParseLinesOptions) Rhs ) } }


code: namespace UE { namespace String { constexpr [EParseLinesOptions](API\Runtime\Core\String\UE__String__EParseLinesOptions) UE::String::operator^ ( [EParseLinesOptions](API\Runtime\Core\String\UE__String__EParseLinesOptions) Lhs, [EParseLinesOptions](API\Runtime\Core\String\UE__String__EParseLinesOptions) Rhs ) } }


code: namespace UE { namespace String { constexpr [EParseTokensOptions](API\Runtime\Core\String\UE__String__EParseTokensOptions) UE::String::operator^ ( [EParseTokensOptions](API\Runtime\Core\String\UE__String__EParseTokensOptions) Lhs, [EParseTokensOptions](API\Runtime\Core\String\UE__String__EParseTokensOptions) Rhs ) } }


code: namespace UE { namespace String { constexpr bool UE::String::operator! ( [EParseLinesOptions](API\Runtime\Core\String\UE__String__EParseLinesOptions) E ) } }


code: namespace UE { namespace String { constexpr bool UE::String::operator! ( [EParseTokensOptions](API\Runtime\Core\String\UE__String__EParseTokensOptions) E ) } }


code: namespace UE { namespace String { constexpr [EParseLinesOptions](API\Runtime\Core\String\UE__String__EParseLinesOptions) UE::String::operator~ ( [EParseLinesOptions](API\Runtime\Core\String\UE__String__EParseLinesOptions) E ) } }


code: namespace UE { namespace String { constexpr [EParseTokensOptions](API\Runtime\Core\String\UE__String__EParseTokensOptions) UE::String::operator~ ( [EParseTokensOptions](API\Runtime\Core\String\UE__String__EParseTokensOptions) E ) } }


description: Output strings are sub-views of the input view and have the same lifetime as the input view.Bydefault, empty lines are collected.

code: namespace UE { namespace String { template<typename OutputType> void UE::String::ParseLines ( const FStringView View, OutputType & Output, const [EParseLinesOptions](API\Runtime\Core\String\UE__String__EParseLinesOptions) Options ) } }


description: Output strings are sub-views of the input view and have the same lifetime as the input view.Bydefault, comparisons with the delimiter are case-sensitive and empty tokens are visited.

code: namespace UE { namespace String { template<typename OutputType> void UE::String::ParseTokens ( const FAnsiStringView View, const ANSICHAR Delimiter, OutputType & Output, const [EParseTokensOptions](API\Runtime\Core\String\UE__String__EParseTokensOptions) Options ) } }


code: namespace UE { namespace String { template<typename OutputType> void UE::String::ParseTokens ( const FUtf8StringView View, const [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) Delimiter, OutputType & Output, const [EParseTokensOptions](API\Runtime\Core\String\UE__String__EParseTokensOptions) Options ) } }


code: namespace UE { namespace String { template<typename OutputType> void UE::String::ParseTokens ( const FWideStringView View, const WIDECHAR Delimiter, OutputType & Output, const [EParseTokensOptions](API\Runtime\Core\String\UE__String__EParseTokensOptions) Options ) } }


code: namespace UE { namespace String { template<typename OutputType> void UE::String::ParseTokens ( const FWideStringView View, const FWideStringView Delimiter, OutputType & Output, const [EParseTokensOptions](API\Runtime\Core\String\UE__String__EParseTokensOptions) Options ) } }


code: namespace UE { namespace String { template<typename OutputType> void UE::String::ParseTokens ( const FAnsiStringView View, const FAnsiStringView Delimiter, OutputType & Output, const [EParseTokensOptions](API\Runtime\Core\String\UE__String__EParseTokensOptions) Options ) } }


code: namespace UE { namespace String { template<typename OutputType> void UE::String::ParseTokens ( const FUtf8StringView View, const FUtf8StringView Delimiter, OutputType & Output, const [EParseTokensOptions](API\Runtime\Core\String\UE__String__EParseTokensOptions) Options ) } }


description: Output strings are sub-views of the input view and have the same lifetime as the input view.Bydefault, comparisons with delimiters are case-sensitive and empty tokens are visited.

code: namespace UE { namespace String { template<typename OutputType> void UE::String::ParseTokensMultiple ( const FAnsiStringView View, const TConstArrayView< ANSICHAR > Delimiters, OutputType & Output, const [EParseTokensOptions](API\Runtime\Core\String\UE__String__EParseTokensOptions) Options ) } }


code: namespace UE { namespace String { template<typename OutputType> void UE::String::ParseTokensMultiple ( const FWideStringView View, const TConstArrayView< WIDECHAR > Delimiters, OutputType & Output, const [EParseTokensOptions](API\Runtime\Core\String\UE__String__EParseTokensOptions) Options ) } }


code: namespace UE { namespace String { template<typename OutputType> void UE::String::ParseTokensMultiple ( const FUtf8StringView View, const TConstArrayView< [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) > Delimiters, OutputType & Output, const [EParseTokensOptions](API\Runtime\Core\String\UE__String__EParseTokensOptions) Options ) } }


description: Output strings are sub-views of the input view and have the same lifetime as the input view.Bydefault, comparisons with delimiters are case-sensitive and empty tokens are visited. Behavior is undefined when delimiters overlap each other, such as the delimiters ("AB, "BC") and the input string "1ABC2".

code: namespace UE { namespace String { template<typename OutputType> void UE::String::ParseTokensMultiple ( const FAnsiStringView View, const TConstArrayView< FAnsiStringView > Delimiters, OutputType & Output, const [EParseTokensOptions](API\Runtime\Core\String\UE__String__EParseTokensOptions) Options ) } }


code: namespace UE { namespace String { template<typename OutputType> void UE::String::ParseTokensMultiple ( const FWideStringView View, const TConstArrayView< FWideStringView > Delimiters, OutputType & Output, const [EParseTokensOptions](API\Runtime\Core\String\UE__String__EParseTokensOptions) Options ) } }


code: namespace UE { namespace String { template<typename OutputType> void UE::String::ParseTokensMultiple ( const FUtf8StringView View, const TConstArrayView< FUtf8StringView > Delimiters, OutputType & Output, const [EParseTokensOptions](API\Runtime\Core\String\UE__String__EParseTokensOptions) Options ) } }


code: namespace UE { namespace String { namespace Private { FStringBuilderBase & UE::String::Private::operator<< ( FStringBuilderBase & Builder, const [FEscape](API\Runtime\Core\String\FEscape) & Adapter ) } } }


code: namespace UE { namespace String { namespace Private { FStringBuilderBase & UE::String::Private::operator<< ( FStringBuilderBase & Builder, const [FQuoteEscape](API\Runtime\Core\String\FQuoteEscape) & Adapter ) } } }


code: namespace UE { namespace String { namespace Private { template<typename RangeType, typename ProjectionType, typename DelimiterType, typename QuoteType, typename CharType> [TStringBuilderBase](API\Runtime\Core\Containers\TStringBuilderBase)< CharType > & UE::String::Private::operator<< ( [TStringBuilderBase](API\Runtime\Core\Containers\TStringBuilderBase)< CharType > & Builder, [Private::TJoinQuotedBy](API\Runtime\Core\String\TJoinQuotedBy)< RangeType, ProjectionType, DelimiterType, QuoteType > && Adapter ) } } }


code: namespace UE { namespace String { namespace Private { template<typename RangeType, typename ProjectionType, typename DelimiterType, typename CharType> [TStringBuilderBase](API\Runtime\Core\Containers\TStringBuilderBase)< CharType > & UE::String::Private::operator<< ( [TStringBuilderBase](API\Runtime\Core\Containers\TStringBuilderBase)< CharType > & Builder, [Private::TJoinBy](API\Runtime\Core\String\TJoinBy)< RangeType, ProjectionType, DelimiterType > && Adapter ) } } }


code: namespace UE { namespace String { template<typename CharType> [TStringView](API\Runtime\Core\Containers\TStringView)< CharType > UE::String::RemoveFromEnd ( const [TStringView](API\Runtime\Core\Containers\TStringView)< CharType > View, const [TStringView](API\Runtime\Core\Containers\TStringView)< CharType > Prefix, [ESearchCase::Type](API\Runtime\Core\Misc\ESearchCase__Type) SearchCase ) } }


description: Example: Builder << String::QuoteEscape(Value);

code: namespace UE { namespace String { [Private::FQuoteEscape](API\Runtime\Core\String\FQuoteEscape) UE::String::QuoteEscape ( FStringView Input ) } }


code: namespace UE { namespace String { template<typename CharType> [TStringView](API\Runtime\Core\Containers\TStringView)< CharType > UE::String::RemoveFromStart ( const [TStringView](API\Runtime\Core\Containers\TStringView)< CharType > View, const [TStringView](API\Runtime\Core\Containers\TStringView)< CharType > Prefix, [ESearchCase::Type](API\Runtime\Core\Misc\ESearchCase__Type) SearchCase ) } }


className: FExecutableTaskAllocator

code: typedef [TLockFreeFixedSizeAllocator_TLSCache](API\Runtime\Core\Containers\TLockFreeFixedSizeAllocator_TLSC-)< [SmallTaskSize](API\Runtime\Core\Tasks\SmallTaskSize), 64 > FExecutableTaskAllocator


description: Returns `true_ if the pipe has any not completed tasks

code: bool HasWork() const


description:
Launches a task in the pipe
Task instance that can be used to wait for task completion or to obtain the result of task execution

code: template<typename TaskBodyType> [TTask](API\Runtime\Core\Tasks\TTask)< TInvokeResult_T< TaskBodyType > > Launch ( const TCHAR * InDebugName, TaskBodyType && TaskBody, ETaskPriority Priority, [EExtendedTaskPriority](API\Runtime\Core\Tasks\UE__Tasks__EExtendedTaskPriority) ExtendedPriority )


description: Checks if pipe's task is being executed by the current thread. Allows to check if accessing a resource protected by a pipe is thread-safe

code: bool IsInContext() const


description:
Launches a task in the pipe, with multiple prerequisites that must be completed before the task is scheduled
Task instance that can be used to wait for task completion or to obtain the result of task execution

code: template<typename TaskBodyType, typename PrerequisitesCollectionType> [TTask](API\Runtime\Core\Tasks\TTask)< TInvokeResult_T< TaskBodyType > > Launch ( const TCHAR * InDebugName, TaskBodyType && TaskBody, PrerequisitesCollectionType && Prerequisites, ETaskPriority Priority, [EExtendedTaskPriority](API\Runtime\Core\Tasks\UE__Tasks__EExtendedTaskPriority) ExtendedPriority )


code: [FPipe](API\Runtime\Core\Tasks\FPipe) & operator= ( const [FPipe](API\Runtime\Core\Tasks\FPipe) & )


code: [FPipe](API\Runtime\Core\Tasks\FPipe) & operator= ( [FPipe](API\Runtime\Core\Tasks\FPipe) && )


description: Waits until the pipe is empty (its last task is executed) should be used only after no more tasks are launched in the pipe, e.g. preparing for the pipe destruction

code: bool WaitUntilEmpty ( [FTimespan](API\Runtime\Core\Misc\FTimespan) Timeout )


code: FPipe ( [FPipe](API\Runtime\Core\Tasks\FPipe) && )


code: FPipe ( const [FPipe](API\Runtime\Core\Tasks\FPipe) & )


className: FPipe

description: A chain of tasks that are executed one after another. Can be used to synchronise access to a shared resource asFPipeguarantees non-concurrent tasks execution.FPipeis a replacement for named threads because it's lightweight and flexible - there can be a large dynamic number of pipes each controlling its own shared resource. Can be used as a replacement for dedicated threads. Execution order is FIFO, i.e. it's the same as launching order. This means that if launching order is unspecified A pipe must be alive until its last task is completed. See `FTasksPipeTest_ for tests and examples.

code: class FPipe


description: The task will be executed only when all prerequisites are completed. The task type must be a task handle that holds a pointer toFTaskBaseas its `Pimpl_ member (see Tasks::TTaskBase). Must not be called concurrently

code: bool AddPrerequisites ( [FTaskBase](API\Runtime\Core\Tasks\FTaskBase) & Prerequisite )


description: Adds a nested task that must be completed before the parent (this) is completed

code: void AddNested ( [FTaskBase](API\Runtime\Core\Tasks\FTaskBase) & Nested )


code: template<typename HigherLevelTaskType, decltype(std::declval< HigherLevelTaskType >().Pimpl)*> bool AddPrerequisites ( const HigherLevelTaskType & Prerequisite )


description: The task will be executed only when all prerequisites are completed. Must not be called concurrently.

code: template<typename PrerequisiteCollectionType, decltype(std::declval< PrerequisiteCollectionType >().begin())*> void AddPrerequisites ( const PrerequisiteCollectionType & InPrerequisites )


description: Ref-count

code: void AddRef()


description: Waits until the task is completed or waiting timed out, while executing other tasks

code: bool BusyWait ( [FTimeout](API\Runtime\Core\Misc\FTimeout) Timeout )


description: The task unlocks all its subsequents on completion. returns false if the task is already completed and the subsequent wasn't added

code: bool AddSubsequent ( [FTaskBase](API\Runtime\Core\Tasks\FTaskBase) & Subsequent )


description: Waits until the task is completed or the condition returns true, while executing other tasks

code: template<typename ConditionType> bool BusyWait ( ConditionType && Condition )


description: Closes task by unlocking its subsequents and flagging it as completed

code: void Close()


className: ExecutionFlag

description: ExecutionFlag_ is set at the beginning of execution as the most significant bit ofNumLocks_ and indicates a switch of `NumLocks_ from "execution prerequisites" (a number of uncompleted prerequisites that block task execution) to "completion prerequisites" (a number of nested uncompleted tasks that block task completion)

code: static constexpr uint32 ExecutionFlag = 0x80000000;


code: [FPipe](API\Runtime\Core\Tasks\FPipe) * GetPipe() const


code: uint32 GetRefCount ( std::memory_order MemoryOrder ) const


description: Returns true if it's valid to wait for the task completion. it's not valid to wait for a task e.g. from inside task's execution, as this would deadlock

code: bool IsAwaitable() const


description: true if the task was executed and all its nested tasks are completed

code: bool IsCompleted() const


className: NumInitialLocks

description: The number of times that the task should be unlocked before it can be scheduled or completed initial count is 1 for launching the task (it can't be scheduled before it's launched) reaches 0 the task is scheduled for execution. NumLocks's the most significant bit (see `ExecutionFlag_) is set on task execution start, and indicates that now NumLocks is about how many times the task must be unlocked to be completed

code: static constexpr uint32 NumInitialLocks = 1;


code: void Init ( const TCHAR * InDebugName, ETaskPriority InPriority, [EExtendedTaskPriority](API\Runtime\Core\Tasks\UE__Tasks__EExtendedTaskPriority) InExtendedPriority )


description: Releases internal reference and maintains low-level task state. must be called iff the task was never launched, otherwise the scheduler will do this in due course

code: void ReleaseInternalReference()


description: A piped task is executed after the previous task from this pipe is completed. Tasks from the same pipe are not executed concurrently (so don't require synchronization), but not necessarily on the same thread.FPipe

code: void SetPipe ( [FPipe](API\Runtime\Core\Tasks\FPipe) & InPipe )


description:
Tries to get execution permission and if successful, executes given task body and completes the task if there're no pending nested tasks. does all required accounting before/after task execution. the task can be deleted as a result of this call.
true if the task was executed by the current thread

code: bool TryExecuteTask()


description: Tries to schedule task execution. Returns false if the task has incomplete dependencies (prerequisites or is blocked by a pipe). In this case the task will be automatically scheduled when all dependencies are completed.

code: bool TryLaunch ( uint64 TaskSize )


description: Tries to pull out the task from the system and execute it. If the task is locked by either prerequisites or nested tasks, tries to retract and execute them recursively. WARNING: the function can returntrue_ even if the task is not completed yet. Thetrue_ means only that the task is already executed and has no other pending dependencies, but can be in the process of completion (concurrently). The caller still needs to wait for completion explicitly.

code: bool TryRetractAndExecute ( [FTimeout](API\Runtime\Core\Misc\FTimeout) Timeout, uint32 RecursionDepth )


description:
Waits for task's completion, with optional timeout. Tries to retract the task and execute it in-place, if failed - blocks until the task is completed by another thread. If timeout is zero, tries to retract the task and returns immedially after that.Wait(FTimespan::Zero())_ still tries to retract and execute the task, useIsCompleted()_ to check for completeness. The version w/o timeout is slightly more efficient.
true if the task is completed

code: bool Wait ( [FTimeout](API\Runtime\Core\Misc\FTimeout) Timeout )


code: FTaskBase &40; const FTaskBase & &41;


className: FTaskBase

description: TExecutableTask

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


description: All prerequisites must be added before triggering the event

code: template<typename PrerequisitesType> void AddPrerequisites ( const PrerequisitesType & Prerequisites )


code: FTaskEvent ( const TCHAR * DebugName )


className: FTaskEvent

description: A synchronisation primitive, a recommended substitution of `FEvent_ for signalling between tasks. If used as a task prerequisite or a nested task, it doesn't block a worker thread. Optionally can use "busy waiting" - executing tasks while waiting.

code: class FTaskEvent : public [UE::Tasks::Private::FTaskHandle](API\Runtime\Core\Tasks\FTaskHandle)


code: static [FTaskEventBase](API\Runtime\Core\Tasks\FTaskEventBase) * Create ( const TCHAR * DebugName )


className: FTaskEventBase::operator delete

code: static void operator delete ( void * Ptr )


className: FTaskEventBase::operator new

code: static void * operator new ( size_t Size )