className: TFuture< void >::TFuture

description: Default constructor.


className: TFuture< void >::Share

description:
Moves this future's state into a shared future.
The shared future object.

module: Core

code: TSharedFuture< void > Share&40;&41;


description: Creates and initializes a new instance.

code: TFuture &40; const BaseType::StateType & InState &41;


description: Move constructor.

code: TFuture &40; TFuture && &41;


description: Hidden copy constructor (futures cannot be copied).

code: TFuture &40; const TFuture & &41;


className: TFuture< void >::~TFuture

description: Destructor.


className: TFuture< void >

description: Template for unshared futures (specialization for void).

code: template<> class TFuture< void > : public [TFutureBase< int >](API\Runtime\Core\Async\TFutureBase)


className: TGetTypeLayoutHelper<                          ENamedThreads::Type >::Do

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


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


description:
Factory to create a task and return the helper object to construct the embedded task and set it up for execution.
a temporary helper class which can be used to complete the process.

code: static [FConstructor](API\Runtime\Core\Async\TGraphTask\FConstructor) CreateTask ( const FGraphEventArray * Prerequisites, [ENamedThreads::Type](API\Runtime\Core\Async\ENamedThreads__Type) CurrentThreadIfKnown )


description: Factory to create a gather task which assumes the given subsequent list from some other tasks. This is used to support "WaitFor" during a task execution.

code: static FConstructor CreateTask &40; FGraphEventRef SubsequentsToAssume, const FGraphEventArray &42; Prerequisites, ENamedThreads::Type CurrentThreadIfKnown &41;


description: Passthrough internal task constructor and dispatch. Note! Generally speaking references will not pass through; use pointers

code: template<typename... T> FGraphEventRef ConstructAndDispatchWhenReady &40; T &&... Args &41;


description: Passthrough internal task constructor and hold.

code: template<typename... T> TGraphTask &42; ConstructAndHold &40; T &&... Args &41;


className: FConstructor

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

code: class FConstructor


code: void Unlock ( [ENamedThreads::Type](API\Runtime\Core\Async\ENamedThreads__Type) CurrentThreadIfKnown )


className: TGraphTask

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

code: template<typename TTask> class TGraphTask : public [TConcurrentLinearObject< TGraphTask< TTask >, FTaskGraphBlockAllocationTag >](API\Runtime\Core\Experimental\TConcurrentLinearObject), public [FBaseGraphTask](API\Runtime\Core\Async\FBaseGraphTask)


className: THasTypeLayout<                          ENamedThreads::Type >

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


code: void AddWorkers ( uint16 NumWorkers )


code: void Run ( [TFunctionRef](API\Runtime\Core\GenericPlatform\TFunctionRef)< void(TaskType *)> InDoWork )


code: TLocalWorkQueue &40; TLocalWorkQueue && &41;


code: TLocalWorkQueue &40; const TLocalWorkQueue & &41;


code: TLocalWorkQueue ( TaskType * InitialWork, [LowLevelTasks::ETaskPriority](API\Runtime\Core\Async\Fundamental\LowLevelTasks__ETaskPriority) InPriority )


className: TLocalWorkQueue

code: template<typename TaskType> class TLocalWorkQueue


className: BaseType

code: typedef [TPromiseBase](API\Runtime\Core\Async\TPromiseBase)< ResultType > BaseType


description: The result must be set only once. An assertion will be triggered if this method is called a second time.

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


description:
Gets aTFutureobject associated with the shared state of this promise.
TheTFutureobject.

code: [TFuture](API\Runtime\Core\Async\TFuture)< ResultType > GetFuture()


description: Move assignment operator.

code: [TPromise](API\Runtime\Core\Async\TPromise) & operator= ( [TPromise](API\Runtime\Core\Async\TPromise) && Other )


code: void SetValue ( const ResultType & Result )


code: void SetValue ( ResultType && Result )


description: Default constructor (creates a new shared state).

code: TPromise()


description: Create and initialize a new instance with a callback.

code: TPromise ( [TUniqueFunction](API\Runtime\Core\Templates\TUniqueFunction)< void()> && CompletionCallback )


description: Move constructor.

code: TPromise ( [TPromise](API\Runtime\Core\Async\TPromise) && Other )


description:
Gets the shared state object.
The shared state object.

code: const [StateType](API\Runtime\Core\Templates\TSharedPtr) & GetState()


className: StateType

code: typedef [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [TFutureState](API\Runtime\Core\Async\TFutureState)< InternalResultType >, ESPMode::ThreadSafe > StateType


description: Move assignment operator.

code: [TPromiseBase](API\Runtime\Core\Async\TPromiseBase) & operator= ( [TPromiseBase](API\Runtime\Core\Async\TPromiseBase) && Other )


description: Default constructor.

code: TPromiseBase()


description: Move constructor.

code: TPromiseBase ( [TPromiseBase](API\Runtime\Core\Async\TPromiseBase) && Other )


code: TPromiseBase ( [TUniqueFunction](API\Runtime\Core\Templates\TUniqueFunction)< void()> && CompletionCallback )


className: TPromise

description: Template for promises.

code: template<typename ResultType> class TPromise : public [TPromiseBase< ResultType >](API\Runtime\Core\Async\TPromiseBase)


description: Destructor.

code: ~TPromiseBase()


className: TPromiseBase

description: TPromise

code: template<typename InternalResultType> class TPromiseBase : private [FNoncopyable](API\Runtime\Core\Templates\FNoncopyable)


code: typedef TPromiseBase< ResultType &42; > BaseType


className: TPromise< ResultType & >::EmplaceValue

code: void EmplaceValue &40; ResultType & Result &41;


className: TPromise< ResultType & >::GetFuture

code: TFuture< ResultType & > GetFuture&40;&41;


className: TPromise< ResultType & >::operator=

description: Move assignment operator.

code: TPromise & operator&61; &40; TPromise && Other &41;


className: TPromise< ResultType & >::SetValue

code: void SetValue &40; ResultType & Result &41;


className: TPromise< ResultType & >::TPromise


description: Move constructor.

code: TPromise &40; TPromise && Other &41;


code: TPromise &40; TUniqueFunction< void()> && CompletionCallback &41;


className: TPromise< ResultType & >

description: Template for promises (specialization for reference types).

code: template<typename ResultType> class TPromise< ResultType & > : public [TPromiseBase< ResultType * >](API\Runtime\Core\Async\TPromiseBase)


code: typedef TPromiseBase< int > BaseType


className: TPromise< void >::EmplaceValue

code: void EmplaceValue&40;&41;


className: TPromise< void >::GetFuture

code: TFuture< void > GetFuture&40;&41;


className: TPromise< void >::SetValue

code: void SetValue&40;&41;


className: TPromise< void >::TPromise

description: Move constructor.


className: TPromise< void >

description: Template for promises (specialization for void results).

code: template<> class TPromise< void > : public [TPromiseBase< int >](API\Runtime\Core\Async\TPromiseBase)


className: TPromise< void >::operator=

description: Move assignment operator.


code: typedef [TFutureBase](API\Runtime\Core\Async\TFutureBase)< ResultType > BaseType


description:
Gets the future's result.
The result.

code: ResultType Get() const


description: Copy assignment operator.

code: [TSharedFuture](API\Runtime\Core\Async\TSharedFuture) & operator= ( const [TSharedFuture](API\Runtime\Core\Async\TSharedFuture) & Other )


description: Move assignment operator.

code: [TSharedFuture](API\Runtime\Core\Async\TSharedFuture) & operator= ( [TSharedFuture](API\Runtime\Core\Async\TSharedFuture) && Other )


description: Default constructor.

code: TSharedFuture()


description: Creates and initializes a new instance.

code: TSharedFuture ( const typename [BaseType::StateType](API\Runtime\Core\Async\TFutureBase\StateType) & InState )


description: Copy constructor.

code: TSharedFuture ( const [TSharedFuture](API\Runtime\Core\Async\TSharedFuture) & )


description: Creates and initializes a new instances from a future object.

code: TSharedFuture ( [TFuture](API\Runtime\Core\Async\TFuture)< ResultType > && Future )


description: Move constructor.

code: TSharedFuture ( [TSharedFuture](API\Runtime\Core\Async\TSharedFuture) && )


description: Destructor.

code: ~TSharedFuture()


code: typedef TFutureBase< ResultType &42; > BaseType


className: TSharedFuture

description: TSharedFuture< ResultType & >TSharedFuture< void >

code: template<typename ResultType> class TSharedFuture : public [TFutureBase< ResultType >](API\Runtime\Core\Async\TFutureBase)


className: TSharedFuture< ResultType & >::Get

description:
Gets the future's result.
The result.

code: ResultType & Get&40;&41; const


className: TSharedFuture< ResultType & >::operator=

description: Copy assignment operator.

code: TSharedFuture & operator&61; &40; const TSharedFuture & Other &41;


description: Move assignment operator.

code: TSharedFuture & operator&61; &40; TSharedFuture && Other &41;


className: TSharedFuture< ResultType & >::TSharedFuture

description: Default constructor.


description: Creates and initializes a new instance.

code: TSharedFuture &40; const typename BaseType::StateType & InState &41;


code: TSharedFuture &40; TFuture< ResultType > && Future &41;


description: Copy constructor.

code: TSharedFuture &40; const TSharedFuture & &41;


description: Move constructor.

code: TSharedFuture &40; TSharedFuture && &41;


className: TSharedFuture< ResultType & >::~TSharedFuture

description: Destructor.


className: TSharedFuture< ResultType & >

description: Template for shared futures (specialization for reference types).

code: template<typename ResultType> class TSharedFuture< ResultType & > : public [TFutureBase< ResultType * >](API\Runtime\Core\Async\TFutureBase)


className: BaseType

code: typedef TFutureBase< int > BaseType


className: TSharedFuture< void >::Get

description:
Gets the future's result.
The result.

code: void Get&40;&41; const


className: TSharedFuture< void >::operator=

description: Copy assignment operator.


description: Move assignment operator.


className: TSharedFuture< void >::TSharedFuture

description: Default constructor.


description: Creates and initializes a new instance from shared state.

code: TSharedFuture &40; const BaseType::StateType & InState &41;


code: TSharedFuture &40; TFuture< void > && Future &41;


description: Copy constructor.


description: Move constructor.


className: TSharedFuture< void >::~TSharedFuture

description: Destructor.


className: TStaticGetTypeLayoutHelper<                          ENamedThreads::Type >::CallDestroy

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


className: TSharedFuture< void >

description: Template for shared futures (specialization for void).

code: template<> class TSharedFuture< void > : public [TFutureBase< int >](API\Runtime\Core\Async\TFutureBase)


className: TStaticGetTypeLayoutHelper<                          ENamedThreads::Type >::CallAppendHash

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


className: TStaticGetTypeLayoutHelper<                          ENamedThreads::Type >::CallGetTargetAlignment

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


className: TStaticGetTypeLayoutHelper<                          ENamedThreads::Type >::CallToString

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


className: TStaticGetTypeLayoutHelper<                          ENamedThreads::Type >::CallUnfrozenCopy

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


className: TStaticGetTypeLayoutHelper<                          ENamedThreads::Type >::CallWriteMemoryImage

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


className: TStaticGetTypeLayoutHelper<                          ENamedThreads::Type >::Do

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


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


code: [TUniqueLock](API\Runtime\Core\Async\TUniqueLock) & operator= ( const [TUniqueLock](API\Runtime\Core\Async\TUniqueLock) & )


code: TUniqueLock ( const [TUniqueLock](API\Runtime\Core\Async\TUniqueLock) & )


className: TUniqueLock

code: template<typename LockType> class TUniqueLock


code: template<typename... ARGS> constexpr auto operator() ( ARGS &&... Args ) const


code: template<typename... ARGS> constexpr auto operator() ( ARGS &&... Args )


code: constexpr TYCombinator ( LAMBDA && InLambda )


code: constexpr TYCombinator ( const LAMBDA & InLambda )


className: TYCombinator

code: template<typename LAMBDA> class TYCombinator


description: Queue the calling thread to wait if CanWait returns true. BeforeWait is only called if CanWait returns true.

code: namespace UE { namespace ParkingLot { template<typename CanWaitType, typename BeforeWaitType> [FWaitState](API\Runtime\Core\Async\FWaitState) UE::ParkingLot::Wait ( const void * Address, CanWaitType && CanWait, BeforeWaitType && BeforeWait ) } }


code: namespace UE { namespace ParkingLot { template<typename CanWaitType, typename BeforeWaitType> [FWaitState](API\Runtime\Core\Async\FWaitState) UE::ParkingLot::WaitFor ( const void * Address, CanWaitType && CanWait, BeforeWaitType && BeforeWait, [FMonotonicTimeSpan](API\Runtime\Core\Misc\FMonotonicTimeSpan) WaitTime ) } }


code: namespace UE { namespace ParkingLot { template<typename CanWaitType, typename BeforeWaitType> [FWaitState](API\Runtime\Core\Async\FWaitState) UE::ParkingLot::WaitUntil ( const void * Address, CanWaitType && CanWait, BeforeWaitType && BeforeWait, [FMonotonicTimePoint](API\Runtime\Core\Misc\FMonotonicTimePoint) WaitTime ) } }


description: Wake one thread from the queue of threads waiting on the address.

code: namespace UE { namespace ParkingLot { template<typename OnWakeStateType> void UE::ParkingLot::WakeOne ( const void * Address, OnWakeStateType && OnWakeState ) } }


code: static int8 AtomicRead ( volatile const int8 * Src )


code: static int16 AtomicRead ( volatile const int16 * Src )


code: static int32 AtomicRead ( volatile const int32 * Src )


code: static int64 AtomicRead ( volatile const int64 * Src )


description: Deprecated* AtomicRead64 has been deprecated, please use AtomicRead's overload instead

code: static int64 AtomicRead64 ( volatile const int64 * Src )


code: static int8 AtomicRead_Relaxed ( volatile const int8 * Src )


code: static int16 AtomicRead_Relaxed ( volatile const int16 * Src )


code: static int32 AtomicRead_Relaxed ( volatile const int32 * Src )


code: static int64 AtomicRead_Relaxed ( volatile const int64 * Src )


code: static void AtomicStore ( volatile int8 * Src, int8 Val )


code: static void AtomicStore ( volatile int16 * Src, int16 Val )


code: static void AtomicStore ( volatile int64 * Src, int64 Val )


code: static void AtomicStore ( volatile int32 * Src, int32 Val )


code: static void AtomicStore_Relaxed ( volatile int8 * Src, int8 Val )


code: static void AtomicStore_Relaxed ( volatile int32 * Src, int32 Val )


code: static void AtomicStore_Relaxed ( volatile int16 * Src, int16 Val )


code: static void AtomicStore_Relaxed ( volatile int64 * Src, int64 Val )


code: static bool CanUseCompareExchange128()


code: static int8 InterlockedAdd ( volatile int8 * Value, int8 Amount )


code: static int16 InterlockedAdd ( volatile int16 * Value, int16 Amount )


code: static int32 InterlockedAdd ( volatile int32 * Value, int32 Amount )


code: static int64 InterlockedAdd ( volatile int64 * Value, int64 Amount )


code: static int8 InterlockedAnd ( volatile int8 * Value, const int8 AndValue )


code: static int16 InterlockedAnd ( volatile int16 * Value, const int16 AndValue )


code: static int32 InterlockedAnd ( volatile int32 * Value, const int32 AndValue )


code: static int64 InterlockedAnd ( volatile int64 * Value, const int64 AndValue )


code: static int8 InterlockedCompareExchange ( volatile int8 * Dest, int8 Exchange, int8 Comparand )


code: static int16 InterlockedCompareExchange ( volatile int16 * Dest, int16 Exchange, int16 Comparand )


code: static int32 InterlockedCompareExchange ( volatile int32 * Dest, int32 Exchange, int32 Comparand )


code: static int64 InterlockedCompareExchange ( volatile int64 * Dest, int64 Exchange, int64 Comparand )


code: static int8 InterlockedDecrement ( volatile int8 * Value )


code: static void * InterlockedCompareExchangePointer ( void *volatile * Dest, void * Exchange, void * Comparand )


code: static int16 InterlockedDecrement ( volatile int16 * Value )


code: static int32 InterlockedDecrement ( volatile int32 * Value )


code: static int64 InterlockedDecrement ( volatile int64 * Value )


code: static int8 InterlockedExchange ( volatile int8 * Value, int8 Exchange )


code: static int32 InterlockedExchange ( volatile int32 * Value, int32 Exchange )


code: static int64 InterlockedExchange ( volatile int64 * Value, int64 Exchange )


code: static void * InterlockedExchangePtr ( void *volatile * Dest, void * Exchange )


code: static int8 InterlockedIncrement ( volatile int8 * Value )


code: static int16 InterlockedIncrement ( volatile int16 * Value )


code: static int32 InterlockedIncrement ( volatile int32 * Value )


code: static int16 InterlockedExchange ( volatile int16 * Value, int16 Exchange )


code: static int64 InterlockedIncrement ( volatile int64 * Value )


code: static int16 InterlockedOr ( volatile int16 * Value, const int16 OrValue )


code: static int8 InterlockedOr ( volatile int8 * Value, const int8 OrValue )


code: static int32 InterlockedOr ( volatile int32 * Value, const int32 OrValue )


code: static int64 InterlockedOr ( volatile int64 * Value, const int64 OrValue )


code: static int8 InterlockedXor ( volatile int8 * Value, const int8 XorValue )


code: static int16 InterlockedXor ( volatile int16 * Value, const int16 XorValue )


code: static int64 InterlockedXor ( volatile int64 * Value, const int64 XorValue )


code: static int32 InterlockedXor ( volatile int32 * Value, const int32 XorValue )


className: FClangPlatformAtomics

description: GCC/Clang implementation of the Atomics OS functions

code: struct FClangPlatformAtomics : public [FGenericPlatformAtomics](API\Runtime\Core\GenericPlatform\FGenericPlatformAtomics)


description:
Counts the number of leading zeros in the bit representation of the value
the number of zeros before the first "on" bit

code: static uint64 CountLeadingZeros64 ( uint64 Value )


code: static uint32 CountLeadingZeros ( uint32 Value )


code: static uint8 CountLeadingZeros8 ( uint8 Value )


description:
Counts the number of trailing zeros in the bit representation of the value
the number of zeros after the last "on" bit

code: static uint32 CountTrailingZeros ( uint32 Value )


code: static uint64 CountTrailingZeros64 ( uint64 Value )


code: static uint32 FloorLog2 ( uint32 Value )


code: static uint64 FloorLog2_64 ( uint64 Value )


className: FClangPlatformMath

description: Clang implementation of math functions

code: struct FClangPlatformMath : public [FGenericPlatformMath](API\Runtime\Core\GenericPlatform\FGenericPlatformMath)


description:
Compress the buffer using a balanced level of compression.
An owned compressed buffer, or null on error.

code: static [FCompressedBuffer](API\Runtime\Core\Compression\FCompressedBuffer) Compress ( const [FCompositeBuffer](API\Runtime\Core\Memory\FCompositeBuffer) & RawData )


code: static [FCompressedBuffer](API\Runtime\Core\Compression\FCompressedBuffer) Compress ( const [FSharedBuffer](API\Runtime\Core\Memory\FSharedBuffer) & RawData )


description:
Using a level of None will return a buffer that references owned raw data.
An owned compressed buffer, or null on error.

code: static [FCompressedBuffer](API\Runtime\Core\Compression\FCompressedBuffer) Compress ( const [FCompositeBuffer](API\Runtime\Core\Memory\FCompositeBuffer) & RawData, [ECompressedBufferCompressor](API\Runtime\Core\Compression\FOodleDataCompression__ECompress-) Compressor, [ECompressedBufferCompressionLevel](API\Runtime\Core\Compression\FOodleDataCompression__ECompress-_1) CompressionLevel, uint64 BlockSize )


code: static [FCompressedBuffer](API\Runtime\Core\Compression\FCompressedBuffer) Compress ( const [FSharedBuffer](API\Runtime\Core\Memory\FSharedBuffer) & RawData, [ECompressedBufferCompressor](API\Runtime\Core\Compression\FOodleDataCompression__ECompress-) Compressor, [ECompressedBufferCompressionLevel](API\Runtime\Core\Compression\FOodleDataCompression__ECompress-_1) CompressionLevel, uint64 BlockSize )


description:
Decompress into an owned buffer.
An owned buffer containing the raw data, or null on error.


description:
Construct from a compressed buffer previously created byCompress().
A compressed buffer, or null on error, such as an invalid format or corrupt header.

code: static [FCompressedBuffer](API\Runtime\Core\Compression\FCompressedBuffer) FromCompressed ( const [FCompositeBuffer](API\Runtime\Core\Memory\FCompositeBuffer) & CompressedData )


code: static [FCompressedBuffer](API\Runtime\Core\Compression\FCompressedBuffer) FromCompressed ( [FCompositeBuffer](API\Runtime\Core\Memory\FCompositeBuffer) && CompressedData )


code: static [FCompressedBuffer](API\Runtime\Core\Compression\FCompressedBuffer) FromCompressed ( const [FSharedBuffer](API\Runtime\Core\Memory\FSharedBuffer) & CompressedData )


code: static [FCompressedBuffer](API\Runtime\Core\Compression\FCompressedBuffer) FromCompressed ( [FSharedBuffer](API\Runtime\Core\Memory\FSharedBuffer) && CompressedData )


description: Returns a composite buffer containing the compressed data. May be null. May not be owned.

code: const [FCompositeBuffer](API\Runtime\Core\Memory\FCompositeBuffer) & GetCompressed() const


description: Returns the size of the compressed data. Zero on error or if this is null.

code: uint64 GetCompressedSize() const


description: Returns the hash of the raw data. Zero on error or if this is null.


description: Returns the size of the raw data. Zero on error or if this is empty or null.

code: uint64 GetRawSize() const


description: Returns true if the compressed buffer is null.

code: bool IsNull() const


description: Returns true if the composite buffer is owned.

code: bool IsOwned() const


description:
The entire compressed buffer will be loaded from the archive before this function returns. Prefer to useFCompressedBufferReaderto stream from an archive when the compressed buffer does not need to be fully loaded into memory.
A compressed buffer, or null on error. Ar.IsError() will be true on error.

code: static [FCompressedBuffer](API\Runtime\Core\Compression\FCompressedBuffer) Load ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar )


description: Returns a copy of the compressed buffer that owns its underlying memory.


description: A null compressed buffer.

code: static const [FCompressedBuffer](API\Runtime\Core\Compression\FCompressedBuffer) Null;


className: FCompressedBuffer::operator bool

description: Returns true if the compressed buffer is not null.

code: operator bool() const


description: Reset this to null.

code: void Reset()


description: Save the compressed buffer to an archive.

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


description:
Decompress into a memory view that is exactly equal to the raw size.
True if the requested range was decompressed, otherwise false.

code: bool TryDecompressTo ( FMutableMemoryView RawView ) const


description:
The compressor and compression level may differ from those specified when creating the buffer because an incompressible buffer is stored with no compression. Parameters cannot be accessed if this is null or uses a method other than Oodle, in which case this returns false.
True if parameters were written, otherwise false.

code: bool TryGetCompressParameters ( [ECompressedBufferCompressor](API\Runtime\Core\Compression\FOodleDataCompression__ECompress-) & OutCompressor, [ECompressedBufferCompressionLevel](API\Runtime\Core\Compression\FOodleDataCompression__ECompress-_1) & OutCompressionLevel, uint64 & OutBlockSize ) const


className: FCompressedBuffer

description: FCompressedBufferReader

code: class FCompressedBuffer


description:
RawOffset must be at most the raw buffer size. RawSize may be MAX_uint64 to read the whole buffer from RawOffset, and must otherwise fit within the bounds of the buffer.
An owned buffer containing the raw data, or null on error.

code: [FCompositeBuffer](API\Runtime\Core\Memory\FCompositeBuffer) DecompressToComposite ( uint64 RawOffset, uint64 RawSize )


code: [FSharedBuffer](API\Runtime\Core\Memory\FSharedBuffer) Decompress ( uint64 RawOffset, uint64 RawSize )


description: Returns the size of the compressed data. Zero on error.

code: uint64 GetCompressedSize()


description: Returns the hash of the raw data. Zero on error.


description: Returns the size of the raw data. Zero on error.

code: uint64 GetRawSize()


description: Release any temporary buffers that have been allocated by the reader.

code: void ResetBuffers()


description: Clears the reference to the source without releasing temporary buffers.

code: void ResetSource()


code: void SetSource ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Archive )


code: void SetSource ( const [FCompressedBuffer](API\Runtime\Core\Compression\FCompressedBuffer) & Buffer )


code: bool TryGetCompressParameters ( [ECompressedBufferCompressor](API\Runtime\Core\Compression\FOodleDataCompression__ECompress-) & OutCompressor, [ECompressedBufferCompressionLevel](API\Runtime\Core\Compression\FOodleDataCompression__ECompress-_1) & OutCompressionLevel, uint64 & OutBlockSize )


description:
Decompress into a memory view that is less than or equal to the available raw size.
True if the requested range was decompressed, otherwise false.

code: bool TryDecompressTo ( FMutableMemoryView RawView, uint64 RawOffset )


description: Construct a reader with no source.

code: FCompressedBufferReader()


description: Construct a reader that will read from an archive as needed.

code: FCompressedBufferReader ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Archive )


description: Construct a reader from an in-memory compressed buffer.

code: FCompressedBufferReader ( const [FCompressedBuffer](API\Runtime\Core\Compression\FCompressedBuffer) & Buffer )


className: FCompressedBufferReader

description: FCompressedBuffer

code: class FCompressedBufferReader


code: FCompressedBufferReaderSourceScope ( [FCompressedBufferReader](API\Runtime\Core\Compression\FCompressedBufferReader) & InReader, [FArchive](API\Runtime\Core\Serialization\FArchive) & InArchive )


code: FCompressedBufferReaderSourceScope ( [FCompressedBufferReader](API\Runtime\Core\Compression\FCompressedBufferReader) & InReader, const [FCompressedBuffer](API\Runtime\Core\Compression\FCompressedBuffer) & InBuffer )


className: FCompressedBufferReaderSourceScope

description: A type that sets the source of a reader upon construction and resets it upon destruction.


code: ~FCompressedBufferReaderSourceScope()


className: FDecoderContext

description: A reusable context for the compressed buffer decoder.

code: struct FDecoderContext

CompressedBlock

type: FUniqueBuffer

description: A buffer used to store a compressed block when it was not in contiguous memory.

Header

description: A buffer used to store the header when HeaderOffset is not MAX_uint64.

description: The CRC-32 from the header, otherwise 0.

HeaderOffset

description: The offset in the source at which the compressed buffer begins, otherwise MAX_uint64.

HeaderSize

description: The size of the header if known, otherwise 0.

RawBlock

description: A buffer used to store a raw block when a partial block read is requested.

RawBlockIndex

description: Indexof the block stored in RawBlock, otherwise MAX_uint32.


description: See CompressData for parameter discussion.

code: namespace FOodleCompressedArray { template<class T> bool FOodleCompressedArray::CompressTArray ( [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & OutCompressed, const [TArray](API\Runtime\Core\Containers\TArray)< T > & InBuffer, [FOodleDataCompression::ECompressor](API\Runtime\Core\Compression\FOodleDataCompression__ECompress-) InCompressor, [FOodleDataCompression::ECompressionLevel](API\Runtime\Core\Compression\FOodleDataCompression__ECompress-_1) InLevel ) }


code: namespace FOodleCompressedArray { template<class T> bool FOodleCompressedArray::CompressTArray64 ( TArray64< uint8 > & OutCompressed, const TArray64< T > & InBuffer, [FOodleDataCompression::ECompressor](API\Runtime\Core\Compression\FOodleDataCompression__ECompress-) InCompressor, [FOodleDataCompression::ECompressionLevel](API\Runtime\Core\Compression\FOodleDataCompression__ECompress-_1) InLevel ) }


description:
Decompress to aTArray. This should be paired with CompressTArray.
Success or failure. Note that if the compress/decompressTArraytypes are mismatched (i.e. have different sizes) this could fail due to granularity concerns.

code: namespace FOodleCompressedArray { template<class T> bool FOodleCompressedArray::DecompressToTArray ( [TArray](API\Runtime\Core\Containers\TArray)< T > & OutDecompressed, [TArray](API\Runtime\Core\Containers\TArray)< uint8 > const & InCompressed ) }


code: namespace FOodleCompressedArray { template<class T> bool FOodleCompressedArray::DecompressToTArray64 ( TArray64< T > & OutDecompressed, TArray64< uint8 > const & InCompressed ) }


code: namespace FOodleCompressedArray { int32 FOodleCompressedArray::PeekSizes64 ( TArray64< uint8 > const & InCompressed, int64 & OutCompressedSize, int64 & OutDecompressedSize ) }


description:
Provides access to the compressed and decompressed sizes.
0 if the FCompressedArray isn't valid, or if the compressed array requires PeekSizes64. Otherwise, the offset to the compressed data in the array.

code: namespace FOodleCompressedArray { int32 FOodleCompressedArray::PeekSizes ( [TArray](API\Runtime\Core\Containers\TArray)< uint8 > const & InCompressed, int32 & OutCompressedSize, int32 & OutDecompressedSize ) }


description: Selkie4 : 1.86:1 , 4232.6 dec MB/s Mermaid4 : 2.21:1 , 2648.9 dec MB/s Kraken4 : 2.44:1 , 1467.1 dec MB/s Leviathan4 : 2.62:1 , 961.8 dec MB/sUENUM() //

code: namespace FOodleDataCompression { enum ECompressor { NotSet = 0, Selkie = 1, Mermaid = 2, Kraken = 3, Leviathan = 4, } }


description: Kraken-4 : 1.55:1 , 718.3 enc MB/s Kraken-3 : 1.71:1 , 541.8 enc MB/s Kraken-2 : 1.88:1 , 434.0 enc MB/s Kraken-1 : 2.10:1 , 369.1 enc MB/s Kraken1 : 2.27:1 , 242.6 enc MB/s Kraken2 : 2.32:1 , 157.4 enc MB/s Kraken3 : 2.39:1 , 34.8 enc MB/s Kraken4 : 2.44:1 , 22.4 enc MB/s Kraken5 : 2.55:1 , 10.1 enc MB/s Kraken6 : 2.56:1 , 5.4 enc MB/s Kraken7 : 2.64:1 , 3.7 enc MB/sUENUM() //

code: namespace FOodleDataCompression { enum ECompressionLevel { HyperFast4 = -4, HyperFast3 = -3, HyperFast2 = -2, HyperFast1 = -1, None = 0, SuperFast = 1, VeryFast = 2, Fast = 3, Normal = 4, Optimal1 = 5, Optimal2 = 6, Optimal3 = 7, Optimal4 = 8, } }


description: For Compression to/fromTArrayand such higher level actions use OodleDataCompressionUtil.h

code: namespace FOodleDataCompression { enum ECompressionCommonUsage { Default = 0, FastRealtimeEncode = 1, SlowerSmallerEncode = 2, SlowestOfflineDistributionEncode = 3, } }


code: namespace FOodleDataCompression { bool FOodleDataCompression::ECompressorFromString ( const class [FString](API\Runtime\Core\Containers\FString) & InName, [ECompressor](API\Runtime\Core\Compression\FOodleDataCompression__ECompress-) & OutCompressor ) }


code: struct LZ4HC_CCtx_internal

compressionLevel

type: short

dictStart

type: const LZ4_byte ...


description: LZ4_streamDecode_t : Never ever use below internal definitions directly ! These definitions are not API/ABI safe, and may change in future versions. If you need static allocation, declare or allocate an LZ4_streamDecode_t object.

code: struct LZ4_streamDecode_t_internal

externalDict

type: const unsigned ...


code: union LZ4_streamDecode_u

table

type: unsigned long l...


code: struct LZ4_stream_t_internal

currentOffset

type: unsigned int

dirty

type: unsigned short

hashTable

type: unsigned int[(1...


code: union LZ4_stream_u


code: template<typename T> auto Requires()


className: CEqualityComparable

description: Describes a type comparable with itself.

code: struct CEqualityComparable


code: template<typename T, typename U> auto Requires ( bool & Result, const T & A, const U & B )


className: CEqualityComparableWith

description: Describes a type comparable with another type.

code: struct CEqualityComparableWith


code: template<typename T> auto Requires ( uint32 & Result, const T & Val )


className: CGetTypeHashable

description: Describes a type with a GetTypeHash overload.

code: struct CGetTypeHashable


code: template<typename T> auto Requires ( DestType Dest, T & Val )


className: CInsertable

description: Describes an insertion operation for a destination type where an instance of another type can be inserted via operator<<.

code: template<typename DestType> struct CInsertable


code: template<typename T> auto Requires ( [UClass](API\Runtime\CoreUObject\UObject\UClass) *& ClassRef )


className: CStaticClassProvider

description: Describes a type with a StaticClass (static) member.

code: struct CStaticClassProvider


code: template<typename T> auto Requires ( [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) *& StructRef )


className: CStaticStructProvider

description: Describes a type with a StaticStruct (static) member.

code: struct CStaticStructProvider


description: Simply forwards to an unqualified GetData(), but can be called from withinTArrayViewwhere GetData() is already a member and so hides any others.

code: namespace ArrayViewPrivate { template<typename T> decltype(auto) ArrayViewPrivate::GetDataHelper ( T && Arg ) }


description: Gets the data from the passed argument and proceeds to reinterpret the resulting elements.

code: namespace ArrayViewPrivate { template<typename T> decltype(auto) ArrayViewPrivate::GetReinterpretedDataHelper ( T && Arg ) }


className: ElementInitType

code: typedef [TCallTraits](API\Runtime\Core\GenericPlatform\TCallTraits)< ElementType >::ParamType ElementInitType


className: bAllowDuplicateKeys

code: enum { bAllowDuplicateKeys = bInAllowDuplicateKeys }


className: KeyInitType

code: typedef [TCallTraits](API\Runtime\Core\GenericPlatform\TCallTraits)< InKeyType >::ParamType KeyInitType


className: BaseKeyFuncs

description: The base KeyFuncs type with some useful definitions for all KeyFuncs; meant to be derived from instead of used directly. bInAllowDuplicateKeys=true is slightly faster because it allows theTSetto skip validating that there isn't already a duplicate entry in theTSet.

code: template<typename ElementType, typename InKeyType, bool bInAllowDuplicateKeys> struct BaseKeyFuncs


description: Calculates a hash index for a key.

code: static uint32 GetKeyHash ( KeyType Key )


code: static bool Matches ( KeyType A, KeyType B )


className: DefaultKeyComparer

description: Default comparer for keys inTLruCache.

code: template<typename KeyType> struct DefaultKeyComparer


description: Calculates a hash index for a key.

code: static uint32 GetKeyHash ( [KeyInitType](API\Runtime\Core\Containers\DefaultKeyFuncs\KeyInitType) Key )


description: Calculates a hash index for a key.

code: template<typename ComparableKey> static uint32 GetKeyHash ( ComparableKey Key )


description: The key used to index the given element.

code: static [KeyInitType](API\Runtime\Core\Containers\DefaultKeyFuncs\KeyInitType) GetSetKey ( [ElementInitType](API\Runtime\Core\Containers\DefaultKeyFuncs\ElementInitType) Element )


code: typedef [TTypeTraits](API\Runtime\Core\Templates\TTypeTraits)< ElementType >::ConstPointerType KeyInitType


description: True if the keys match.

code: static bool Matches ( [KeyInitType](API\Runtime\Core\Containers\DefaultKeyFuncs\KeyInitType) A, [KeyInitType](API\Runtime\Core\Containers\DefaultKeyFuncs\KeyInitType) B )


description: True if the keys match.

code: template<typename ComparableKey> static bool Matches ( [KeyInitType](API\Runtime\Core\Containers\DefaultKeyFuncs\KeyInitType) A, ComparableKey B )


className: DefaultKeyFuncs

description: A default implementation of the KeyFuncs used byTSetwhich uses the element as a key.

code: template<typename ElementType, bool bInAllowDuplicateKeys> struct DefaultKeyFuncs : public [BaseKeyFuncs< ElementType, ElementType, bInAllowDuplicateKeys >](API\Runtime\Core\Containers\BaseKeyFuncs)


code: void Add ( KeyType Key, IndexType Index )


code: void DownHeap ( IndexType HeapIndex )


code: KeyType GetKey ( IndexType Index ) const


code: bool IsPresent ( IndexType Index ) const


code: IndexType Peek ( IndexType Index ) const


code: void operator= ( const [FBinaryHeap](API\Runtime\Core\Containers\FBinaryHeap) & )


description: Reset internal variables to a cleared state, does not free data.

code: void ResetInternal()


code: void Resize ( uint32 NewHeapSize, uint32 NewIndexSize )


code: void ResizeIndexes ( uint32 NewIndexSize )


code: void ResizeHeap ( uint32 NewHeapSize )


code: void Update ( KeyType Key, IndexType Index )


code: FBinaryHeap ( [FBinaryHeap](API\Runtime\Core\Containers\FBinaryHeap) && Other )


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


code: FBinaryHeap ( uint32 InHeapSize, uint32 InIndexSize )


className: FBinaryHeap

description: Copyright (C) 2009 Nine Realms, Inc

code: template<typename KeyType, typename IndexType> class FBinaryHeap

Heap

type: IndexType *

Keys

type: KeyType *


description: Bits within each word are read or written in the current platform's mathematical bitorder (Data[0] & 0x1, Data[0] & 0x2, ... Data[0] & 0x100, ... Data[0] & 0x80000000, Data[1] & 0x1 ... Correctly handles overlap between destination range and source range; the array of destination bits will be a copy of the source bits as they were before the copy started.

code: static void MemmoveBitsWordOrder ( uint32 * DestBits, int32 DestOffset, const uint32 * SourceBits, int32 SourceOffset, uint32 NumBits )


description: Given Data and Offset that specify a specific bit in a specific word, modify Data and Offset so that they specify the same bit but that 0 <= Offset < NumBitsPerDWORD.

code: static void ModularizeWordOffset ( uint32 *& Data, int32 & Offset )


code: static void ModularizeWordOffset ( uint32 const *& Data, int32 & Offset )


code: static void MemmoveBitsWordOrder ( int32 * DestBits, int32 DestOffset, const int32 * SourceBits, int32 SourceOffset, uint32 NumBits )


className: FBitArrayMemory

code: class FBitArrayMemory


code: void AtomicSet ( const bool NewValue )


className: FBitReference::operator bool

code: operator bool() const


code: void operator= ( const bool NewValue )


code: [FBitReference](API\Runtime\Core\Containers\FBitReference) & operator= ( const [FBitReference](API\Runtime\Core\Containers\FBitReference) & Copy )


code: void operator&= ( const bool NewValue )


code: FBitReference ( uint32 & InData, uint32 InMask )


className: BitsPerWord

description: Clang generates 7 instructions for int32 DivideAndRoundUp but only 2 for uint32.

code: static constexpr uint32 BitsPerWord = ((int32)32);


className: FBitReference

description: Used to read/write a bit in the array as a bool.

code: class FBitReference


code: static uint32 CalculateNumWords ( int32 NumBits )


description: Clears the next set bit in the mask and returns its index.

code: static uint32 GetAndClearNextBit ( uint32 & Mask )


className: FBitSet

description: Functions for manipulating bit sets.

code: struct FBitSet


className: FConstBitReference::operator bool


code: FConstBitReference ( const uint32 & InData, uint32 InMask )


className: FConstBitReference

description: Used to read a bit in the array as a bool.

code: class FConstBitReference


className: ForAnyElementType

description: A class that may be used when NeedsElementType=false is specified. If NeedsElementType=true, then this must be present but will not be used, and so can simply be a typedef to void


className: ForElementType

description: A class that receives both the explicit allocation policy template parameters specified by the user of the container, but also the implicit ElementType template parameter from the container type.

code: template<typename ElementType> class ForElementType


className: RequireRangeCheck

description: Determines whether the user of the allocator should do range checks

code: enum { RequireRangeCheck = true }


className: NeedsElementType

description: Determines whether the user of the allocator may use the ForAnyElementType inner class.

code: enum { NeedsElementType = true }


className: SizeType

description: The integral type to be used for element counts and indices used by the allocator and container - must be signed

code: typedef int32 SizeType


className: FContainerAllocatorInterface

description: This is the allocation policy interface; it exists purely to document the policy's interface, and should not be used.

code: class FContainerAllocatorInterface


code: const [FCountingOutputIterator](API\Runtime\Core\Containers\FCountingOutputIterator) & operator+= ( const int32 Amount )


code: const [FCountingOutputIterator](API\Runtime\Core\Containers\FCountingOutputIterator) & operator*() const


code: template<typename T> T operator= ( T Val ) const


code: const [FCountingOutputIterator](API\Runtime\Core\Containers\FCountingOutputIterator) & operator++ ( int )


code: const [FCountingOutputIterator](API\Runtime\Core\Containers\FCountingOutputIterator) & operator++()


className: FCountingOutputIterator

description: This is a basic object which counts how many times it has been incremented

code: struct FCountingOutputIterator


className: Typedef

code: typedef TInlineAllocator< 4 > Typedef


className: FDefaultBitArrayAllocator

code: class FDefaultBitArrayAllocator : public [TSizedInlineAllocator< 4 >](API\Runtime\Core\Containers\TSizedInlineAllocator)


className: FDefaultSetAllocator

code: class FDefaultSetAllocator : public [TSetAllocator<>](API\Runtime\Core\Containers\TSetAllocator)


className: FDefaultSparseArrayAllocator

code: class FDefaultSparseArrayAllocator : public [TSparseArrayAllocator<>](API\Runtime\Core\Containers\TSparseArrayAllocator)


description: Safe for many threads to add concurrently. Not safe to search the table while other threads are adding. Will not resize. Only use for presized tables.

code: void Add_Concurrent ( uint32 Key, uint32 Index )


description: Average # of compares per search.

code: float AverageSearch() const


code: void Add ( uint32 Key, uint32 Index )


className: EmptyHash

description: Avoids allocating hash until first add.

code: static uint32 EmptyHash = { ~0u };


description: First in hash chain.

code: uint32 First ( uint32 Key ) const


description: Next in hash chain.

code: uint32 Next ( uint32 Index ) const


code: void Remove ( uint32 Key, uint32 Index )


code: void Clear ( uint32 InHashSize, uint32 InIndexSize )


code: FHashTable ( const [FHashTable](API\Runtime\Core\Containers\FHashTable) & Other )


code: FHashTable ( uint32 InHashSize, uint32 InIndexSize )


className: FHashTable

code: class FHashTable

Hash

type: uint32 *


className: FIndexedLockFreeLink

code: struct FIndexedLockFreeLink

DoubleNext

type: FIndexedPointer

Payload

type: void *


code: void AdvanceCounterAndState ( const [FIndexedPointer](API\Runtime\Core\Containers\FIndexedPointer) & From, uint64 TABAInc )


code: void AtomicRead ( const [FIndexedPointer](API\Runtime\Core\Containers\FIndexedPointer) & Other )


code: template<uint64 TABAInc> uint64 GetState() const


description: This should only be used forFIndexedPointer's with no outstanding concurrency. Not recycled links, for example.

code: void Init()


code: bool InterlockedCompareExchange ( const [FIndexedPointer](API\Runtime\Core\Containers\FIndexedPointer) & Exchange, const [FIndexedPointer](API\Runtime\Core\Containers\FIndexedPointer) & Comparand )


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


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


code: void SetAll ( uint32 Ptr, uint64 CounterAndState )


code: void SetCounterAndState ( uint64 To )


code: template<uint64 TABAInc> void SetState ( uint64 Value )


className: FIndexedPointer

code: struct FIndexedPointer


description: S

code: void PushParam ( const TCHAR * Data )


description: Constructor

code: FLazyPrintf ( const TCHAR * InputWithPercentS )


className: FLazyPrintf

description: To avoid limits with the Printf parameter count, for more readability and type safety

code: class FLazyPrintf


code: static [FIndexedLockFreeLink](API\Runtime\Core\Containers\FIndexedLockFreeLink) * DerefLink ( uint32 Ptr )


code: static void FreeLockFreeLink ( uint32 Item )


code: static [FIndexedLockFreeLink](API\Runtime\Core\Containers\FIndexedLockFreeLink) * IndexToLink ( uint32 Index )


code: static uint32 IndexToPtr ( uint32 Index )


code: enum { MAX_BITS_IN_TLinkPtr = (26) }


className: TAllocator

code: typedef [TLockFreeAllocOnceIndexedAllocator](API\Runtime\Core\Containers\TLockFreeAllocOnceIndexedAllocat-)< [FIndexedLockFreeLink](API\Runtime\Core\Containers\FIndexedLockFreeLink),(1<< 26), 16384 > TAllocator


className: FLockFreeLinkPolicy

description: There is a version of this code that uses 128 bit atomics to avoid the indirection, that is why we have this policy class at all.

code: struct FLockFreeLinkPolicy


code: void PopAll ( [TArray](API\Runtime\Core\Containers\TArray)< T * > & OutArray )


code: FLockFreePointerFIFOBase &40; const FLockFreePointerFIFOBase & &41;


code: FLockFreePointerFIFOBase &40; FLockFreePointerFIFOBase && &41;


code: void PopAllAndChangeState ( [TArray](API\Runtime\Core\Containers\TArray)< T * > & OutArray, [TFunctionRef](API\Runtime\Core\GenericPlatform\TFunctionRef)< uint64(uint64)> StateChange )


code: bool PushIf ( T * InPayload, [TFunctionRef](API\Runtime\Core\GenericPlatform\TFunctionRef)< bool(uint64)> OkToPush )


code: FLockFreePointerListLIFOBase &40; FLockFreePointerListLIFOBase && &41;


code: FLockFreePointerListLIFOBase &40; const FLockFreePointerListLIFOBase & &41;


className: FLockFreePointerFIFOBase

code: template<class T, int TPaddingForCacheContention, uint64 TABAInc> class FLockFreePointerFIFOBase


className: FLockFreePointerListLIFOBase

code: template<class T, int TPaddingForCacheContention, uint64 TABAInc> class FLockFreePointerListLIFOBase


code: TLinkPtr PopAllAndChangeState ( [TFunctionRef](API\Runtime\Core\GenericPlatform\TFunctionRef)< uint64(uint64)> StateChange )


code: bool PushIf ( [TFunctionRef](API\Runtime\Core\GenericPlatform\TFunctionRef)< TLinkPtr(uint64)> AllocateIfOkToPush )


code: FLockFreePointerListLIFORoot &40; FLockFreePointerListLIFORoot && &41;


code: FLockFreePointerListLIFORoot &40; const FLockFreePointerListLIFORoot & &41;


className: FLockFreePointerListLIFORoot

code: template<int TPaddingForCacheContention, uint64 TABAInc> class FLockFreePointerListLIFORoot


code: bool operator== ( const [FNull](API\Runtime\Core\Containers\FNull) & ) const


code: bool operator!= ( const [FNull](API\Runtime\Core\Containers\FNull) & ) const


code: namespace Freeze { template<typename T, typename AllocatorType> uint32 Freeze::IntrinsicAppendHash ( const [TArray](API\Runtime\Core\Containers\TArray)< T, AllocatorType > * DummyObject, const [FTypeLayoutDesc](API\Runtime\Core\Serialization\FTypeLayoutDesc) & TypeDesc, const [FPlatformTypeLayoutParameters](API\Runtime\Core\Serialization\FPlatformTypeLayoutParameters) & LayoutParams, [FSHA1](API\Runtime\Core\Misc\FSHA1) & Hasher ) }


code: namespace Freeze { template<typename InAllocator> uint32 Freeze::IntrinsicAppendHash ( const [THashTable](API\Runtime\Core\Containers\THashTable)< InAllocator > * DummyObject, const [FTypeLayoutDesc](API\Runtime\Core\Serialization\FTypeLayoutDesc) & TypeDesc, const [FPlatformTypeLayoutParameters](API\Runtime\Core\Serialization\FPlatformTypeLayoutParameters) & LayoutParams, [FSHA1](API\Runtime\Core\Misc\FSHA1) & Hasher ) }


code: namespace Freeze { template<typename KeyType, typename ValueType, typename SetAllocator, typename KeyFuncs> uint32 Freeze::IntrinsicAppendHash ( const [TMap](API\Runtime\Core\Containers\TMap)< KeyType, ValueType, SetAllocator, KeyFuncs > * DummyObject, const [FTypeLayoutDesc](API\Runtime\Core\Serialization\FTypeLayoutDesc) & TypeDesc, const [FPlatformTypeLayoutParameters](API\Runtime\Core\Serialization\FPlatformTypeLayoutParameters) & LayoutParams, [FSHA1](API\Runtime\Core\Misc\FSHA1) & Hasher ) }


code: namespace Freeze { template<typename KeyType, typename ValueType, typename SetAllocator, typename KeyFuncs> uint32 Freeze::IntrinsicAppendHash ( const [TMultiMap](API\Runtime\Core\Containers\TMultiMap)< KeyType, ValueType, SetAllocator, KeyFuncs > * DummyObject, const [FTypeLayoutDesc](API\Runtime\Core\Serialization\FTypeLayoutDesc) & TypeDesc, const [FPlatformTypeLayoutParameters](API\Runtime\Core\Serialization\FPlatformTypeLayoutParameters) & LayoutParams, [FSHA1](API\Runtime\Core\Misc\FSHA1) & Hasher ) }


code: namespace Freeze { template<typename ElementType, typename KeyFuncs, typename Allocator> uint32 Freeze::IntrinsicAppendHash ( const [TSet](API\Runtime\Core\Containers\TSet)< ElementType, KeyFuncs, Allocator > * DummyObject, const [FTypeLayoutDesc](API\Runtime\Core\Serialization\FTypeLayoutDesc) & TypeDesc, const [FPlatformTypeLayoutParameters](API\Runtime\Core\Serialization\FPlatformTypeLayoutParameters) & LayoutParams, [FSHA1](API\Runtime\Core\Misc\FSHA1) & Hasher ) }


code: namespace Freeze { template<typename ElementType, typename Allocator> uint32 Freeze::IntrinsicAppendHash ( const [TSparseArray](API\Runtime\Core\Containers\TSparseArray)< ElementType, Allocator > * DummyObject, const [FTypeLayoutDesc](API\Runtime\Core\Serialization\FTypeLayoutDesc) & TypeDesc, const [FPlatformTypeLayoutParameters](API\Runtime\Core\Serialization\FPlatformTypeLayoutParameters) & LayoutParams, [FSHA1](API\Runtime\Core\Misc\FSHA1) & Hasher ) }


code: namespace Freeze { template<typename T, typename AllocatorType> uint32 Freeze::IntrinsicGetTargetAlignment ( const [TArray](API\Runtime\Core\Containers\TArray)< T, AllocatorType > * DummyObject, const [FTypeLayoutDesc](API\Runtime\Core\Serialization\FTypeLayoutDesc) & TypeDesc, const [FPlatformTypeLayoutParameters](API\Runtime\Core\Serialization\FPlatformTypeLayoutParameters) & LayoutParams ) }


code: namespace Freeze { template<typename InAllocator> uint32 Freeze::IntrinsicGetTargetAlignment ( const [THashTable](API\Runtime\Core\Containers\THashTable)< InAllocator > * DummyObject, const [FTypeLayoutDesc](API\Runtime\Core\Serialization\FTypeLayoutDesc) & TypeDesc, const [FPlatformTypeLayoutParameters](API\Runtime\Core\Serialization\FPlatformTypeLayoutParameters) & LayoutParams ) }


code: namespace Freeze { template<typename T, typename AllocatorType> void Freeze::IntrinsicToString ( const [TArray](API\Runtime\Core\Containers\TArray)< T, AllocatorType > & Object, const [FTypeLayoutDesc](API\Runtime\Core\Serialization\FTypeLayoutDesc) & TypeDesc, const [FPlatformTypeLayoutParameters](API\Runtime\Core\Serialization\FPlatformTypeLayoutParameters) & LayoutParams, [FMemoryToStringContext](API\Runtime\Core\Serialization\FMemoryToStringContext) & OutContext ) }


code: namespace Freeze { template<typename T, typename AllocatorType> uint32 Freeze::IntrinsicUnfrozenCopy ( const [FMemoryUnfreezeContent](API\Runtime\Core\Serialization\FMemoryUnfreezeContent) & Context, const [TArray](API\Runtime\Core\Containers\TArray)< T, AllocatorType > & Object, void * OutDst ) }


code: namespace Freeze { template<typename KeyType, typename ValueType, typename SetAllocator, typename KeyFuncs> uint32 Freeze::IntrinsicUnfrozenCopy ( const [FMemoryUnfreezeContent](API\Runtime\Core\Serialization\FMemoryUnfreezeContent) & Context, const [TMap](API\Runtime\Core\Containers\TMap)< KeyType, ValueType, SetAllocator, KeyFuncs > & Object, void * OutDst ) }


code: namespace Freeze { template<typename InAllocator> uint32 Freeze::IntrinsicUnfrozenCopy ( const [FMemoryUnfreezeContent](API\Runtime\Core\Serialization\FMemoryUnfreezeContent) & Context, const [THashTable](API\Runtime\Core\Containers\THashTable)< InAllocator > & Object, void * OutDst ) }


code: namespace Freeze { template<typename KeyType, typename ValueType, typename SetAllocator, typename KeyFuncs> uint32 Freeze::IntrinsicUnfrozenCopy ( const [FMemoryUnfreezeContent](API\Runtime\Core\Serialization\FMemoryUnfreezeContent) & Context, const [TMultiMap](API\Runtime\Core\Containers\TMultiMap)< KeyType, ValueType, SetAllocator, KeyFuncs > & Object, void * OutDst ) }


code: namespace Freeze { template<typename ElementType, typename KeyFuncs, typename Allocator> uint32 Freeze::IntrinsicUnfrozenCopy ( const [FMemoryUnfreezeContent](API\Runtime\Core\Serialization\FMemoryUnfreezeContent) & Context, const [TSet](API\Runtime\Core\Containers\TSet)< ElementType, KeyFuncs, Allocator > & Object, void * OutDst ) }


code: namespace Freeze { template<typename ElementType, typename Allocator> uint32 Freeze::IntrinsicUnfrozenCopy ( const [FMemoryUnfreezeContent](API\Runtime\Core\Serialization\FMemoryUnfreezeContent) & Context, const [TSparseArray](API\Runtime\Core\Containers\TSparseArray)< ElementType, Allocator > & Object, void * OutDst ) }


code: namespace Freeze { template<typename T, typename AllocatorType> void Freeze::IntrinsicWriteMemoryImage ( [FMemoryImageWriter](API\Runtime\Core\Serialization\FMemoryImageWriter) & Writer, const [TArray](API\Runtime\Core\Containers\TArray)< T, AllocatorType > & Object, const [FTypeLayoutDesc](API\Runtime\Core\Serialization\FTypeLayoutDesc) & ) }


code: namespace Freeze { template<typename Allocator> void Freeze::IntrinsicWriteMemoryImage ( [FMemoryImageWriter](API\Runtime\Core\Serialization\FMemoryImageWriter) & Writer, const [TBitArray](API\Runtime\Core\Containers\TBitArray)< Allocator > & Object, const [FTypeLayoutDesc](API\Runtime\Core\Serialization\FTypeLayoutDesc) & ) }


code: namespace Freeze { template<typename InAllocator> void Freeze::IntrinsicWriteMemoryImage ( [FMemoryImageWriter](API\Runtime\Core\Serialization\FMemoryImageWriter) & Writer, const [THashTable](API\Runtime\Core\Containers\THashTable)< InAllocator > & Object, const [FTypeLayoutDesc](API\Runtime\Core\Serialization\FTypeLayoutDesc) & ) }


code: namespace Freeze { template<typename KeyType, typename ValueType, typename SetAllocator, typename KeyFuncs> void Freeze::IntrinsicWriteMemoryImage ( [FMemoryImageWriter](API\Runtime\Core\Serialization\FMemoryImageWriter) & Writer, const [TMap](API\Runtime\Core\Containers\TMap)< KeyType, ValueType, SetAllocator, KeyFuncs > & Object, const [FTypeLayoutDesc](API\Runtime\Core\Serialization\FTypeLayoutDesc) & ) }


code: namespace Freeze { template<typename KeyType, typename ValueType, typename SetAllocator, typename KeyFuncs> void Freeze::IntrinsicWriteMemoryImage ( [FMemoryImageWriter](API\Runtime\Core\Serialization\FMemoryImageWriter) & Writer, const [TMultiMap](API\Runtime\Core\Containers\TMultiMap)< KeyType, ValueType, SetAllocator, KeyFuncs > & Object, const [FTypeLayoutDesc](API\Runtime\Core\Serialization\FTypeLayoutDesc) & ) }


code: namespace Freeze { template<typename ElementType, typename KeyFuncs, typename Allocator> void Freeze::IntrinsicWriteMemoryImage ( [FMemoryImageWriter](API\Runtime\Core\Serialization\FMemoryImageWriter) & Writer, const [TSet](API\Runtime\Core\Containers\TSet)< ElementType, KeyFuncs, Allocator > & Object, const [FTypeLayoutDesc](API\Runtime\Core\Serialization\FTypeLayoutDesc) & ) }


code: namespace Freeze { template<typename ElementType, typename Allocator> void Freeze::IntrinsicWriteMemoryImage ( [FMemoryImageWriter](API\Runtime\Core\Serialization\FMemoryImageWriter) & Writer, const [TSparseArray](API\Runtime\Core\Containers\TSparseArray)< ElementType, Allocator > & Object, const [FTypeLayoutDesc](API\Runtime\Core\Serialization\FTypeLayoutDesc) & ) }


code: FRelativeBitReference ( int32 BitIndex )


className: FRelativeBitReference

description: Used to reference a bit in an unspecified bit array.

code: class FRelativeBitReference


className: CounterBase

code: static constexpr int CounterBase = __COUNTER__;


description: Called on non-UMA systems after the RHI has copied the resource data, and no longer needs the CPU's copy.

code: void Discard()


description: true if the resource keeps a copy of its resource data after the RHI resource has been created

code: bool GetAllowCPUAccess() const


description: A pointer to the resource data.

code: const void * GetResourceData() const


description: size of resource data allocation

code: uint32 GetResourceDataSize() const


className: InterfaceType

code: static constexpr [ETypeLayoutInterface::Type](API\Runtime\Core\Serialization\ETypeLayoutInterface__Type) InterfaceType = ETypeLayoutInterface:: Abstract;


className: InternalBaseType

code: typedef typename [TGetBaseTypeHelper](API\Runtime\Core\Serialization\TGetBaseTypeHelper)< [FResourceArrayInterface](API\Runtime\Core\Containers\FResourceArrayInterface) >::Type InternalBaseType


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


className: InternalLinkType

code: template<int Counter> struct InternalLinkType


description: true if the resource array is static and shouldn't be modified

code: bool IsStatic() const


description: Sets whether the resource array will be accessed by CPU.

code: void SetAllowCPUAccess ( bool bInNeedsCPUAccess )


code: virtual const [FTypeLayoutDesc](API\Runtime\Core\Serialization\FTypeLayoutDesc) & GetTypeLayout() const


code: static CORE_API[FTypeLayoutDesc](API\Runtime\Core\Serialization\FTypeLayoutDesc) & StaticGetTypeLayout()


className: FResourceArrayInterface

description: An element type independent interface to the resource array.

code: class FResourceArrayInterface


description: Free memory after it has been used to initialize RHI resource


className: EBulkDataType

code: enum EBulkDataType { Default, MediaTexture, VREyeBuffer, }


description: ptr to the resource memory which has been preallocated

code: const void * GetResourceBulkData() const


description: size of resource memory

code: uint32 GetResourceBulkDataSize() const


description: the type of bulk data for special handling

code: virtual [EBulkDataType](API\Runtime\Core\Containers\FResourceBulkDataInterface\EBulkDataType) GetResourceType() const


code: virtual ~FResourceBulkDataInterface()


className: FResourceBulkDataInterface

description: Allows for direct GPU mem allocation for bulk resource types.

code: class FResourceBulkDataInterface


code: void MoveAssign ( [FScriptArray](API\Runtime\Core\Containers\FScriptArray) & Other, int32 NumBytesPerElement, uint32 AlignmentOfElement )


code: void operator= ( const [FScriptArray](API\Runtime\Core\Containers\FScriptArray) & )


className: Super

code: typedef [TScriptArray](API\Runtime\Core\Containers\TScriptArray)< FHeapAllocator > Super


description: These should really be private, because they shouldn't be called, but there's a bunch of code that needs to be fixed first.

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


code: FScriptArray ( int32 InNum, int32 NumBytesPerElement, uint32 AlignmentOfElement )


className: FScriptArray

code: class FScriptArray : public [TScriptArray< FHeapAllocator >](API\Runtime\Core\Containers\TScriptArray)


className: FScriptBitArray

code: class FScriptBitArray : public [TScriptBitArray< FDefaultBitArrayAllocator, FScriptBitArray >](API\Runtime\Core\Containers\TScriptBitArray)


className: FScriptContainerElement

description: A type which is used to represent a script type that is unknown at compile time.

code: struct FScriptContainerElement


className: FScriptMap

code: class FScriptMap : public [TScriptMap< FDefaultSetAllocator, FScriptMap >](API\Runtime\Core\Containers\TScriptMap)


code: typedef [TScriptMap](API\Runtime\Core\Containers\TScriptMap)< [FDefaultSetAllocator](API\Runtime\Core\Containers\FDefaultSetAllocator), [FScriptMap](API\Runtime\Core\Containers\FScriptMap) > Super


className: FScriptMapLayout

code: struct FScriptMapLayout

SetLayout

type: FScriptSetLayou...

ValueOffset

description: Int32 KeyOffset; // is always at zero offset from the TPair - not stored here


code: typedef [TScriptSet](API\Runtime\Core\Containers\TScriptSet)< [FDefaultSetAllocator](API\Runtime\Core\Containers\FDefaultSetAllocator), [FScriptSet](API\Runtime\Core\Containers\FScriptSet) > Super


className: FScriptSet

code: class FScriptSet : public [TScriptSet< FDefaultSetAllocator, FScriptSet >](API\Runtime\Core\Containers\TScriptSet)


className: FScriptSetLayout

code: struct FScriptSetLayout

HashNextIdOffset

description: Int32 ElementOffset = 0; // always at zero offset from theTSetElement- not stored here

SparseArrayLayout

type: FScriptSparseAr...


className: FScriptSparseArray

code: class FScriptSparseArray : public [TScriptSparseArray< FDefaultSparseArrayAllocator, FScriptSparseArray >](API\Runtime\Core\Containers\TScriptSparseArray)


className: FScriptSparseArrayLayout

code: struct FScriptSparseArrayLayout

Alignment

description: ElementOffset is at zero offset from theTSparseArrayElementOrFreeListLink- not stored here.


code: static [FSetElementId](API\Runtime\Core\Containers\FSetElementId) FromInteger ( int32 Integer )


description: a boolean value representing whether the id is NULL.

code: bool IsValidId() const


description: Default constructor.

code: FSetElementId()


description: Initialization constructor.

code: FSetElementId &40; int32 InIndex &41;


className: FSetElementId

description: Either NULL or an identifier for an element of a set.

code: class FSetElementId


className: FSparseArrayAllocationInfo

description: The result of a sparse array allocation.

code: struct FSparseArrayAllocationInfo


description: Captures the current stack and updates stack tracking information. optionally stores a user data pointer that the tracker will take ownership of and delete upon reset you must allocate the memory withFMemory::Malloc()or provide a custom delete function

code: void CaptureStackTrace ( int32 EntriesToIgnore, void * UserData, int32 StackLen, bool bLookupStringsForAliasRemoval )


code: static void DefaultDeleteUserDataFn ( void * UserData )


description: Dumps capture stack trace summary to the passed in log.

code: void DumpStackTraces ( int32 StackThreshold, [FOutputDevice](API\Runtime\Core\Misc\FOutputDevice) & Ar, float SampleCountCorrectionFactor )


className: FCallStack

description: Helper structure to capture callstack addresses and stack count.

code: struct FCallStack

Addresses

description: Program counter addresses for callstack.

StackCount

description: Stack count, aka the number of calls to CalculateStack

UserData

description: User data to store with the stack trace for later use


description: Maximum number of backtrace depth.

code: static constexpr int32 MAX_BACKTRACE_DEPTH = 50;


description: Resets stack tracking. Deletes all user pointers passed in viaCaptureStackTrace()

code: void ResetTracking()


className: StackTrackerDeleteUserDataFn

description: Used to delete a provided userdata pointer e.g. call the correct destructor


className: StackTrackerReportFn

description: Used to optionally report information based on the current stack

code: typedef void(* StackTrackerReportFn


className: StackTrackerUpdateFn

description: Used to optionally update the information currently stored with the callstack

code: typedef void(* StackTrackerUpdateFn


description: Toggles tracking.

code: void ToggleTracking()


description: Toggles tracking.

code: void ToggleTracking ( bool bEnable, bool bSilent )


description: Constructor, initializing all member variables

code: FStackTracker ( [StackTrackerUpdateFn](API\Runtime\Core\Containers\FStackTracker\StackTrackerUpdateFn) InUpdateFn, [StackTrackerReportFn](API\Runtime\Core\Containers\FStackTracker\StackTrackerReportFn) InReportFn, [StackTrackerDeleteUserDataFn](API\Runtime\Core\Containers\FStackTracker\StackTrackerDeleteUserDataFn) InDeleteUserDataFn, bool bInIsEnabled )


className: FStackTracker

description: Stack tracker. Used to identify callstacks at any point in the codebase.

code: struct FStackTracker


code: T * Pop ( int32 MyThread, bool bAllowStall )


code: int32 Push ( T * InPayload, uint32 Priority )


code: FStallingTaskQueue &40; FStallingTaskQueue && &41;


code: FStallingTaskQueue &40; const FStallingTaskQueue & &41;


className: FStallingTaskQueue

code: template<class T, int TPaddingForCacheContention, int NumPriorities> class FStallingTaskQueue


className: AllocatorType

code: typedef [TSizedDefaultAllocator](API\Runtime\Core\Containers\TSizedDefaultAllocator)< 32 > AllocatorType


description: Append a string and return a reference to this

code: template<typename CharRangeType, typename [TEnableIf](API\Runtime\Core\Templates\TEnableIf)< [TIsCharRangeNotCArray](API\Runtime\Core\Templates\TAnd)< CharRangeType >::Value >::Type *> [FString](API\Runtime\Core\Containers\FString) & Append ( CharRangeType && Str )


description: CharType is not const to use this overload for mutable char arrays and call Strlen() instead of getting the static length N from GetNum((&T)[N]). Oddly MSVC ranks a const T* overload over T&& for T[N] while clang picks T&&.

code: template<class CharType> [FString](API\Runtime\Core\Containers\FString) & Append ( CharType * Str )


code: template<class CharType> [FString](API\Runtime\Core\Containers\FString) & Append ( const CharType * Str, int32 Count )


description: Append a single character and return a reference to this

code: [FString](API\Runtime\Core\Containers\FString) & AppendChar ( TCHAR InChar )


description: Appends a character range without null-terminators in it

code: void AppendChars ( const ANSICHAR * Str, int32 Count )


code: void AppendChars ( const WIDECHAR * Str, int32 Count )


code: void AppendChars ( const UCS2CHAR * Str, int32 Count )


code: void AppendChars ( const [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * Str, int32 Count )


description:
Just like Printf, but appends the formatted text to the existingFStringinstead.
a reference to the modified string, so that it can be chained

code: template<typename FmtType, typename... Types> [FString](API\Runtime\Core\Containers\FString) & Appendf ( const FmtType & Fmt, Types... Args )


description: Appends the integer InNum to this string

code: void AppendInt ( int32 InNum )


description: DO NOT USE DIRECTLY STL-like iterators to enable range-based for loop support.


description: Run slow checks on this string

code: void CheckInvariants() const


description: Returns a string containing only the Ch character

code: static [FString](API\Runtime\Core\Containers\FString) Chr ( TCHAR Ch )


description:
Returns a string that is full of a variable number of characters
The string of NumCharacters characters.

code: static [FString](API\Runtime\Core\Containers\FString) ChrN ( int32 NumCharacters, TCHAR Char )


description:
Lexicographically tests how this string compares to the Other given string
0 if equal, negative if less than, positive if greater than

code: int32 Compare ( const [FString](API\Runtime\Core\Containers\FString) & Other, [ESearchCase::Type](API\Runtime\Core\Misc\ESearchCase__Type) SearchCase ) const


description:
Returns whether this string contains the specified substring.
Returns whether the string contains the substring. If the substring is empty, returns true.

code: template<typename TCharRangeType, std::enable_if_t< [TIsCharRangeNotCArrayNotFString](API\Runtime\Core\Templates\TAnd)< TCharRangeType >::Value > *> bool Contains ( TCharRangeType && SubStr, [ESearchCase::Type](API\Runtime\Core\Misc\ESearchCase__Type) SearchCase, [ESearchDir::Type](API\Runtime\Core\Misc\ESearchDir__Type) SearchDir ) const


code: bool Contains ( const TCHAR * SubStr, [ESearchCase::Type](API\Runtime\Core\Misc\ESearchCase__Type) SearchCase, [ESearchDir::Type](API\Runtime\Core\Misc\ESearchDir__Type) SearchDir ) const


code: bool Contains ( const [FString](API\Runtime\Core\Containers\FString) & SubStr, [ESearchCase::Type](API\Runtime\Core\Misc\ESearchCase__Type) SearchCase, [ESearchDir::Type](API\Runtime\Core\Misc\ESearchDir__Type) SearchDir ) const


code: bool Contains ( const TCHAR * SubStr, int32 SubStrLen, [ESearchCase::Type](API\Runtime\Core\Misc\ESearchCase__Type) SearchCase, [ESearchDir::Type](API\Runtime\Core\Misc\ESearchDir__Type) SearchDir ) const


description:
Replaces all instances of '' with TabWidth number of spaces
copy of this string with replacement made

code: [FString](API\Runtime\Core\Containers\FString) ConvertTabsToSpaces ( const int32 InSpacesPerTab ) const


code: [FString](API\Runtime\Core\Containers\FString) ConvertTabsToSpaces ( const int32 InSpacesPerTab )


description: Replaces all instances of '' with TabWidth number of spaces

code: void ConvertTabsToSpacesInline ( const int32 InSpacesPerTab )


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


description: Creates a const iterator for the characters in this string


description: Creates an iterator for the characters in this string


description:
Takes an array of strings and removes any zero length entries.
The number of elements left in InArray

code: static int32 CullArray ( [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > * InArray )


className: DataType

description: Array holding the character data

code: typedef [TArray](API\Runtime\Core\Containers\TArray)< TCHAR, [AllocatorType](API\Runtime\Core\Containers\FString\AllocatorType) > DataType


className: ElementType

code: typedef TCHAR ElementType


description: Create empty string of given size with zero terminating character

code: void Empty ( int32 Slack )


code: void Empty()


description:
Test whether this string ends with given suffix.
true if this string ends with specified text, false otherwise

code: template<typename TCharRangeType, std::enable_if_t< [TIsCharRangeNotCArrayNotFString](API\Runtime\Core\Templates\TAnd)< TCharRangeType >::Value > *> bool EndsWith ( TCharRangeType && InSuffix, [ESearchCase::Type](API\Runtime\Core\Misc\ESearchCase__Type) SearchCase ) const


code: bool EndsWith ( const TCHAR * InSuffix, [ESearchCase::Type](API\Runtime\Core\Misc\ESearchCase__Type) SearchCase ) const


code: bool EndsWith ( const [FString](API\Runtime\Core\Containers\FString) & InSuffix, [ESearchCase::Type](API\Runtime\Core\Misc\ESearchCase__Type) SearchCase ) const


code: bool EndsWith ( const TCHAR * InSuffix, int32 InSuffixLen, [ESearchCase::Type](API\Runtime\Core\Misc\ESearchCase__Type) SearchCase ) const


description:
Lexicographically tests whether this string is equivalent to the Other given string
true if this string is lexicographically equivalent to the other, otherwise false

code: bool Equals ( const [FString](API\Runtime\Core\Containers\FString) & Other, [ESearchCase::Type](API\Runtime\Core\Misc\ESearchCase__Type) SearchCase ) const


description: Consider using UE::String::FindLast() as an alternative.

code: template<typename TCharRangeType, std::enable_if_t< [TIsCharRangeNotCArrayNotFString](API\Runtime\Core\Templates\TAnd)< TCharRangeType >::Value > *> int32 Find ( TCharRangeType && SubStr, [ESearchCase::Type](API\Runtime\Core\Misc\ESearchCase__Type) SearchCase, [ESearchDir::Type](API\Runtime\Core\Misc\ESearchDir__Type) SearchDir, int32 StartPosition ) const


description: Searches the string for a substring, and returns index into this string of the first found instance. Can search from beginning or end, and ignore case or not. If substring is empty, returns clamped StartPosition.

code: int32 Find ( const TCHAR * SubStr, [ESearchCase::Type](API\Runtime\Core\Misc\ESearchCase__Type) SearchCase, [ESearchDir::Type](API\Runtime\Core\Misc\ESearchDir__Type) SearchDir, int32 StartPosition ) const


code: int32 Find ( const [FString](API\Runtime\Core\Containers\FString) & SubStr, [ESearchCase::Type](API\Runtime\Core\Misc\ESearchCase__Type) SearchCase, [ESearchDir::Type](API\Runtime\Core\Misc\ESearchDir__Type) SearchDir, int32 StartPosition ) const


code: int32 Find ( const TCHAR * SubStr, int32 InSubStrLen, [ESearchCase::Type](API\Runtime\Core\Misc\ESearchCase__Type) SearchCase, [ESearchDir::Type](API\Runtime\Core\Misc\ESearchDir__Type) SearchDir, int32 StartPosition ) const


description:
Searches the string for a character
true if character was found in this string, otherwise false

code: bool FindChar ( TCHAR InChar, int32 & Index ) const


description:
Searches the string for the last occurrence of a character
true if character was found in this string, otherwise false

code: bool FindLastChar ( TCHAR InChar, int32 & Index ) const


description: Searches the string for the last occurrence of a character which matches the specified predicate.Indexof found TCHAR, INDEX_NONE otherwise.

code: template<typename Predicate> int32 FindLastCharByPredicate ( Predicate Pred ) const


description: Searches an initial substring for the last occurrence of a character which matches the specified predicate.Indexof found TCHAR, INDEX_NONE otherwise.

code: template<typename Predicate> int32 FindLastCharByPredicate ( Predicate Pred, int32 Count ) const


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

code: static [FString](API\Runtime\Core\Containers\FString) Format ( const TCHAR * InFormatString, const FStringFormatNamedArguments & InNamedArguments )


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

code: static [FString](API\Runtime\Core\Containers\FString) Format ( const TCHAR * InFormatString, const FStringFormatOrderedArguments & InOrderedArguments )


description: Takes the number passed in and formats the string in comma format ( 12345 becomes "12,345")

code: static [FString](API\Runtime\Core\Containers\FString) FormatAsNumber ( int32 InNumber )


description:
Converts a buffer to a string
the blob in string form

code: static [FString](API\Runtime\Core\Containers\FString) FromBlob ( const uint8 * SrcBuffer, const uint32 SrcSize )


description:
Converts a buffer to a string by hex-ifying the elements
the blob in string form

code: static [FString](API\Runtime\Core\Containers\FString) FromHexBlob ( const uint8 * SrcBuffer, const uint32 SrcSize )


description: Converts an integer to a string.

code: static [FString](API\Runtime\Core\Containers\FString) FromInt ( int32 Num )


description: Get string as const array of TCHARS

code: const [DataType](API\Runtime\Core\Containers\TArray) & GetCharArray() const


code: void InsertAt ( int32 Index, const [FString](API\Runtime\Core\Containers\FString) & Characters )


code: void InsertAt ( int32 Index, TCHAR Character )


description:
Test whether this string is empty
true if this string is empty, otherwise return false.

code: bool IsEmpty() const


description: Returns true if the string only contains numeric characters

code: bool IsNumeric() const


description:
Tests if index is valid, i.e. greater than or equal to zero, and less than the number of characters in this string (excluding the null terminator).
True if index is valid. False otherwise.

code: bool IsValidIndex ( int32 Index ) const


description:
Joins a range of 'something that can be concatentated to strings with +=' together into a single string with separators.
The final, joined, separated string.

code: template<typename RangeType> static [FString](API\Runtime\Core\Containers\FString) Join ( const RangeType & Range, const TCHAR * Separator )


description:
Joins a range of elements together into a single string with separators using a projection function.
The final, joined, separated string.

code: template<typename RangeType, typename ProjectionType> static [FString](API\Runtime\Core\Containers\FString) JoinBy ( const RangeType & Range, const TCHAR * Separator, ProjectionType Proj )


description: Returns the left most given number of characters

code: [FString](API\Runtime\Core\Containers\FString) Left ( int32 Count ) const


code: [FString](API\Runtime\Core\Containers\FString) Left ( int32 Count )


description: Returns the left most characters from the string chopping the given number of characters from the end

code: [FString](API\Runtime\Core\Containers\FString) LeftChop ( int32 Count ) const


code: [FString](API\Runtime\Core\Containers\FString) LeftChop ( int32 Count )


description: Modifies the string such that it is now the left most characters chopping the given number of characters from the end

code: void LeftChopInline ( int32 Count, bool bAllowShrinking )


description: Modifies the string such that it is now the left most given number of characters

code: void LeftInline ( int32 Count, bool bAllowShrinking )


description: Pad the left of this string for ChCount characters

code: [FString](API\Runtime\Core\Containers\FString) LeftPad ( int32 ChCount ) const


description: Get the length of the string, excluding terminating character

code: int32 Len() const


description:
This is a simple, SLOW routine. Use with caution
true if this string matches the *?-type wildcard given.

code: template<typename TCharRangeType, std::enable_if_t< [TIsCharRangeNotCArrayNotFString](API\Runtime\Core\Templates\TAnd)< TCharRangeType >::Value > *> bool MatchesWildcard ( TCharRangeType && Wildcard, [ESearchCase::Type](API\Runtime\Core\Misc\ESearchCase__Type) SearchCase ) const


code: bool MatchesWildcard ( const TCHAR * Wildcard, [ESearchCase::Type](API\Runtime\Core\Misc\ESearchCase__Type) SearchCase ) const


code: bool MatchesWildcard ( const [FString](API\Runtime\Core\Containers\FString) & Wildcard, [ESearchCase::Type](API\Runtime\Core\Misc\ESearchCase__Type) SearchCase ) const


code: bool MatchesWildcard ( const TCHAR * Wildcard, int32 WildcardLen, [ESearchCase::Type](API\Runtime\Core\Misc\ESearchCase__Type) SearchCase ) const


description: Returns the substring from Start position to the end

code: [FString](API\Runtime\Core\Containers\FString) Mid ( int32 Start ) const


code: [FString](API\Runtime\Core\Containers\FString) Mid ( int32 Start )


description: Returns the substring from Start position for Count characters.

code: [FString](API\Runtime\Core\Containers\FString) Mid ( int32 Start, int32 Count ) const


code: [FString](API\Runtime\Core\Containers\FString) Mid ( int32 Start, int32 Count )


description: Modifies the string such that it is now the substring from Start position for Count characters.

code: void MidInline ( int32 Start, int32 Count, bool bAllowShrinking )


description: Append a string and return a reference to this

code: template<typename StrType> auto operator+= ( StrType && Str )


description: Append a single character and return a reference to this

code: template<typename AppendedCharType, std::enable_if_t< [TIsCharType](API\Runtime\Core\Traits\TIsCharType)< AppendedCharType >::Value > *> [FString](API\Runtime\Core\Containers\FString) & operator+= ( AppendedCharType Char )


code: [FString](API\Runtime\Core\Containers\FString) & operator= ( [FString](API\Runtime\Core\Containers\FString) && )


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


code: [FString](API\Runtime\Core\Containers\FString) & operator= ( const TCHAR * Str )


code: template<typename CharRangeType, typename [TEnableIf](API\Runtime\Core\Templates\TEnableIf)< [TIsTCharRangeNotCArray](API\Runtime\Core\Templates\TAnd)< CharRangeType >::Value >::Type *> [FString](API\Runtime\Core\Containers\FString) & operator= ( CharRangeType && Range )


description:
case insensitive
true if the left string is lexicographically == the right string, otherwise false

code: template<typename CharType> bool operator== ( const CharType * Rhs ) const


description:
case insensitive
true if the left string is lexicographically != the right string, otherwise false

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


code: template<typename CharType> bool operator!= ( const CharType * Rhs ) const


description: Pointer to Array of TCHAR if Num, otherwise the empty string

code: const TCHAR * operator*() const


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


description:
Concatenate this path with given path ensuring the / character is used between them
reference to path

code: [FString](API\Runtime\Core\Containers\FString) & operator/= ( const TCHAR * Str )


code: template<typename CharRangeType, typename [TEnableIf](API\Runtime\Core\Templates\TEnableIf)< [TIsTCharRangeNotCArray](API\Runtime\Core\Templates\TAnd)< CharRangeType >::Value >::Type *> [FString](API\Runtime\Core\Containers\FString) & operator/= ( CharRangeType && Str )


code: template<typename CharType, typename [TEnableIf](API\Runtime\Core\Templates\TEnableIf)< [TIsCharType](API\Runtime\Core\Traits\TIsCharType)< CharType >::Value >::Type *> [FString](API\Runtime\Core\Containers\FString) & operator/= ( const CharType * Str )


description:
Return specific character from this string
Character atIndex

code: TCHAR & operator[] ( int32 Index )


description:
Return specific const character from this string
const Character atIndex

code: const TCHAR & operator[] ( int32 Index ) const


description:
Breaks up a delimited string into elements of a string array.
The number of elements in InArray

code: int32 ParseIntoArray ( [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & OutArray, const TCHAR * pchDelim, bool InCullEmpty ) const


description:
Caution!! this routine is O(N^2) allocations...use it for parsing very short text or not at all!
The number of elements in InArray

code: int32 ParseIntoArray ( [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & OutArray, const TCHAR *const * DelimArray, int32 NumDelims, bool InCullEmpty ) const


code: int32 ParseIntoArrayLines ( [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & OutArray, bool InCullEmpty ) const


description:
Caution!! this routine is O(N^2) allocations...use it for parsing very short text or not at all!
Caution!! this routine is O(N^2) allocations...use it for parsing very short text or not at all
The number of elements in InArray

code: int32 ParseIntoArrayWS ( [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & OutArray, const TCHAR * pchExtraDelim, bool InCullEmpty ) const


description: Concatenate this path with given path ensuring the / character is used between them

code: void PathAppend ( const TCHAR * Str, int32 StrLength )


description: ConstructsFStringobject similarly to how classic sprintf works.FStringobject that was constructed using format and additional parameters.

code: template<typename FmtType, typename... Types> static [FString](API\Runtime\Core\Containers\FString) Printf ( const FmtType & Fmt, Types... Args )


description: Removes characters within the string.

code: void RemoveAt ( int32 Index, int32 Count, bool bAllowShrinking )


description:
Removes the text from the end of the string if it exists.
true if the suffix was removed, otherwise false.

code: template<typename TCharRangeType, std::enable_if_t< [TIsCharRangeNotCArrayNotFString](API\Runtime\Core\Templates\TAnd)< TCharRangeType >::Value > *> bool RemoveFromEnd ( TCharRangeType && InSuffix, [ESearchCase::Type](API\Runtime\Core\Misc\ESearchCase__Type) SearchCase )


code: bool RemoveFromEnd ( const TCHAR * InSuffix, [ESearchCase::Type](API\Runtime\Core\Misc\ESearchCase__Type) SearchCase )


code: bool RemoveFromEnd ( const [FString](API\Runtime\Core\Containers\FString) & InSuffix, [ESearchCase::Type](API\Runtime\Core\Misc\ESearchCase__Type) SearchCase )


code: bool RemoveFromEnd ( const TCHAR * InSuffix, int32 InSuffixLen, [ESearchCase::Type](API\Runtime\Core\Misc\ESearchCase__Type) SearchCase )


description:
Removes the text from the start of the string if it exists.
true if the prefix was removed, otherwise false.

code: template<typename TCharRangeType, std::enable_if_t< [TIsCharRangeNotCArrayNotFString](API\Runtime\Core\Templates\TAnd)< TCharRangeType >::Value > *> bool RemoveFromStart ( TCharRangeType && InPrefix, [ESearchCase::Type](API\Runtime\Core\Misc\ESearchCase__Type) SearchCase )


code: bool RemoveFromStart ( const TCHAR * InPrefix, [ESearchCase::Type](API\Runtime\Core\Misc\ESearchCase__Type) SearchCase )


code: bool RemoveFromStart ( const [FString](API\Runtime\Core\Containers\FString) & InPrefix, [ESearchCase::Type](API\Runtime\Core\Misc\ESearchCase__Type) SearchCase )


code: bool RemoveFromStart ( const TCHAR * InPrefix, int32 InPrefixLen, [ESearchCase::Type](API\Runtime\Core\Misc\ESearchCase__Type) SearchCase )


description: Removes spaces from the string. I.E. "Spaces Are Cool" > "SpacesAreCool".

code: void RemoveSpacesInline()


description:
Replace all occurrences of a substring in this string
a copy of this string with the replacement made

code: [FString](API\Runtime\Core\Containers\FString) Replace ( const TCHAR * From, const TCHAR * To, [ESearchCase::Type](API\Runtime\Core\Misc\ESearchCase__Type) SearchCase ) const


code: [FString](API\Runtime\Core\Containers\FString) Replace ( const TCHAR * From, const TCHAR * To, [ESearchCase::Type](API\Runtime\Core\Misc\ESearchCase__Type) SearchCase )


description: no dynamic allocation

code: void ReplaceCharInline ( const TCHAR SearchChar, const TCHAR ReplacementChar, [ESearchCase::Type](API\Runtime\Core\Misc\ESearchCase__Type) SearchCase )


description:
Replaces certain characters with the "escaped" version of that character (i.e. replaces "\n" with "\n"). The characters supported are: {
, , , ', ", \ }.
a string with all control characters replaced by the escaped version.

code: [FString](API\Runtime\Core\Containers\FString) ReplaceCharWithEscapedChar ( const [TArray](API\Runtime\Core\Containers\TArray)< TCHAR > * Chars ) const


code: [FString](API\Runtime\Core\Containers\FString) ReplaceCharWithEscapedChar ( const [TArray](API\Runtime\Core\Containers\TArray)< TCHAR > * Chars )


description:
Replaces certain characters with the "escaped" version of that character (i.e. replaces "\n" with "\n"). The characters supported are: {
, , , ', ", \ }.

code: void ReplaceCharWithEscapedCharInline ( const [TArray](API\Runtime\Core\Containers\TArray)< TCHAR > * Chars )


description:
Removes the escape backslash for all supported characters, replacing the escape and character with the non-escaped version. (i.e. replaces "\n" with "\n". Counterpart toReplaceCharWithEscapedChar().
copy of this string with replacement made

code: [FString](API\Runtime\Core\Containers\FString) ReplaceEscapedCharWithChar ( const [TArray](API\Runtime\Core\Containers\TArray)< TCHAR > * Chars ) const


code: [FString](API\Runtime\Core\Containers\FString) ReplaceEscapedCharWithChar ( const [TArray](API\Runtime\Core\Containers\TArray)< TCHAR > * Chars )


description: Removes the escape backslash for all supported characters, replacing the escape and character with the non-escaped version. (i.e. replaces "\n" with "\n". Counterpart toReplaceCharWithEscapedCharInline().

code: void ReplaceEscapedCharWithCharInline ( const [TArray](API\Runtime\Core\Containers\TArray)< TCHAR > * Chars )


description:
Replace all occurrences of SearchText with ReplacementText in this string.
the number of occurrences of SearchText that were replaced.

code: int32 ReplaceInline ( const TCHAR * SearchText, const TCHAR * ReplacementText, [ESearchCase::Type](API\Runtime\Core\Misc\ESearchCase__Type) SearchCase )


description: Returns a copy of this string with all quote marks escaped (unless the quote is already escaped)


description: To allow more efficient memory handling, automatically adds one for the string termination.

code: void Reserve ( int32 CharacterCount )


description: Empties the string, but doesn't change memory allocation, unless the new size is larger than the current string.

code: void Reset ( int32 NewReservedSize )


description: Returns a copy of this string, with the characters in reverse order


description: Returns this string, with the characters in reverse order


description: Reverses the order of characters in this string

code: void ReverseString()


description: Returns the string to the right of the specified location, counting back from the right (end of the word).

code: [FString](API\Runtime\Core\Containers\FString) Right ( int32 Count ) const


code: [FString](API\Runtime\Core\Containers\FString) Right ( int32 Count )


description: Returns the string to the right of the specified location, counting forward from the left (from the beginning of the word).

code: [FString](API\Runtime\Core\Containers\FString) RightChop ( int32 Count ) const


code: [FString](API\Runtime\Core\Containers\FString) RightChop ( int32 Count )


description: Modifies the string such that it is now the string to the right of the specified location, counting forward from the left (from the beginning of the word).

code: void RightChopInline ( int32 Count, bool bAllowShrinking )


description: Modifies the string such that it is now the right most given number of characters

code: void RightInline ( int32 Count, bool bAllowShrinking )


description: Pad the right of this string for ChCount characters

code: [FString](API\Runtime\Core\Containers\FString) RightPad ( int32 ChCount ) const


description:
Converts a float string with the trailing zeros stripped For example - 1.234 will be "1.234" rather than "1.234000"
sanitized string version of float

code: static [FString](API\Runtime\Core\Containers\FString) SanitizeFloat ( double InFloat, const int32 InMinFractionalDigits )


description: Serializes a string as ANSI char array.

code: void SerializeAsANSICharArray ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar, int32 MinCharacters ) const


description: Remove unallocated empty character space from the end of this string

code: void Shrink()


description: Split withESearchCase::IgnoreCaseandESearchDir::FromStart. Allows compiler to avoid branches w/o inlining code.

code: bool Split ( const [FString](API\Runtime\Core\Containers\FString) & InS, [FString](API\Runtime\Core\Containers\FString) * LeftS, [FString](API\Runtime\Core\Containers\FString) * RightS ) const


description:
Splits this string at given string position case sensitive.
true if string is split, otherwise false

code: bool Split ( const [FString](API\Runtime\Core\Containers\FString) & InS, [FString](API\Runtime\Core\Containers\FString) * LeftS, [FString](API\Runtime\Core\Containers\FString) * RightS, [ESearchCase::Type](API\Runtime\Core\Misc\ESearchCase__Type) SearchCase, [ESearchDir::Type](API\Runtime\Core\Misc\ESearchDir__Type) SearchDir ) const


description:
Test whether this string starts with given prefix.
true if this string begins with specified text, false otherwise

code: template<typename TCharRangeType, std::enable_if_t< [TIsCharRangeNotCArrayNotFString](API\Runtime\Core\Templates\TAnd)< TCharRangeType >::Value > *> bool StartsWith ( TCharRangeType && InPrefix, [ESearchCase::Type](API\Runtime\Core\Misc\ESearchCase__Type) SearchCase ) const


code: bool StartsWith ( const TCHAR * InPrefix, [ESearchCase::Type](API\Runtime\Core\Misc\ESearchCase__Type) SearchCase ) const


code: bool StartsWith ( const [FString](API\Runtime\Core\Containers\FString) & InPrefix, [ESearchCase::Type](API\Runtime\Core\Misc\ESearchCase__Type) SearchCase ) const


code: bool StartsWith ( const TCHAR * InPrefix, int32 InPrefixLen, [ESearchCase::Type](API\Runtime\Core\Misc\ESearchCase__Type) SearchCase ) const


className: TIsCharRangeNotCArray

description: Trait testing whether a type is a contiguous range of characters, and not CharType[].

code: typedef [TAnd](API\Runtime\Core\Templates\TAnd)< [TIsContiguousContainer](API\Runtime\Core\Misc\TIsContiguousContainer)< CharRangeType >, [TNot](API\Runtime\Core\Templates\TNot)< [TIsArray](API\Runtime\Core\Templates\TIsArray)< typename [TRemoveReference](API\Runtime\Core\Templates\TRemoveReference)< CharRangeType >::Type >>, TIsRangeOfCharType< CharRangeType >> TIsCharRangeNotCArray


className: TIsCharRangeNotCArrayNotFString

description: Trait testing whether a type is a contiguous range of characters, and not CharType[] and notFString.

code: typedef [TAnd](API\Runtime\Core\Templates\TAnd)< [TIsCharRangeNotCArray](API\Runtime\Core\Templates\TAnd)< CharRangeType >, [TNot](API\Runtime\Core\Templates\TNot)< [TIsDerivedFrom](API\Runtime\Core\Templates\TIsDerivedFrom)< typename [TDecay](API\Runtime\Core\ProfilingDebugging\TDecay)< CharRangeType >::Type, [FString](API\Runtime\Core\Containers\FString) >>> TIsCharRangeNotCArrayNotFString


className: TIsTCharRangeNotCArray

description: Trait testing whether a type is a contiguous range of TCHAR, and not TCHAR[].

code: typedef [TAnd](API\Runtime\Core\Templates\TAnd)< [TIsContiguousContainer](API\Runtime\Core\Misc\TIsContiguousContainer)< CharRangeType >, [TNot](API\Runtime\Core\Templates\TNot)< [TIsArray](API\Runtime\Core\Templates\TIsArray)< typename [TRemoveReference](API\Runtime\Core\Templates\TRemoveReference)< CharRangeType >::Type >>, TIsRangeOfTCHAR< CharRangeType >> TIsTCharRangeNotCArray


className: TIsTCharRangeNotCArrayNotFString

description: Trait testing whether a type is a contiguous range of TCHAR, and not TCHAR[] and notFString.

code: typedef [TAnd](API\Runtime\Core\Templates\TAnd)< [TIsTCharRangeNotCArray](API\Runtime\Core\Templates\TAnd)< CharRangeType >, [TNot](API\Runtime\Core\Templates\TNot)< [TIsDerivedFrom](API\Runtime\Core\Templates\TIsDerivedFrom)< typename [TDecay](API\Runtime\Core\ProfilingDebugging\TDecay)< CharRangeType >::Type, [FString](API\Runtime\Core\Containers\FString) >>> TIsTCharRangeNotCArrayNotFString


className: TIterator

description: Iterator typedefs


description:
Converts a string into a buffer
true if the conversion happened, false otherwise

code: static bool ToBlob ( const [FString](API\Runtime\Core\Containers\FString) & Source, uint8 * DestBuffer, const uint32 DestSize )


description:
Converts a string into a boolean value 1, "True", "Yes",FCoreTexts::True,FCoreTexts::Yes, and non-zero integers become true 0, "False", "No",FCoreTexts::False,FCoreTexts::No, and unparsable values become false
The boolean value

code: bool ToBool() const


description: Returns a new string with the characters of this converted to lowercase


code: static bool ToHexBlob ( const [FString](API\Runtime\Core\Containers\FString) & Source, uint8 * DestBuffer, const uint32 DestSize )


description:
Converts all characters in this rvalue string to lowercase and moves it into the returned string.
a new string with the characters of this converted to lowercase


description: Converts all characters in this string to lowercase

code: void ToLowerInline()


description: Returns a new string with the characters of this converted to uppercase


description:
Converts all characters in this rvalue string to uppercase and moves it into the returned string.
a new string with the characters of this converted to uppercase


description: Converts all characters in this string to uppercase

code: void ToUpperInline()


className: TRangeElementType

code: typedef std::remove_cv_t< typename [TRemovePointer](API\Runtime\Core\Templates\TRemovePointer)< decltype(GetData(DeclVal< RangeType >()))>::Type > TRangeElementType


description: TrimCharInlinefor an inline variant

code: [FString](API\Runtime\Core\Containers\FString) TrimChar ( const TCHAR CharacterToTrim, bool * bCharRemoved ) const


description: Returns a copy of this string with wrapping CharacterToTrim removed (removes at max one instance in the beginning and end of the string).

code: [FString](API\Runtime\Core\Containers\FString) TrimChar ( const TCHAR CharacterToTrim, bool * bCharRemoved )


description: TrimCharfor a variant that returns a modified copy of the string

code: void TrimCharInline ( const TCHAR CharacterToTrim, bool * bCharRemoved )


description: Unlike TrimTrailing() this function returns a copy, and does not mutate the string.


description: Removes whitespace characters from the end of this string. Modifies the string in-place.

code: void TrimEndInline()


description: Returns a copy of this string with wrapping quotation marks removed.

code: [FString](API\Runtime\Core\Containers\FString) TrimQuotes ( bool * bQuotesRemoved ) const


description: Returns this string with wrapping quotation marks removed.

code: [FString](API\Runtime\Core\Containers\FString) TrimQuotes ( bool * bQuotesRemoved )


description: Trims wrapping quotation marks from this string.

code: void TrimQuotesInline ( bool * bQuotesRemoved )


description: UnlikeTrim()this function returns a copy, and does not mutate the string.


description: Removes whitespace characters from the start and end of this string. Modifies the string in-place.

code: void TrimStartAndEndInline()


description: Removes whitespace characters from the start of this string. Modifies the string in-place.

code: void TrimStartInline()


description: Trims the inner array after the null terminator.

code: void TrimToNullTerminator()


description: Create a copy of the Other string with extra space for characters at the end of the string

code: FString ( [FString](API\Runtime\Core\Containers\FString) && Other, int32 ExtraSlack )


description: Construct from null-terminated C substring or nullptr

code: FString ( int32 Len, const ANSICHAR * Str )


code: FString ( int32 Len, const WIDECHAR * Str )


code: FString ( int32 Len, const [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * Str )


code: FString ( int32 Len, const UCS2CHAR * Str )