description:
Gets a packet from the buffered packet queue for sending (as a raw packet)
The packet to be sent, or nullptr if none are to be sent


description: Whether or not raw packet sends are enabled

module: PacketHandler

code: bool GetRawSend()


description:
Gets the combined reserved packet/protocol bits from all handlers, for reserving space in the parent connections packets
The combined reserved packet/protocol bits

code: int32 GetTotalReservedPacketBits()


description: Triggered when a childHandlerComponenthas been initialized

code: void HandlerComponentInitialized ( [HandlerComponent](API\Runtime\PacketHandler\HandlerComponent) * InComponent )


description:
Use this for more complex changes to packets, such as compression/encryption, but be aware that compatibility problems with otherHandlerComponent's are more likely.
Returns Success/Failure

code: EIncomingResult Incoming ( [FReceivedPacketView](API\Runtime\NetCommon\Net\Common\Packets\FReceivedPacketView) & PacketView )


description: Deprecated* Incoming now usesFReceivedPacketView.

code: const [ProcessedPacket](API\Runtime\PacketHandler\ProcessedPacket) Incoming ( uint8 * Packet, int32 CountBytes )


description:
Processes incoming packets without aUNetConnection, in the same manner as 'Incoming' above IMPORTANT: Net drivers triggering this, should call 'UNetDriver::FlushHandler' shortly afterwards, to minimize packet buffering NOTE: Connectionless packets are unreliable.
Returns Success/Failure

code: EIncomingResult IncomingConnectionless ( [FReceivedPacketView](API\Runtime\NetCommon\Net\Common\Packets\FReceivedPacketView) & PacketView )


description: Deprecated* IncomingConnectionless now usesFReceivedPacketView.

code: const [ProcessedPacket](API\Runtime\PacketHandler\ProcessedPacket) IncomingConnectionless ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< const [FInternetAddr](API\Runtime\Sockets\FInternetAddr) > & Address, uint8 * Packet, int32 CountBytes )


description: Returns a pointer to the component set as the encryption handler, if any.


description: Use this for simple data additions to packets, and for maximum compatibility with otherHandlerComponent's.

code: void IncomingHigh ( [FBitReader](API\Runtime\Core\Serialization\FBitReader) & Reader )


description:
Internal handling for Incoming/IncomingConnectionless
Returns Success/Failure

code: EIncomingResult Incoming_Internal ( [FReceivedPacketView](API\Runtime\NetCommon\Net\Common\Packets\FReceivedPacketView) & PacketView )


description: Deprecated* Incoming_Internal now usesFReceivedPacketView

code: const [ProcessedPacket](API\Runtime\PacketHandler\ProcessedPacket) Incoming_Internal ( uint8 * Packet, int32 CountBytes, bool bConnectionless, const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< const [FInternetAddr](API\Runtime\Sockets\FInternetAddr) > & Address )


description: Initializes a reference to the NetConnection fault recovery interface (does not require Engine dependency)

code: void InitFaultRecovery ( [UE::Net::FNetConnectionFaultRecoveryBase](API\Runtime\NetCore\Net\Core\Connection\FNetConnectionFaultRecoveryBase) * InFaultRecovery )


description: Notification that the NetDriver analytics provider has been updated (NOT called on first initialization) NOTE: Can also mean disabled, e.g. during hotfix

code: void NotifyAnalyticsProvider ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IAnalyticsProvider](API\Runtime\Analytics\Interfaces\IAnalyticsProvider) > InProvider, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FNetAnalyticsAggregator](API\Runtime\NetCore\Net\Core\Analytics\FNetAnalyticsAggregator) > InAggregator )


description: Handles initialization of manager

code: void Initialize ( [UE::Handler::Mode](API\Runtime\PacketHandler\UE__Handler__Mode) Mode, uint32 InMaxPacketBits, bool bConnectionlessOnly, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< class [IAnalyticsProvider](API\Runtime\Analytics\Interfaces\IAnalyticsProvider) > InProvider, [FDDoSDetection](API\Runtime\NetCore\Net\Core\Misc\FDDoSDetection) * InDDoS, [FName](API\Runtime\Core\UObject\FName) InDriverProfile )


description: Triggers initialization of HandlerComponents.

code: void InitializeComponents()


description: Used for external initialization of delegates

code: void InitializeDelegates ( FPacketHandlerLowLevelSendTraits InLowLevelSendDel, FPacketHandlerNotifyAddHandler InAddHandlerDel )


description: Whether or not the packet handler is fully initialized, post-handshake etc.

code: bool IsFullyInitialized()


description:
Use this for more complex changes to packets, such as compression/encryption, but be aware that compatibility problems with otherHandlerComponent's are more likely.
Returns the final packet

code: const [ProcessedPacket](API\Runtime\PacketHandler\ProcessedPacket) Outgoing ( uint8 * Packet, int32 CountBits, [FOutPacketTraits](API\Runtime\NetCommon\Net\Common\Packets\FOutPacketTraits) & Traits )


description:
Processes outgoing packets without aUNetConnection, in the same manner as 'Outgoing' above NOTE: Connectionless packets are unreliable.
Returns the final packet

code: const [ProcessedPacket](API\Runtime\PacketHandler\ProcessedPacket) OutgoingConnectionless ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< const [FInternetAddr](API\Runtime\Sockets\FInternetAddr) > & Address, uint8 * Packet, int32 CountBits, [FOutPacketTraits](API\Runtime\NetCommon\Net\Common\Packets\FOutPacketTraits) & Traits )


code: void OutgoingHigh ( [FBitWriter](API\Runtime\Core\Serialization\FBitWriter) & Writer )


description:
Internal handling for Outgoing/OutgoingConnectionless
Returns the final packet

code: const [ProcessedPacket](API\Runtime\PacketHandler\ProcessedPacket) Outgoing_Internal ( uint8 * Packet, int32 CountBits, [FOutPacketTraits](API\Runtime\NetCommon\Net\Common\Packets\FOutPacketTraits) & Traits, bool bConnectionless, const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< const [FInternetAddr](API\Runtime\Sockets\FInternetAddr) > & Address )


description: Queue's a packet to be sent through 'SendHandlerPacket'

code: void QueueHandlerPacketForSending ( [BufferedPacket](API\Runtime\PacketHandler\BufferedPacket) * PacketToQueue )


description: Queue's a packet to be sent when the handler is ticked (as a raw packet, since it's already been processed)

code: void QueuePacketForRawSending ( [BufferedPacket](API\Runtime\PacketHandler\BufferedPacket) * PacketToQueue )


description: Send a packet originating from aHandlerComponent- will process through the HandlerComponents chain, starting after the triggering component. NOTE: Requires that InitializeDelegates is called, with a valid LowLevelSend delegate.

code: void SendHandlerPacket ( [HandlerComponent](API\Runtime\PacketHandler\HandlerComponent) * InComponent, [FBitWriter](API\Runtime\Core\Serialization\FBitWriter) & Writer, [FOutPacketTraits](API\Runtime\NetCommon\Net\Common\Packets\FOutPacketTraits) & Traits )


description: Sets whether or not outgoing packets should bypass this handler - used when raw packet sends are necessary (such as for the stateless handshake)

code: void SetRawSend ( bool bInEnabled )


code: void Tick ( float DeltaTime )


description: PacketHandler

code: PacketHandler ( [FDDoSDetection](API\Runtime\NetCore\Net\Core\Misc\FDDoSDetection) * InDDoS )


className: PacketHandler

description: This class maintains an array of allPacketHandlerComponents and forwards incoming and outgoing packets the each component

code: class PacketHandler

Mode

description: Mode of the handler, Client or Server


description: Base constructor

code: ProcessedPacket ( uint8 * InData, int32 InCountBits, bool bInError )


description: HandlerComponentState

code: namespace UE { namespace Handler { namespace Component { enum State { UnInitialized, InitializedOnLocal, InitializeOnRemote, Initialized, } } } }


className: ProcessedPacket

description: The result of calling Incoming and Outgoing in thePacketHandler

code: struct ProcessedPacket

bError

type: bool

description: Whether or not there was an error processing the packet

CountBits

description: Size of the returned packet data in bits

Data

type: uint8 *

description: Pointer to the returned packet data


description: Mode of Packet Handler

code: namespace UE { namespace Handler { enum Mode { Client, Server, } } }


description: State ofPacketHandler

code: namespace UE { namespace Handler { enum State { Uninitialized, InitializingComponents, Initialized, } } }


className: UHandlerComponentFactory

description: AUObjectalternative for loading HandlerComponents without strict module dependency

code: class UHandlerComponentFactory : public [UObject](API\Runtime\CoreUObject\UObject\UObject)


code: UPacketHandlerProfileConfig ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


className: UPacketHandlerProfileConfig

description: PacketHandlerConfiguration Profiles based on each NetDriver

code: class UPacketHandlerProfileConfig : public [UObject](API\Runtime\CoreUObject\UObject\UObject)

Components

type: TArray<FString...


code: virtual [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [HandlerComponent](API\Runtime\PacketHandler\HandlerComponent) > CreateComponentInstance ( [FString](API\Runtime\Core\Containers\FString) & Options )


module: PakFile

code: FPakChunkSignatureCheckFailedData()


description: UHandlerComponentFactory

code: UHandlerComponentFactory ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


code: FPakChunkSignatureCheckFailedData ( const [FString](API\Runtime\Core\Containers\FString) & InPakFilename, const TPakChunkHash & InExpectedHash, const TPakChunkHash & InReceivedHash, int32 InChunkIndex )


className: FPakChunkSignatureCheckFailedData

ExpectedHash

type: TPakChunkHash

PakFilename

type: FString


code: bool operator== ( const [FPakCompressedBlock](API\Runtime\PakFile\FPakCompressedBlock) & B ) const


className: FPakCompressedBlock

description: Struct storing offsets and sizes of a compressed block.

code: struct FPakCompressedBlock

CompressedEnd

description: Offset of the end of a compression block.

CompressedStart

description: Offset of the start of a compression block.


code: bool operator!= ( const [FPakCompressedBlock](API\Runtime\PakFile\FPakCompressedBlock) & B ) const


code: static const uint8 Flag_Deleted = 0x02;


code: static const uint8 Flag_None = 0x00;


description:
Gets the size of data serialized by this struct.
Serialized data size.

code: int64 GetSerializedSize ( int32 Version ) const


code: bool GetFlag ( uint8 InFlag ) const


code: static const uint8 Flag_Encrypted = 0x01;


code: bool IndexDataEquals ( const [FPakEntry](API\Runtime\PakFile\FPakEntry) & B ) const


description: Compares twoFPakEntrystructs.

code: bool operator== ( const [FPakEntry](API\Runtime\PakFile\FPakEntry) & B ) const


code: void SetDeleteRecord ( bool bDeleteRecord )


description: SerializesFPakEntrystruct.

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


code: void SetFlag ( uint8 InFlag, bool bValue )


code: void SetEncrypted ( bool bEncrypted )


description: Constructor.

code: FPakEntry()


className: FPakEntry

description: On Fortnite that would be 15GB of data (250k pak entries * 64kb patch block) just to add/change/remove a field.

code: struct FPakEntry

CompressionBlocks

type: TArray<FPakCom...

description: Array of compression blocks that describe how to decompress this pak entry.

CompressionBlockSize

description: Size of a compressed block in the file.

CompressionMethodIndex

description: Indexinto the compression methods in this pakfile.

Flags

description: Pak entry flags.

Hash

description: File SHA1 value.

Offset

description: Offset into pak file where the file is stored.

Size

description: Serialized file size.

UncompressedSize

description: Uncompressed file size.

Verified

description: Flag is set to true when FileHeader has been checked against PakHeader. It is not serialized.


description: Compares twoFPakEntrystructs.

code: bool operator!= ( const [FPakEntry](API\Runtime\PakFile\FPakEntry) & B ) const


description: Verifies two entries match to check for corruption.

code: static bool VerifyPakEntriesMatch ( const [FPakEntry](API\Runtime\PakFile\FPakEntry) & FileEntryA, const [FPakEntry](API\Runtime\PakFile\FPakEntry) & FileEntryB )


code: static [FPakEntryLocation](API\Runtime\PakFile\FPakEntryLocation) CreateFromListIndex ( int32 ListIndex )


code: static [FPakEntryLocation](API\Runtime\PakFile\FPakEntryLocation) CreateFromOffsetIntoEncoded ( int32 Offset )


code: int32 GetAsOffsetIntoEncoded() const


className: Invalid

description: 0x00000000 - 0x7ffffffe: EncodedOffset from 0 to MaxIndex 0x7fffffff: Unused, interpreted as Invalid 0x80000000: Invalid 0x80000001 - 0xffffffff: FileIndex from MaxIndex to 0

code: static const int32 Invalid = ((int32) 0x80000000);


className: MaxIndex

code: static const int32 MaxIndex = ((int32) 0x7fffffff) - 1;


code: bool operator== ( const [FPakEntryLocation](API\Runtime\PakFile\FPakEntryLocation) & Other ) const


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


code: FPakEntryLocation ( const [FPakEntryLocation](API\Runtime\PakFile\FPakEntryLocation) & Other )


code: FPakEntryLocation &40; int32 InIndex &41;


className: FPakEntryLocation

description: An identifier for the location of anFPakEntryin an FDirectoryIndex or an FPathHashIndex. Contains a byte offset into the encoded array ofFPakEntrydata, an index into the list of unencodable FPakEntries, or a marker indicating invalidity

code: struct FPakEntryLocation


code: [FPakEntryLocation](API\Runtime\PakFile\FPakEntryLocation) & operator= ( const [FPakEntryLocation](API\Runtime\PakFile\FPakEntryLocation) & other )


className: bSomePakNeedsPruning

description: Global flag for whether a Pak has indicated it needs Pruning

code: static bool bSomePakNeedsPruning = false;


className: FPakEntryPair

description: Convenience struct for buildingFPakFileindexes from an enumeration of (Filename,FPakEntry) pairs

code: struct FPakEntryPair

Info

type: FPakEntry


description:
Checks the validity of the pak data by reading out the data for every file in the pak
true if the pak file is valid

code: bool Check()


description:
Checks if a directory exists in pak file.
true if the given path exists in pak file, false otherwise.

code: bool DirectoryExistsInPruned ( const TCHAR * InPath ) const


className: EFindResult

description: Finds an entry in the pak file matching the given filename.

code: enum EFindResult { NotFound, Found, FoundDeleted, }


className: ECacheType

description: Pak files can share a cache or have their own

code: enum ECacheType { Shared, Individual, }


code: static void EncodePakEntriesIntoIndex ( int32 InNumEntries, const [ReadNextEntryFunction](API\Runtime\PakFile\FPakFile\ReadNextEntryFunction) & InReadNextEntry, const TCHAR * InPakFilename, const [FPakInfo](API\Runtime\PakFile\FPakInfo) & InPakInfo, const [FString](API\Runtime\Core\Containers\FString) & MountPoint, int32 & OutNumEncodedEntries, int32 & OutNumDeletedEntries, uint64 * OutPathHashSeed, [FDirectoryIndex](API\Runtime\PakFile\FPakFile\FDirectoryIndex) * OutDirectoryIndex, [FPathHashIndex](API\Runtime\PakFile\FPakFile\FPathHashIndex) * OutPathHashIndex, [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & OutEncodedPakEntries, [TArray](API\Runtime\Core\Containers\TArray)< [FPakEntry](API\Runtime\PakFile\FPakEntry) > & OutNonEncodableEntries, [TMap](API\Runtime\Core\Containers\TMap)< uint64, [FString](API\Runtime\Core\Containers\FString) > * InOutCollisionDetection, int32 PakFileVersion )


className: FArchiveAndLastAccessTime

code: struct FArchiveAndLastAccessTime

Archive

type: TUniquePtr<FAr...

LastAccessTime

type: double


description: Return the current filename, as the RelativePath from the MountPoint. Only available when using the FDirectoryIndex, otherwise always returns empty string. Invalid to call unless the iterator is currently valid.

code: const FString & Filename&40;&41; const


description: Return the arbitrary index of the iteration. Invalid to call unless the iterator is currently valid.

code: const FPakEntryLocation GetPakEntryIndex&40;&41; const


className: FPakFile::FBaseIterator::operator bool

description: Conversion to "bool" returning true if the iterator is valid.

code: operator bool&40;&41; const


description: Return theFPakEntry. Invalid to call unless the iterator is currently valid.

code: const FPakEntry & Info&40;&41; const


description: Inverse of the "bool" operator

code: bool operator&33;&40;&41; const


code: FBaseIterator &40; const FPakFile & InPakFile, bool bInIncludeDeleted, bool bInUsePathHash &41;


className: FBaseIterator

description: Base functionality for iterating over the DirectoryIndex.

code: class FBaseIterator


className: FDirectoryIndex

description: Indexdata that keeps an in-memory directoryname/filename tree to map a Filename to anFPakEntryLocation

code: typedef [TMap](API\Runtime\Core\Containers\TMap)< [FString](API\Runtime\Core\Containers\FString), FPakDirectory > FDirectoryIndex


description: Deprecated*FFileIteratoris deprecated, useFFilenameIteratorinstead. Note thatFFilenameIteratorwill only iterate over the DirectoryIndexKeepFiles entries.

code: FFileIterator &40; const FPakFile & InPakFile, bool bInIncludeDeleted &41;


className: FFileIterator

code: class FFileIterator : public [FPakFile::FFilenameIterator](API\Runtime\PakFile\FPakFile\FFilenameIterator)


description: Constructor.

code: FFilenameIterator &40; const FPakFile & InPakFile, bool bInIncludeDeleted &41;


className: FFilenameIterator

description: Iterator class used to iterate over just the files in the pak for which we have filenames.

code: class FFilenameIterator : public [FPakFile::FBaseIterator](API\Runtime\PakFile\FPakFile\FBaseIterator)


className: FIndexSettings

code: struct FIndexSettings


code: [EFindResult](API\Runtime\PakFile\FPakFile\EFindResult) Find ( const [FString](API\Runtime\Core\Containers\FString) & FullPath, [FPakEntry](API\Runtime\PakFile\FPakEntry) * OutEntry ) const


description: Lookup theFPakEntryLocationstored in the given DirectoryIndex, return nullptr if not found

code: static const [FPakEntryLocation](API\Runtime\PakFile\FPakEntryLocation) * FindLocationFromIndex ( const [FString](API\Runtime\Core\Containers\FString) & FullPath, const [FString](API\Runtime\Core\Containers\FString) & MountPoint, const [FDirectoryIndex](API\Runtime\PakFile\FPakFile\FDirectoryIndex) & DirectoryIndex )


description:
Finds a directory in pak file.
Pointer to a map with directory contents if the directory was found, NULL otherwise.

code: const FPakDirectory * FindPrunedDirectory ( const TCHAR * InPath ) const


description: Looks for files or directories within the Pruned DirectoryIndex of the pak file. The Pruned DirectoryIndex does not have entries for most Files in the pak; they were removed to save memory. A project can specify which FileNames and DirectoryNames can be marked to keep in the DirectoryIndex; seeFPakFile::FIndexSettingsandFPakFile::PruneDirectoryIndexReturned paths are full paths (include the mount point)

code: template<class ContainerType> void FindPrunedFilesAtPath ( ContainerType & OutFiles, const TCHAR * InPath, bool bIncludeFiles, bool bIncludeDirectories, bool bRecursive ) const


code: const FString &42; TryGetFilename&40;&41; const


code: FPakEntryIterator &40; const FPakFile & InPakFile, bool bInIncludeDeleted &41;


description: Lookup theFPakEntryLocationstored in the given PathHashIndex, return nullptr if not found

code: static const [FPakEntryLocation](API\Runtime\PakFile\FPakEntryLocation) * FindLocationFromIndex ( const [FString](API\Runtime\Core\Containers\FString) & FullPath, const [FString](API\Runtime\Core\Containers\FString) & MountPoint, const [FPathHashIndex](API\Runtime\PakFile\FPakFile\FPathHashIndex) & PathHashIndex, uint64 PathHashSeed, int32 PakFileVersion )


className: FPakEntryIterator

description: Iterator class for everyFPakEntryin theFPakFile, but does not provide filenames unless the PakFile has an unpruned DirectoryIndex.

code: class FPakEntryIterator : public [FPakFile::FBaseIterator](API\Runtime\PakFile\FPakFile\FBaseIterator)


className: FPathHashIndex

description: Indexdata that provides a map from the hash of a Filename to anFPakEntryLocation

code: typedef [TMap](API\Runtime\Core\Containers\TMap)< uint64, [FPakEntryLocation](API\Runtime\PakFile\FPakEntryLocation) > FPathHashIndex


code: FScopedPakDirectoryIndexAccess &40; const FPakFile & InPakFile &41;


className: FScopedPakDirectoryIndexAccess

description: A ReadLock wrapper that must be used to prevent threading errors around any call to FindPrunedDirectory or internal uses of DirectoryIndex

code: struct FScopedPakDirectoryIndexAccess

PakFile

type: constFPakFile...


description:
Gets pak filename.
Pak filename.

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


description:
Gets this pak file info.
Info about this pak file.

code: const [FPakInfo](API\Runtime\PakFile\FPakInfo) & GetInfo() const


description:
Gets pak file mount point.
Mount point path.

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


description: Gets the number of files in this pak.

code: virtual int32 GetNumFiles() const


description: Returns theFPakEntrypointed to by the givenFPakEntryLocation, forwards to the static GetPakEntry with data from *this

code: EFindResult GetPakEntry &40; const FPakEntryLocation & FPakEntryLocation, FPakEntry &42; OutEntry &41; const


description: Returns the FullPath (includes Mount) Filename found in Pruned DirectoryIndex

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


description: Returns the RelativePathFromMount Filename for every Filename found in the Pruned DirectoryIndex that points to a PakEntry in the given Chunk

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


description: Helper function to return Filename's relative path from the mount point. Returns null if Child is not equal to MountPoint and is not a child path under MountPoint, else returns pointer to the offset within Child after the MountPoint. If child equals MountPoint, returns null; The MountPoint itself is not a valid Filename, since Filenames must have non-zero length and are added on to the MountPoint.

code: static const TCHAR * GetRelativeFilePathFromMountPointer ( const [FString](API\Runtime\Core\Containers\FString) & Child, const [FString](API\Runtime\Core\Containers\FString) & MountPoint )


description: Helper function to return Child's relative path from the mount point. Returns false if Child is not equal to MountPoint and is not a child path under MountPoint, else returns true. Edits Child only if returning true, setting it to the relative path. If child equals MountPoint, returns true and sets Child to the relative path to the MountPoint, which is "/"

code: static bool GetRelativePathFromMountInline ( [FString](API\Runtime\Core\Containers\FString) & Child, const [FString](API\Runtime\Core\Containers\FString) & MountPoint )


description:
Gets shared pak file archive for given thread.
Pointer to pak file archive used to read data from pak.

code: [FSharedPakReader](API\Runtime\PakFile\FSharedPakReader) GetSharedReader ( [IPlatformFile](API\Runtime\Core\GenericPlatform\IPlatformFile) * LowerLevel )


code: bool GetUnderlyingCacheTrimDisabled()


description:
Gets this pak file's tiemstamp.
Timestamp.

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


description: Hash the given full-path filename using the hash function used by FPakFiles, with the given FPakFile-specific seed, with version provided for legacy pak files that used different hash function

code: static uint64 HashPath ( const TCHAR * RelativePathFromMount, uint64 Seed, int32 PakFileVersion )


description:
Returns whether filenames currently exist in the DirectoryIndex for all files in the Pak.
true if filenames are present for allFPakEntry, false otherwise.

code: bool HasFilenames() const


description: Returns the global,const flag for whether UnrealPak should write a copy of the full DirectoryIndex to the PakFile


description: Returns the global,const flag for whether the current process is allowing PakFiles to keep their entire DirectoryIndex (if it exists in the PakFile on disk) rather than pruning it

code: static bool IsPakKeepFullDirectory()


description: Returns the global,const flag for whether UnrealPak should write a copy of the full PathHashIndex and Pruned DirectoryIndex to the PakFile

code: static bool IsPakWritePathHashIndex()


description: Returns theFPakEntrypointed to by the givenFPakEntryLocationinside the given EncodedPakEntries or Files Can return Found or Deleted; if theFPakEntryLocationis invalid this function assumes theFPakEntryexists in this pack but as a deleted file If OutEntry is non-null, populates it with a copy of theFPakEntryfound, or sets it to anFPakEntrywith SetDeleteRecord(true) if not found

code: static [EFindResult](API\Runtime\PakFile\FPakFile\EFindResult) GetPakEntry ( const [FPakEntryLocation](API\Runtime\PakFile\FPakEntryLocation) & FPakEntryLocation, [FPakEntry](API\Runtime\PakFile\FPakEntry) * OutEntry, const [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & EncodedPakEntries, const [TArray](API\Runtime\Core\Containers\TArray)< [FPakEntry](API\Runtime\PakFile\FPakEntry) > & Files, const [FPakInfo](API\Runtime\PakFile\FPakInfo) & Info )


description:
Checks if the pak file is valid.
true if this pak file is valid, false otherwise.

code: bool IsValid() const


description: Helper function to modify the given string to append '/' at the end of path to normalize directory names for hash and string compares

code: static void MakeDirectoryFromPath ( [FString](API\Runtime\Core\Containers\FString) & Path )


description: Helper function to check that the given string is in our directory format (ends with '/')

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


description: Return whether the Pak has an entry for the given FileName. Not necessarily exclusive; other Patch Paks may have their own copy of the same File.

code: virtual bool PakContains ( const [FString](API\Runtime\Core\Containers\FString) & Filename ) const


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


code: virtual int32 PakGetPakchunkIndex() const


description: IPakFileinterface, for users of PakFiles that cannot have a dependency on this header.

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


description: Helper function to join two path strings that are in the PakPath format

code: static [FString](API\Runtime\Core\Containers\FString) PakPathCombine ( const [FString](API\Runtime\Core\Containers\FString) & Parent, const [FString](API\Runtime\Core\Containers\FString) & Child )


description: Calls the given Visitor on every FileName in the Pruned DirectoryIndex. FileNames passed to the Vistory are the RelativePath from the Mount of the PakFile The Pruned DirectoryIndexat Runtime contains only the DirectoryIndexKeepFiles-specified subset of FilesNames and DirectoryNames that exist in the PakFile

code: virtual void PakVisitPrunedFilenames ( [IPlatformFile::FDirectoryVisitor](API\Runtime\Core\GenericPlatform\IPlatformFile\FDirectoryVisitor) & Visitor ) const


description: Recreates the pak reader for each thread

code: bool RecreatePakReaders ( [IPlatformFile](API\Runtime\Core\GenericPlatform\IPlatformFile) * LowerLevel )


description: Given aFPakEntryfrom the index, seek to the payload and read the hash of the payload out of the payload entry Warning: Slow function, do not use in performance critical operations

code: void ReadHashFromPayload ( const [FPakEntry](API\Runtime\PakFile\FPakEntry) & PakEntry, uint8 * OutBuffer )


description:
Checks if the pak has valid chunk signature checking data, and that the data passed the initial signing check
true if this pak file has passed the initial signature checking phase

code: bool PassedSignatureChecks() const


description: InOutDirectoryIndex - The full index from which to potentially remove entries OutDirectoryIndex - If null, InOutDirectoryIndex will have pruned entries removed. If non-null, InOutDirectoryIndex will not be modified, and PrunedDirectoryIndex will have kept values added. MountPoint The mount point for the pak containing the index, used to provide the fullpath for filenames in the DirectoryIndex for comparison against paths in ini

code: static void PruneDirectoryIndex ( [FDirectoryIndex](API\Runtime\PakFile\FPakFile\FDirectoryIndex) & InOutDirectoryIndex, [FDirectoryIndex](API\Runtime\PakFile\FPakFile\FDirectoryIndex) * PrunedDirectoryIndex, const [FString](API\Runtime\Core\Containers\FString) & MountPoint )


className: ReadNextEntryFunction

description: Read a list of (Filename,FPakEntry) pairs from a provided enumeration, attempt to encode each one, store each one in the appropriate given encoded and/or unencoded array, and populate the given Directories to map each filename to the location for theFPakEntry

code: typedef [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< [FPakEntryPair](API\Runtime\PakFile\FPakEntryPair) &()> ReadNextEntryFunction


code: void SetCacheIndex ( int32 InCacheIndex )


description: Return a shared pak reader. Should only be called from theFSharedPakReader's destructor.

code: void ReturnSharedReader ( [FArchive](API\Runtime\Core\Serialization\FArchive) * SharedReader )


description: Delete all readers that haven't been used in MaxAgeSeconds.

code: void ReleaseOldReaders ( double MaxAgeSeconds )


code: void SetIsMounted ( bool bInIsMounted )


code: void SetCacheType ( [ECacheType](API\Runtime\PakFile\FPakFile\ECacheType) InCacheType )


description: Sets the pak file mount point.

code: void SetMountPoint ( const TCHAR * Path )


code: void SetUnderlyingCacheTrimDisabled ( bool InUnderlyingCacheTrimDisabled )


description: Helper function to split a PakDirectoryIndex-Formatted PathName into its PakDirectoryIndex-Formatted parent directory and the CleanFileName

code: static bool SplitPathInline ( [FString](API\Runtime\Core\Containers\FString) & InOutPath, [FString](API\Runtime\Core\Containers\FString) & OutFilename )


description: Creates a pak file using the supplied file handle.

code: FPakFile ( [IPlatformFile](API\Runtime\Core\GenericPlatform\IPlatformFile) * LowerLevel, const TCHAR * Filename, bool bIsSigned, bool bLoadIndex )


description: Creates a pak file using the supplied archive.

code: FPakFile ( [FArchive](API\Runtime\Core\Serialization\FArchive) * Archive )


className: FPakFile

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

code: class FPakFile : private [FNoncopyable](API\Runtime\Core\Templates\FNoncopyable), public [FRefCountBase](API\Runtime\Core\Templates\FRefCountBase), public [IPakFile](API\Runtime\Core\GenericPlatform\IPakFile)


description:
Flushes file handle to disk.
true if operation completed successfully.

code: virtual bool Flush ( const bool bFullFlush )


description:
Read bytes from the file.
true if the operation completed successfully.

code: virtual bool Read ( uint8 * Destination, int64 BytesToRead )


description: Return the current write or read position.

code: virtual int64 Tell()


description:
Change the current write or read position.
true if the operation completed successfully.

code: virtual bool Seek ( int64 NewPosition )


description:
Change the current write or read position, relative to the end of the file.
true if the operation completed successfully.

code: virtual bool SeekFromEnd ( int64 NewPositionRelativeToEnd )


description: Return the total size of the file

code: virtual int64 Size()


description: Deprecated* Use constructor that takes aTRefCountPtrinstead

code: FPakFileHandle ( const [FPakFile](API\Runtime\PakFile\FPakFile) & InPakFile, const [FPakEntry](API\Runtime\PakFile\FPakEntry) & InPakEntry, TAcquirePakReaderFunction & InAcquirePakReaderFunction )


description:
Write bytes to the file.
true if the operation completed successfully.

code: virtual bool Write ( const uint8 * Source, int64 BytesToWrite )


description: Constructs pak file handle to read from pak.

code: FPakFileHandle ( const [TRefCountPtr](API\Runtime\Core\Templates\TRefCountPtr)< const [FPakFile](API\Runtime\PakFile\FPakFile) > & InPakFile, const [FPakEntry](API\Runtime\PakFile\FPakEntry) & InPakEntry, TAcquirePakReaderFunction & InAcquirePakReaderFunction )


description:
Truncate the file to the given size (in bytes).
true if the operation completed successfully.

code: virtual bool Truncate ( int64 NewSize )


code: FPakFileHandle ( const [FPakFile](API\Runtime\PakFile\FPakFile) & InPakFile, const [FPakEntry](API\Runtime\PakFile\FPakEntry) & InPakEntry, [FArchive](API\Runtime\Core\Serialization\FArchive) * InPakReader )


description: Destructor. Cleans up the reader archive if necessary.

code: virtual ~FPakFileHandle()


code: FPakFileHandle ( const [TRefCountPtr](API\Runtime\Core\Templates\TRefCountPtr)< const [FPakFile](API\Runtime\PakFile\FPakFile) > & InPakFile, const [FPakEntry](API\Runtime\PakFile\FPakEntry) & InPakEntry, [FArchive](API\Runtime\Core\Serialization\FArchive) * InPakReader )


className: CompressionMethodNameLen

description: Length of a compression format name

code: enum { CompressionMethodNameLen = 32 }


className: FPakFileHandle

description: File handle to read from pak file.

code: template<typename ReaderPolicy> class FPakFileHandle : public [IFileHandle](API\Runtime\Core\GenericPlatform\IFileHandle)


description:
Gets the size of data serialized by this struct.
Serialized data size.

code: int64 GetSerializedSize ( int32 InVersion ) const


code: [FName](API\Runtime\Core\UObject\FName) GetCompressionMethod ( uint32 Index ) const


className: MaxChunkDataSize

description: Size of cached data.

code: enum { MaxChunkDataSize = 64*1024 }


className: MaxNumCompressionMethods

description: Number of allowed different methods

code: enum { MaxNumCompressionMethods =5 }


description: Magic number to use in header

code: enum { PakFile_Magic = 0x5A6F12E1 }


description: Version numbers.

code: enum { PakFile_Version_DeleteRecords = 6 }


code: int32 GetCompressionMethodIndex ( [FName](API\Runtime\Core\UObject\FName) CompressionMethod )


description: Version numbers.

code: enum { PakFile_Version_EncryptionKeyGuid = 7 }


description: Version numbers.

code: enum { PakFile_Version_CompressionEncryption = 3 }


description: Version numbers.

code: enum { PakFile_Version_Fnv64BugFix = 11 }


description: Version numbers.

code: enum { PakFile_Version_FNameBasedCompressionMethod = 8 }


description: Version numbers.

code: enum { PakFile_Version_FrozenIndex = 9 }


description: Version numbers.

code: enum { PakFile_Version_IndexEncryption = 4 }


description: Version numbers.

code: enum { PakFile_Version_Initial = 1 }


description: Version numbers.

code: enum { PakFile_Version_Last }


description: Version numbers.

code: enum { PakFile_Version_Invalid }


description: Version numbers.

code: enum { PakFile_Version_Latest = PakFile_Version_Last - 1 }


description: Version numbers.

code: enum { PakFile_Version_PathHashIndex = 10 }


description: Version numbers.

code: enum { PakFile_Version_NoTimestamps = 2 }


description: Serializes this struct.

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


description: Version numbers.

code: enum { PakFile_Version_RelativeChunkOffsets = 5 }


code: [TOptional](API\Runtime\Core\IO\TOptional)< [FName](API\Runtime\Core\UObject\FName) > TryGetCompressionMethod ( uint32 Index ) const


description: Constructor.

code: FPakInfo()


className: FPakInfo

description: Struct which holds pak file info (version, index offset, hash value).

code: struct FPakInfo

bEncryptedIndex

description: Flag indicating if the pak index has been encrypted.

CompressionMethods

type: TArray<FName>

description: Compression methods used in this pak file (FNames, saved as FStrings)

EncryptionKeyGuid

type: FGuid

description: Encryption key guid. Empty if we should use the embedded key.

IndexHash

type: FSHAHash

description: SHA1 of the bytes in the index, used to check for data corruption when loading the index.

IndexOffset

description: Offset to pak file index.

IndexSize

description: Size (in bytes) of pak file index.

Magic

description: Pak file magic value.

Version

description: Pak file version.


code: static int64 AlignReadRequest ( int64 Size )


className: FPakNoEncryption

description: Placeholder Class

code: class FPakNoEncryption


code: static void DecryptBlock ( void * Data, int64 Size, const [FGuid](API\Runtime\Core\Misc\FGuid) & EncryptionKeyGuid )


description: Returns true if any of the mounted or pending pak files are chunks (filenames starting pakchunkN)

code: bool AnyChunksAvailable() const


description: Broadcast a signature check failure through any registered delegates in a thread safe way.

code: static void BroadcastPakChunkSignatureCheckFailure ( const [FPakChunkSignatureCheckFailedData](API\Runtime\PakFile\FPakChunkSignatureCheckFailedDat-) & InData )


description: Broadcast a principal signature table failure through any registered delegates in a thread safe way.

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


description:
Converts passed in filename to use an absolute path (for reading).
filename using absolute path

code: virtual [FString](API\Runtime\Core\Containers\FString) ConvertToAbsolutePathForExternalAppForRead ( const TCHAR * Filename )


description: Checks if pak files exist in any of the known pak file locations.

code: static bool CheckIfPakFilesExist ( [IPlatformFile](API\Runtime\Core\GenericPlatform\IPlatformFile) * LowLevelFile, const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & PakFolders )


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


description:
Converts passed in filename to use an absolute path (for writing)
filename using absolute path

code: virtual [FString](API\Runtime\Core\Containers\FString) ConvertToAbsolutePathForExternalAppForWrite ( const TCHAR * Filename )


description: Converts a filename to a path inside pak file.

code: [FString](API\Runtime\Core\Containers\FString) ConvertToPakRelativePath ( const TCHAR * Filename, const [FPakFile](API\Runtime\PakFile\FPakFile) * Pak )


description:
Copy a file. This will fail if the destination file already exists.
true if the file was copied sucessfully.

code: virtual bool CopyFile ( const TCHAR * To, const TCHAR * From, EPlatformFileRead ReadFlags, EPlatformFileWrite WriteFlags )


description: Create a directory and return true if the directory was created or already existed.

code: virtual bool CreateDirectory ( const TCHAR * Directory )


description: Create a directory, including any parent directories and return true if the directory was created or already existed.

code: virtual bool CreateDirectoryTree ( const TCHAR * Directory )


description:
Delete all files and subdirectories in a directory, then delete the directory itself
true if the directory was deleted or did not exist.

code: virtual bool DeleteDirectoryRecursively ( const TCHAR * Directory )


description: Delete a directory and return true if the directory was deleted or otherwise does not exist.

code: virtual bool DeleteDirectory ( const TCHAR * Directory )


description: Delete a file and return true if the file exists. Will not delete read only files.

code: virtual bool DeleteFile ( const TCHAR * Filename )


description: Return true if the directory exists.

code: virtual bool DirectoryExists ( const TCHAR * Directory )


description: Return true if the file exists.

code: virtual bool FileExists ( const TCHAR * Filename )


description: Return the size of the file, or -1 if it doesn't exist.

code: virtual int64 FileSize ( const TCHAR * Filename )


description: Deprecated* Use version with OutPakFile is aTRefCountPtrinstead

code: bool FindFileInPakFiles ( const TCHAR * Filename, [FPakFile](API\Runtime\PakFile\FPakFile) ** OutPakFile, [FPakEntry](API\Runtime\PakFile\FPakEntry) * OutEntry )


description: Overload needed for deprecation; remove this when removing the version with a FPakFile** OutPakFile

code: bool FindFileInPakFiles ( const TCHAR * Filename, nullptr_t OutPakFile, [FPakEntry](API\Runtime\PakFile\FPakEntry) * OutEntry )


description:
Finds a file in all available pak files.
Pointer to pak entry if the file was found, NULL otherwise.

code: bool FindFileInPakFiles ( const TCHAR * Filename, [TRefCountPtr](API\Runtime\Core\Templates\TRefCountPtr)< [FPakFile](API\Runtime\PakFile\FPakFile) > * OutPakFile, [FPakEntry](API\Runtime\PakFile\FPakEntry) * OutEntry )


code: static bool FindFileInPakFiles ( [TArray](API\Runtime\Core\Containers\TArray)< FPakListEntry > & Paks, const TCHAR * Filename, nullptr_t OutPakFile, [FPakEntry](API\Runtime\PakFile\FPakEntry) * OutEntry )


code: static bool FindFileInPakFiles ( [TArray](API\Runtime\Core\Containers\TArray)< FPakListEntry > & Paks, const TCHAR * Filename, [FPakFile](API\Runtime\PakFile\FPakFile) ** OutPakFile, [FPakEntry](API\Runtime\PakFile\FPakEntry) * OutEntry )


description:
Finds a file in the specified pak files.
Pointer to pak entry if the file was found, NULL otherwise.

code: static bool FindFileInPakFiles ( [TArray](API\Runtime\Core\Containers\TArray)< FPakListEntry > & Paks, const TCHAR * Filename, [TRefCountPtr](API\Runtime\Core\Templates\TRefCountPtr)< [FPakFile](API\Runtime\PakFile\FPakFile) > * OutPakFile, [FPakEntry](API\Runtime\PakFile\FPakEntry) * OutEntry )


description:
Finds all the files within the given directory, with optional file extension filter
FoundFiles All the files that matched the optional FileExtension filter, or all files if none was specified.

code: virtual void FindFiles ( [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & FoundFiles, const TCHAR * Directory, const TCHAR * FileExtension )


description:
Finds all the files within the directory tree, with optional file extension filter
FoundFiles All the files that matched the optional FileExtension filter, or all files if none was specified.

code: virtual void FindFilesRecursively ( [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & FoundFiles, const TCHAR * Directory, const TCHAR * FileExtension )


code: void FindFilesInternal ( [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & FoundFiles, const TCHAR * Directory, const TCHAR * FileExtension, bool bRecursive )


description: Iterates Iostore Container while Predicate returns true

code: static void ForeachPackageInIostoreWhile ( [TFunctionRef](API\Runtime\Core\GenericPlatform\TFunctionRef)< bool([FName](API\Runtime\Core\UObject\FName))> Predicate )


className: FPakSigningFailureHandlerData

code: struct FPakSigningFailureHandlerData

ChunkSignatureCheckFailedDelegate

type: FPakChunkSignat...

Lock

type: FCriticalSectio...

MasterSignatureTableCheckFailedDelegate

type: FPakPrincipalSi...


description:
Callback for a single file or a directory in a directory iteration.
true if the iteration should continue.

code: virtual bool Visit &40; const TCHAR &42; FilenameOrDirectory, const FFileStatData & StatData &41;


description: Constructor.

code: FPreventDuplicatesStatVisitor &40; FDirectoryStatVisitor & InVisitor, TSet< FString > & InVisitedFiles &41;


className: FPreventDuplicatesStatVisitor

Visitor

type: FDirectoryStatV...

description: Wrapped visitor.


code: virtual bool Visit &40; const TCHAR &42; FilenameOrDirectory, bool bIsDirectory &41;


description: Constructor.

code: FPreventDuplicatesVisitor &40; FDirectoryVisitor & InVisitor, TSet< FString > & InVisitedFiles &41;


className: FPreventDuplicatesVisitor

type: FDirectoryVisit...

description: Wrapped visitor.


code: bool CheckDuplicate &40; const TCHAR &42; FilenameOrDirectory &41;


description: Return the last access time of a file. ReturnsFDateTime::MinValue()on failure

code: virtual [FDateTime](API\Runtime\Core\Misc\FDateTime) GetAccessTimeStamp ( const TCHAR * Filename )


code: FPreventDuplicatesVisitorBase &40; TSet< FString > & InVisitedFiles &41;


description: For case insensitive filesystems, returns the full path of the file with the same case as in the filesystem

code: virtual [FString](API\Runtime\Core\Containers\FString) GetFilenameOnDisk ( const TCHAR * Filename )


description: Access static delegate for loose file security.

code: static FFilenameSecurityDelegate & GetFilenameSecurityDelegate()


description: Returns the RelativePathFromMount Filename for every Filename found in the Iostore Container that relates to the provided block indexes

code: static void GetFilenamesFromIostoreByBlockIndex ( const [FString](API\Runtime\Core\Containers\FString) & InContainerName, const [TArray](API\Runtime\Core\Containers\TArray)< int32 > & InBlockIndex, [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & OutFileList )


className: FPreventDuplicatesVisitorBase

description: Helper class to filter out files which have already been visited in one of the pak files.

code: class FPreventDuplicatesVisitorBase

VisitedFiles

type: TSet<FString>...

description: Visited files.


description: Returns the RelativePathFromMount Filename for every file found in the given Iostore Container

code: static void GetFilenamesFromIostoreContainer ( const [FString](API\Runtime\Core\Containers\FString) & InContainerName, [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & OutFileList )


description: Get a list of all pak files which have been successfully mounted

code: void GetMountedPakFilenames ( [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & PakFilenames )


description: Gets the platform file wrapped by this file.

code: virtual [IPlatformFile](API\Runtime\Core\GenericPlatform\IPlatformFile) * GetLowerLevel()


description: Get the wild card pattern used to identify paks to load on startup

code: static const TCHAR * GetMountStartupPaksWildCard()


description: Gets this platform file type name.

code: virtual const TCHAR * GetName() const


description: Determine location information for a given pakchunk index. Will be DoesNotExist if the pak file wasn't detected, NotAvailable if it exists but hasn't been mounted due to a missing encryption key, or LocalFast if it exists and has been mounted

code: [EChunkLocation::Type](API\Runtime\Core\GenericPlatform\EChunkLocation__Type) GetPakChunkLocation ( int32 InPakchunkIndex ) const


description: Access static delegate for custom encryption.

code: static FPakCustomEncryptionDelegate & GetPakCustomEncryptionDelegate()


description: Precaching

code: static void GetPakEncryptionKey ( [FAES::FAESKey](API\Runtime\Core\Misc\FAES\FAESKey) & OutKey, const [FGuid](API\Runtime\Core\Misc\FGuid) & InEncryptionKeyGuid )


description: Access static delegate for setting PakIndex settings.

code: static FPakSetIndexSettings & GetPakSetIndexSettingsDelegate()


description: Gets all pak file locations.

code: static void GetPakFolders ( const TCHAR * CmdLine, [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & OutPakFolders )


description: Load a pak signature file. Validates the contents by comparing a SHA hash of the chunk table against and encrypted version that is stored within the file. Returns nullptr if the data is missing or fails the signature check. This function also calls the generic pak signature failure delegates if anything is wrong.

code: static [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< const struct [FPakSignatureFile](API\Runtime\PakFile\FPakSignatureFile), ESPMode::ThreadSafe > GetPakSignatureFile ( const TCHAR * InFilename )


description: Access static delegate for handling a Pak signature check failure.


description: Get a list of RelativePathFromMount for every file in the given Pak that lives in any of the given chunks. Only searches the Pruned DirectoryIndex

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


description: Gets a list of FullPaths (includes Mount directory) for every File in the given Pak's Pruned DirectoryIndex

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


description: Return the stat data for the given file or directory. Check theFFileStatData::bIsValidmember before using the returned data

code: virtual [FFileStatData](API\Runtime\Core\GenericPlatform\FFileStatData) GetStatData ( const TCHAR * FilenameOrDirectory )


description: Return the modification time of a file. ReturnsFDateTime::MinValue()on failure

code: virtual [FDateTime](API\Runtime\Core\Misc\FDateTime) GetTimeStamp ( const TCHAR * Filename )


description: Get the unique name for the pak platform file layer

code: static const TCHAR * GetTypeName()


code: virtual void GetTimeStampPair ( const TCHAR * FilenameA, const TCHAR * FilenameB, [FDateTime](API\Runtime\Core\Misc\FDateTime) & OutTimeStampA, [FDateTime](API\Runtime\Core\Misc\FDateTime) & OutTimeStampB )


code: void HandleMountCommand ( const TCHAR * Cmd, [FOutputDevice](API\Runtime\Core\Misc\FOutputDevice) & Ar )


code: void HandlePakCorruptCommand ( const TCHAR * Cmd, [FOutputDevice](API\Runtime\Core\Misc\FOutputDevice) & Ar )


description: BEGIN Console commands.

code: void HandlePakListCommand ( const TCHAR * Cmd, [FOutputDevice](API\Runtime\Core\Misc\FOutputDevice) & Ar )


code: void HandleReloadPakReadersCommand ( const TCHAR * Cmd, [FOutputDevice](API\Runtime\Core\Misc\FOutputDevice) & Ar )


code: void HandleUnmountCommand ( const TCHAR * Cmd, [FOutputDevice](API\Runtime\Core\Misc\FOutputDevice) & Ar )


description: Performs initialization of the platform file after the new async IO has been enabled

code: virtual void InitializeNewAsyncIO()


description: Return true if the file is read only.

code: virtual bool IsReadOnly ( const TCHAR * Filename )


description:
Call the Visit function of the visitor once for each file or directory in a single directory. This function does not explore subdirectories.
false if the directory did not exist or if the visitor returned false.

code: virtual bool IterateDirectory ( const TCHAR * Directory, [IPlatformFile::FDirectoryVisitor](API\Runtime\Core\GenericPlatform\IPlatformFile\FDirectoryVisitor) & Visitor )


description: Return true if the file is a symbolic link

code: virtual ESymlinkResult IsSymlink ( const TCHAR * Filename )


code: bool IterateDirectoryInternal ( const TCHAR * Directory, [IPlatformFile::FDirectoryVisitor](API\Runtime\Core\GenericPlatform\IPlatformFile\FDirectoryVisitor) & Visitor, bool bRecursive )


code: bool IterateDirectoryInternal ( const TCHAR * Directory, [TUniqueFunction](API\Runtime\Core\Templates\TUniqueFunction)< bool(const [FString](API\Runtime\Core\Containers\FString) &, const [FString](API\Runtime\Core\Containers\FString) &, bool, [FPakFile](API\Runtime\PakFile\FPakFile) &)> & VisitFunction, bool bRecursive, [TSet](API\Runtime\Core\Containers\TSet)< [FString](API\Runtime\Core\Containers\FString) > & FilesVisitedInPak )


description:
Call the Visit function of the visitor once for each file or directory in a directory tree. This function explores subdirectories.
false if the directory did not exist or if the visitor returned false.

code: virtual bool IterateDirectoryRecursively ( const TCHAR * Directory, [IPlatformFile::FDirectoryVisitor](API\Runtime\Core\GenericPlatform\IPlatformFile\FDirectoryVisitor) & Visitor )


description:
Initializes platform file.
true if the initialization was successful, false otherise.

code: virtual bool Initialize ( [IPlatformFile](API\Runtime\Core\GenericPlatform\IPlatformFile) * Inner, const TCHAR * CmdLine )


code: virtual bool IterateDirectoryStat ( const TCHAR * Directory, [IPlatformFile::FDirectoryStatVisitor](API\Runtime\Core\GenericPlatform\IPlatformFile\FDirectoryStatVisitor) & Visitor )


code: virtual bool IterateDirectoryStatRecursively ( const TCHAR * Directory, [IPlatformFile::FDirectoryStatVisitor](API\Runtime\Core\GenericPlatform\IPlatformFile\FDirectoryStatVisitor) & Visitor )


code: bool IterateDirectoryStatInternal ( const TCHAR * Directory, [IPlatformFile::FDirectoryStatVisitor](API\Runtime\Core\GenericPlatform\IPlatformFile\FDirectoryStatVisitor) & Visitor, bool bRecursive )


description: Make unique in memory pak files from a list of named files

code: virtual void MakeUniquePakFilesForTheseFiles ( const [TArray](API\Runtime\Core\Containers\TArray)< [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) >> & InFiles )


description: Mounts a pak file at the specified path.

code: bool Mount ( const TCHAR * InPakFilename, uint32 PakOrder, const TCHAR * InPath, bool bLoadIndex )


code: int32 MountAllPakFiles ( const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & PakFolders )


code: int32 MountAllPakFiles ( const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & PakFolders, const [FString](API\Runtime\Core\Containers\FString) & WildCard )


description: Attempt to move a file. Return true if successful. Will not overwrite existing files.

code: virtual bool MoveFile ( const TCHAR * To, const TCHAR * From )


description:
Open a file for async reading. This call does not hit the disk or block.
Close the file by delete'ing the handle. A non-null return value does not mean the file exists, since that may not be determined yet.

code: virtual [IAsyncReadFileHandle](API\Runtime\Core\Async\IAsyncReadFileHandle) * OpenAsyncRead ( const TCHAR * Filename )


description:
Attempt to open a file for reading.
If successful will return a non-nullptr pointer. Close the file by delete'ing the handle.

code: virtual [IFileHandle](API\Runtime\Core\GenericPlatform\IFileHandle) * OpenRead ( const TCHAR * Filename, bool bAllowWrite )


description:
Open a file for async reading. This call does hit the disk; it is synchronous open.
Close the file by delete'ing the handle. A non-null return value does mean the file exists. Null can be returned for many reasons even if the file exists. Perhaps this platform does not support mapped files, or this file is compressed in a pak file. Generally you attempt to open mapped, and if that fails, then use other file operations instead.

code: virtual [IMappedFileHandle](API\Runtime\Core\Async\IMappedFileHandle) * OpenMapped ( const TCHAR * Filename )


description: Attempt to open a file for writing. If successful will return a non-nullptr pointer. Close the file by delete'ing the handle.

code: virtual [IFileHandle](API\Runtime\Core\GenericPlatform\IFileHandle) * OpenWrite ( const TCHAR * Filename, bool bAppend, bool bAllowRead )


className: PakSignatureFileCache

description: Internal cache of pak signature files.

code: static [TMap](API\Runtime\Core\Containers\TMap)< [FName](API\Runtime\Core\UObject\FName), [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< const struct [FPakSignatureFile](API\Runtime\PakFile\FPakSignatureFile), ESPMode::ThreadSafe > > PakSignatureFileCache;


description: Re-creates all the pak readers

code: bool ReloadPakReaders()


description: Remove the intenrally cached pointer to the signature file for the specified pak

code: static void RemoveCachedPakSignaturesFile ( const TCHAR * InFilename )


description: Controls if the pak precacher should process precache requests. Requests below this threshold will not get precached. Without this throttle, quite a lot of memory can be consumed if the disk races ahead of the CPU.

code: virtual void SetAsyncMinimumPriority ( EAsyncIOPriorityAndFlags MinPriority )


description: Overrides the wildcard used for searching paks. Call before initialization

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


description: Attempt to change the read only status of a file. Return true if successful.

code: virtual bool SetReadOnly ( const TCHAR * Filename, bool bNewReadOnlyValue )


description: Checks if this platform file should be used even though it was not asked to be. i.e. pak files exist on disk so we should use a pak file

code: virtual bool ShouldBeUsed ( [IPlatformFile](API\Runtime\Core\GenericPlatform\IPlatformFile) * Inner, const TCHAR * CmdLine ) const


description: Sets the modification time of a file

code: virtual void SetTimeStamp ( const TCHAR * Filename, [FDateTime](API\Runtime\Core\Misc\FDateTime) DateTime )


description: Platform file can override this to get a regular tick from the engine

code: virtual void Tick()


code: bool Unmount ( const TCHAR * InPakFilename )


description: Constructor.

code: FPakPlatformFile()


description: Destructor.

code: virtual ~FPakPlatformFile()


description: Sets the platform file wrapped by this file.

code: virtual void SetLowerLevel ( [IPlatformFile](API\Runtime\Core\GenericPlatform\IPlatformFile) * NewLowerLevel )


className: FPakPlatformFile

description: Platform file wrapper to be able to use pak files.

code: class FPakPlatformFile : public [IPlatformFile](API\Runtime\Core\GenericPlatform\IPlatformFile)


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


code: FPakReaderPolicy ( const [FPakFile](API\Runtime\PakFile\FPakFile) & InPakFile, const [FPakEntry](API\Runtime\PakFile\FPakEntry) & InPakEntry, TAcquirePakReaderFunction & InAcquirePakReader )


className: FPakReaderPolicy

code: template<typename EncryptionPolicy> class FPakReaderPolicy

AcquirePakReader

type: TAcquirePakRead...

description: Pak file archive to read the data from.

OffsetToFile

description: Offset to the file in pak (including the file header).

PakEntry

description: Pak file entry for this file.

PakFile

description: Pak file that own this file data


description: Helper function for computing the SHA1 hash of the current chunk CRC array


description: Decrypt the chunk CRCs hash and validate that it matches the current one

code: bool DecryptSignatureAndValidate ( const FRSAKeyHandle InKey, const [FString](API\Runtime\Core\Containers\FString) & InFilename )


description: Serialize/deserialize this object to/from anFArchive

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


className: EVersion

code: enum EVersion { Invalid, First, Last, Latest = Last - 1, }


description: Initialize and hash the CRC list then use the provided private key to encrypt the hash

code: void SetChunkHashesAndSign ( const [TArray](API\Runtime\Core\Containers\TArray)< TPakChunkHash > & InChunkHashes, const [TArrayView](API\Runtime\Core\Containers\TArrayView)< uint8 > & InSignatureData, const FRSAKeyHandle InKey )


className: Magic

description: Magic number that tells us we're dealing with the new format sig files.

code: static const uint32 Magic = 0x73832DAA;


className: FPakSignatureFile

description: Structure which describes the content of the pak .sig files

code: struct FPakSignatureFile

ChunkHashes

type: TArray< TPakChu...

description: CRCs of each contiguous 64kb block of the pak file.

DecryptedHash

description: SHA1 hash of the chunk CRC data. Only valid after calling DecryptSignatureAndValidate.

EncryptedHash

type: TArray< uint8 >

description: RSA encrypted hash.

SignatureData

description: The actual array of data that was encrypted in the RSA block. Contains the chunk table hash and also other custom data related to the pak file.

Version

type: EVersion

description: Sig file version. Set to Legacy if the sig file is of an old version.


description: USE WITH CARE, theFSharedPakReadermust live longer than this reference to prevent the archive being used by another thread. Do not call on a temporary return value!


className: FSharedPakReader::operator bool

code: operator bool() const


code: [FSharedPakReader](API\Runtime\PakFile\FSharedPakReader) & operator= ( [FSharedPakReader](API\Runtime\PakFile\FSharedPakReader) && Other )


code: [FSharedPakReader](API\Runtime\PakFile\FSharedPakReader) & operator= ( const [FSharedPakReader](API\Runtime\PakFile\FSharedPakReader) & Other )


code: FSharedPakReader ( [FSharedPakReader](API\Runtime\PakFile\FSharedPakReader) && Other )


code: FSharedPakReader ( const [FSharedPakReader](API\Runtime\PakFile\FSharedPakReader) & Other )


code: FSharedPakReader &40; FArchive &42; InArchive, FPakFile &42; InPakFile &41;


className: FSharedPakReader

description: Wrapper for a pointer to a shared pak reader archive that has been temporarily acquired.

code: class FSharedPakReader


className: Callback

module: PerfCounters

code: enum &123; Callback &125;


className: Number

code: enum &123; Number &125;


className: String

code: enum &123; String &125;


className: Flags

code: enum Flags { Transient = (1 << 0), }


className: FJsonVariant

code: struct FJsonVariant

CallbackValue

type: FProduceJsonCou...

Format

type: enum IPerfCount...

StringValue

type: FString


description: Get overloads

code: int32 Get ( const [FString](API\Runtime\Core\Containers\FString) & Name, int32 Val )


code: float Get ( const [FString](API\Runtime\Core\Containers\FString) & Name, float Val )


code: double Get ( const [FString](API\Runtime\Core\Containers\FString) & Name, double Val )


description: all perf counters as they are stored, with minimum conversion

code: const [TMap](API\Runtime\Core\Containers\TMap)< [FString](API\Runtime\Core\Containers\FString), [FJsonVariant](API\Runtime\PerfCounters\IPerfCounters\FJsonVariant) > & GetAllCounters()


description: all perf counters as JSON


description: Get the unique identifier for this perf counter instance

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


description: Returns currently held value, or DefaultValue if none

code: double GetNumber ( const [FString](API\Runtime\Core\Containers\FString) & Name, double DefaultValue )


className: FrameTime

description: Frame time histogram for the duration of the match.

code: static FrameTime;


className: FrameTimePeriodic

description: Frame time histogram for shorter intervals.

code: static FrameTimePeriodic;


className: FrameTimeWithoutSleep

description: Frame time histogram (without sleep) for the duration of the match.

code: static FrameTimeWithoutSleep;


className: ServerReplicateActorsTime

description: ServerReplicateActors time histogram for the duration of the match.

code: static ServerReplicateActorsTime;


code: uint32 Get ( const [FString](API\Runtime\Core\Containers\FString) & Name, uint32 Val )


className: SleepTime

description: Sleep time histogram for the duration of the match.

code: static SleepTime;


className: ZeroLoadFrameTime

description: Zero load thread frame time histogram.

code: static ZeroLoadFrameTime;


className: Histograms

description: Named engine-wide histograms

code: struct Histograms


description:
Convenience method for incrementing a transient counter.
current value (i.e. after the increment)

code: int32 Increment ( const [FString](API\Runtime\Core\Containers\FString) & Name, int32 Add, int32 DefaultValue, uint32 Flags )


description: delegate called when an exec command is to be executed


description: Returns performance histograms for direct manipulation by the client code.


description: Reports an unplayable condition.

code: bool ReportUnplayableCondition ( const [FString](API\Runtime\Core\Containers\FString) & ConditionDescription )


description: Clears transient perf counters, essentially marking beginning of a new stats period

code: void ResetStatsForNextPeriod()


description: Set overloads (use these)

code: void Set ( const [FString](API\Runtime\Core\Containers\FString) & Name, int32 Val, uint32 Flags )


code: void Set ( const [FString](API\Runtime\Core\Containers\FString) & Name, uint32 Val, uint32 Flags )


code: void Set ( const [FString](API\Runtime\Core\Containers\FString) & Name, float Val, uint32 Flags )


code: void Set ( const [FString](API\Runtime\Core\Containers\FString) & Name, double Val, uint32 Flags )


code: void Set ( const [FString](API\Runtime\Core\Containers\FString) & Name, uint64 Val, uint32 Flags )


code: void Set ( const [FString](API\Runtime\Core\Containers\FString) & Name, int64 Val, uint32 Flags )


code: void Set ( const [FString](API\Runtime\Core\Containers\FString) & Name, const FProduceJsonCounterValue & Callback, uint32 Flags )


code: void Set ( const [FString](API\Runtime\Core\Containers\FString) & Name, const [FString](API\Runtime\Core\Containers\FString) & Val, uint32 Flags )


description: Make a callback so we can request more extensive types on demand (presumably backed by some struct locally)

code: void SetJson ( const [FString](API\Runtime\Core\Containers\FString) & Name, const FProduceJsonCounterValue & Callback, uint32 Flags )


description: Maps value to a string holder

code: void SetString ( const [FString](API\Runtime\Core\Containers\FString) & Name, const [FString](API\Runtime\Core\Containers\FString) & Value, uint32 Flags )


description: Maps value to a numeric holder

code: void SetNumber ( const [FString](API\Runtime\Core\Containers\FString) & Name, double Value, uint32 Flags )


description: Starts tracking overall machine load.

code: bool StartMachineLoadTracking()


description: Starts tracking overall machine load (empty array will use default hitch buckets).

code: bool StartMachineLoadTracking ( double TickRate, const [TArray](API\Runtime\Core\Containers\TArray)< double > & FrameTimeHistogramBucketsMs )


className: TPerformanceHistogramMap

description: Array used to store performance histograms.

code: typedef [TMap](API\Runtime\Core\Containers\TMap)< [FName](API\Runtime\Core\UObject\FName), [FHistogram](API\Runtime\Core\ProfilingDebugging\FHistogram) > TPerformanceHistogramMap


description: Stops tracking overall machine load.

code: bool StopMachineLoadTracking()


className: IPerfCounters

description: A programming interface for setting/updating performance counters

code: class IPerfCounters


description: Creates and initializes the performance counters objectIPerfCountersobject (should be explicitly deleted later), or nullptr if failed

code: [IPerfCounters](API\Runtime\PerfCounters\IPerfCounters) * CreatePerformanceCounters ( const [FString](API\Runtime\Core\Containers\FString) & UniqueInstanceId )


description:
Singleton-like access to this module's interface. This is just for convenience! Beware of calling this during the shutdown phase, though. Your module might have been unloaded already.
Returns singleton instance, loading the module on demand if needed

code: static [IPerfCountersModule](API\Runtime\PerfCounters\IPerfCountersModule) & Get()


description: Returns the HTTP port to bind for the stats request. Returns -1 if none were specified

code: static int32 GetHTTPStatsPort()


description: the currently initialized / in use perf counters

code: [IPerfCounters](API\Runtime\PerfCounters\IPerfCounters) * GetPerformanceCounters() const


description:
Checks to see if this module is loaded and ready. It is only valid to callGet()ifIsAvailable()returns true.
True if the module is loaded and ready to use

code: static bool IsAvailable()


className: IPerfCountersModule

description: The public interface to this module

code: class IPerfCountersModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface)


module: PhysicsCore

code: static int SoftAngularForceMode()


code: static int SoftLinearForceMode()


className: ConstraintSettings

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

code: class ConstraintSettings


description: Enum to indicate which context frame we use for physical constraints

code: namespace EConstraintFrame { enum Type { Frame1, Frame2, } }


code: static void AddActorToAggregate_AssumesLocked ( const [FPhysicsAggregateReference_Chaos](API\Runtime\PhysicsCore\Chaos\FPhysicsAggregateReference_Chaos) & InAggregate, const FPhysicsActorHandle & InActor )


code: static void AddActorToSolver ( FPhysicsActorHandle & Handle, [Chaos::FPhysicsSolver](API\Runtime\Chaos\Chaos\FPhysicsSolver) * Solver )


code: static void AddAngularImpulseInRadians_AssumesLocked ( const FPhysicsActorHandle & InActorReference, const FVector & InTorque, bool bIsInternal )


code: static void AddAngularVelocityInRadians_AssumesLocked ( const FPhysicsActorHandle & InActorReference, const FVector & InTorque, bool bIsInternal )


code: static void AddDisabledCollisionsFor_AssumesLocked ( const [TMap](API\Runtime\Core\Containers\TMap)< FPhysicsActorHandle, [TArray](API\Runtime\Core\Containers\TArray)< FPhysicsActorHandle > > & InMap )


code: static void AddForceAtPosition_AssumesLocked ( const FPhysicsActorHandle & InActorReference, const FVector & Force, const FVector & Position, bool bAllowSubstepping, bool bIsLocalForce, bool bIsInternal )


code: static void AddForce_AssumesLocked ( const FPhysicsActorHandle & InActorReference, const FVector & Force, bool bAllowSubstepping, bool bAccelChange, bool bIsInternal )


code: static void AddImpulseAtLocation_AssumesLocked ( const FPhysicsActorHandle & InActorReference, const FVector & InImpulse, const FVector & InLocation, bool bIsInternal )


code: static void AddImpulse_AssumesLocked ( const FPhysicsActorHandle & InActorReference, const FVector & InForce, bool bIsInternal )


code: static void AddRadialImpulse_AssumesLocked ( const FPhysicsActorHandle & InActorReference, const FVector & InOrigin, float InRadius, float InStrength, ERadialImpulseFalloff InFalloff, bool bInVelChange, bool bIsInternal )


code: static void AddRadialForce_AssumesLocked ( const FPhysicsActorHandle & InActorReference, const FVector & Origin, const float Radius, const float Strength, const uint8 Falloff, bool bAccelChange, bool bAllowSubstepping, bool bIsInternal )


code: static void AddTorque_AssumesLocked ( const FPhysicsActorHandle & InActorReference, const FVector & Torque, bool bAllowSubstepping, bool bAccelChange, bool bIsInternal )


code: static void AddVelocity_AssumesLocked ( const FPhysicsActorHandle & InActorReference, const FVector & InForce, bool bIsInternal )


code: static void AddVelocityChangeImpulseAtLocation_AssumesLocked ( const FPhysicsActorHandle & InActorReference, const FVector & InVelocityDelta, const FVector & InLocation, bool bIsInternal )


code: static void AttachShape ( const FPhysicsActorHandle & InActor, const FPhysicsShapeHandle & InNewShape )


code: static FPhysicsShapeHandle CloneShape ( const FPhysicsShapeHandle & InShape )


code: static [FPhysicsAggregateReference_Chaos](API\Runtime\PhysicsCore\Chaos\FPhysicsAggregateReference_Chaos) CreateAggregate ( int32 MaxBodies )


code: static void CreateActor ( const [FActorCreationParams](API\Runtime\PhysicsCore\FActorCreationParams) & InParams, FPhysicsActorHandle & Handle )


code: static FPhysicsMaterialHandle CreateMaterial ( const [UPhysicalMaterial](API\Runtime\PhysicsCore\PhysicalMaterials\UPhysicalMaterial) * InMaterial )


code: static FPhysicsConstraintHandle CreateConstraint ( Chaos::FPhysicsObject * Body1, Chaos::FPhysicsObject * Body2, const FTransform & InLocalFrame1, const FTransform & InLocalFrame2 )


code: static FPhysicsConstraintHandle CreateConstraint ( const FPhysicsActorHandle & InActorRef1, const FPhysicsActorHandle & InActorRef2, const FTransform & InLocalFrame1, const FTransform & InLocalFrame2 )


code: static bool CanSimulate_AssumesLocked ( const FPhysicsActorHandle & InActorReference )


code: static FPhysicsConstraintHandle CreateSuspension ( const FPhysicsActorHandle & InActorRef, const FVector & InLocalFrame )


code: static void DetachShape ( const FPhysicsActorHandle & InActor, FPhysicsShapeHandle & InShape, bool bWakeTouching )


code: static int32 GetAllShapes_AssumedLocked ( const FPhysicsActorHandle & InActorHandle, [TArray](API\Runtime\Core\Containers\TArray)< [FPhysicsShapeReference_Chaos](API\Runtime\PhysicsCore\Chaos\FPhysicsShapeReference_Chaos), FDefaultAllocator > & OutShapes )


code: static int32 GetAllShapes_AssumedLocked ( const FPhysicsActorHandle & InActorHandle, [PhysicsInterfaceTypes::FInlineShapeArray](API\Runtime\PhysicsCore\Chaos\FInlineShapeArray) & OutShapes )


code: static FVector GetAngularVelocity_AssumesLocked ( const FPhysicsActorHandle & InActorReference )


code: static FBox GetBounds_AssumesLocked ( const FPhysicsActorHandle & InActorReference )


code: static FBox GetBounds_AssumesLocked ( const FPhysicsActorHandle & InActorReference, const FTransform & InTransform )


code: static FTransform GetComTransformLocal_AssumesLocked ( const FPhysicsActorHandle & InActorReference )


code: static FTransform GetComTransform_AssumesLocked ( const FPhysicsActorHandle & InActorReference )


code: static [FChaosScene](API\Runtime\PhysicsCore\Chaos\FChaosScene) * GetCurrentScene ( const FPhysicsActorHandle & InHandle )


code: static float GetCurrentSwing2 ( const FPhysicsConstraintHandle & InConstraintRef )


code: static float GetCurrentTwist ( const FPhysicsConstraintHandle & InConstraintRef )


code: static float GetCurrentSwing1 ( const FPhysicsConstraintHandle & InConstraintRef )


code: static void GetDriveAngularVelocity ( const FPhysicsConstraintHandle & InConstraintRef, FVector & OutAngVelocity )


code: static void GetDriveLinearVelocity ( const FPhysicsConstraintHandle & InConstraintRef, FVector & OutLinVelocity )


code: static void GetForce ( const FPhysicsConstraintHandle & InConstraintRef, FVector & OutLinForce, FVector & OutAngForce )


code: static [FPhysicsGeometryCollection_Chaos](API\Runtime\PhysicsCore\Chaos\FPhysicsGeometryCollection_Chaos) GetGeometryCollection ( const FPhysicsShapeHandle & InShape )


code: static [FPhysicsGeometryCollection_Chaos](API\Runtime\PhysicsCore\Chaos\FPhysicsGeometryCollection_Chaos) GetGeometryCollection ( const FPhysicsGeometry & InShape )


code: static FTransform GetGlobalPose ( const FPhysicsConstraintHandle & InConstraintRef, [EConstraintFrame::Type](API\Runtime\PhysicsCore\Chaos\EConstraintFrame__Type) InFrame )


code: static FTransform GetGlobalPose_AssumesLocked ( const FPhysicsActorHandle & InActorReference )


code: static FTransform GetKinematicTarget_AssumesLocked ( const FPhysicsActorHandle & InActorReference )


code: static FVector GetLinearVelocity_AssumesLocked ( const FPhysicsActorHandle & InActorReference )


code: static FVector GetLocalInertiaTensor_AssumesLocked ( const FPhysicsActorHandle & InActorReference )


code: static FTransform GetLocalPose ( const FPhysicsConstraintHandle & InConstraintRef, [EConstraintFrame::Type](API\Runtime\PhysicsCore\Chaos\EConstraintFrame__Type) InFrame )


code: static FTransform GetLocalTransform ( const FPhysicsShapeHandle & InShape )


code: static FVector GetLocation ( const FPhysicsConstraintHandle & InConstraintRef )


code: static float GetMass_AssumesLocked ( const FPhysicsActorHandle & InActorReference )


code: static float GetMaxAngularVelocity_AssumesLocked ( const FPhysicsActorHandle & InActorReference )


code: static float GetMaxDepenetrationVelocity_AssumesLocked ( const FPhysicsActorHandle & InActorReference )


code: static float GetMaxLinearVelocity_AssumesLocked ( const FPhysicsActorHandle & InActorReference )


code: static int32 GetNumActorsInAggregate ( const [FPhysicsAggregateReference_Chaos](API\Runtime\PhysicsCore\Chaos\FPhysicsAggregateReference_Chaos) & InAggregate )


code: static int32 GetNumShapes ( const FPhysicsActorHandle & InHandle )


code: static SIZE_T GetResourceSizeEx ( const FPhysicsActorHandle & InActorRef )


code: static ECollisionShapeType GetShapeType ( const FPhysicsShapeHandle & InShape )


code: static [FCollisionFilterData](API\Runtime\Chaos\Chaos\FCollisionFilterData) GetQueryFilter ( const FPhysicsShapeHandle & InShape )


code: static float GetSleepEnergyThreshold_AssumesLocked ( const FPhysicsActorHandle & InActorReference )


code: static [FCollisionFilterData](API\Runtime\Chaos\Chaos\FCollisionFilterData) GetSimulationFilter ( const FPhysicsShapeHandle & InShape )


code: static uint32 GetSolverPositionIterationCount_AssumesLocked ( const FPhysicsActorHandle & InHandle )


code: static uint32 GetSolverVelocityIterationCount_AssumesLocked ( const FPhysicsActorHandle & InHandle )


code: static float GetStabilizationEnergyThreshold_AssumesLocked ( const FPhysicsActorHandle & InHandle )


code: static FTransform GetTransform_AssumesLocked ( const FPhysicsActorHandle & InRef, bool bForceGlobalPose )


code: static void * GetUserData ( const FPhysicsShapeHandle & InShape )


code: static float GetWakeCounter_AssumesLocked ( const FPhysicsActorHandle & InHandle )


code: static bool GetUpdateKinematicFromSimulation_AssumesLocked ( const FPhysicsActorHandle & InActorReference )


code: static FVector GetWorldVelocityAtPoint_AssumesLocked ( const FPhysicsActorHandle & InActorReference, const FVector & InPoint )


code: static bool HasAsyncSceneData ( const FPhysicsActorHandle & InHandle )


code: static bool HasKinematicTarget_AssumesLocked ( const FPhysicsActorHandle & InActorReference )


code: static bool HasSyncSceneData ( const FPhysicsActorHandle & InHandle )


code: static bool IsBroken ( const FPhysicsConstraintHandle & InConstraintRef )


code: static bool IsCcdEnabled ( const FPhysicsActorHandle & InActorReference )


code: static bool IsDisabled ( const FPhysicsActorHandle & InPhysicsActor )


code: static bool IsDynamic ( const FPhysicsActorHandle & InActorReference )


code: static bool IsGravityEnabled_AssumesLocked ( const FPhysicsActorHandle & InActorReference )


code: static bool IsInertiaConditioningEnabled_AssumesLocked ( const FPhysicsActorHandle & InActorReference )


code: static bool IsInScene ( const FPhysicsActorHandle & InActorReference )


code: static bool IsKinematic ( const FPhysicsActorHandle & InActorReference )


code: static bool IsKinematic_AssumesLocked ( const FPhysicsActorHandle & InActorReference )


code: static bool IsQueryShape ( const FPhysicsShapeHandle & InShape )


code: static FVector GetWorldVelocityAtPoint_AssumesLocked ( const [Chaos::FRigidBodyHandle_Internal](API\Runtime\Chaos\PhysicsProxy\FRigidBodyHandle_Internal) * InActorReference, const FVector & InPoint )


code: static bool IsRigidBody ( const FPhysicsActorHandle & InActorReference )


code: static bool IsSleeping ( const FPhysicsActorHandle & InActorReference )


code: static bool IsSimulationShape ( const FPhysicsShapeHandle & InShape )


code: static bool IsStatic ( const FPhysicsActorHandle & InActorReference )


code: static bool IsValid ( const FPhysicsActorHandle & Handle )


code: static void PutToSleep_AssumesLocked ( const FPhysicsActorHandle & InActorReference )


code: static void ReleaseActor ( FPhysicsActorHandle & InActorReference, [FChaosScene](API\Runtime\PhysicsCore\Chaos\FChaosScene) * InScene, bool bNeverDeferRelease )


code: static void ReleaseAggregate ( [FPhysicsAggregateReference_Chaos](API\Runtime\PhysicsCore\Chaos\FPhysicsAggregateReference_Chaos) & InAggregate )


code: static void ReleaseConstraint ( FPhysicsConstraintHandle & InConstraintRef )


code: static void ReleaseMaterial ( FPhysicsMaterialHandle & InHandle )


code: static void ReleaseMaterialMask ( FPhysicsMaterialMaskHandle & InHandle )


code: static void ReleaseShape ( const FPhysicsShapeHandle & InShape )


code: static void RemoveActorFromSolver ( FPhysicsActorHandle & Handle, [Chaos::FPhysicsSolver](API\Runtime\Chaos\Chaos\FPhysicsSolver) * Solver )


code: static void RemoveDisabledCollisionsFor_AssumesLocked ( [TArray](API\Runtime\Core\Containers\TArray)< FPhysicsActorHandle > & InPhysicsActors )


code: static void SetActorUserData_AssumesLocked ( FPhysicsActorHandle & InActorReference, FPhysicsUserData * InUserData )


code: static void SetAngularDamping_AssumesLocked ( const FPhysicsActorHandle & InActorReference, float InDamping )


code: static void SetAngularVelocity_AssumesLocked ( const FPhysicsActorHandle & InActorReference, const FVector & InNewVelocity, bool bAutoWake )


code: static void SetBreakForces_AssumesLocked ( const FPhysicsConstraintHandle & InConstraintRef, float InLinearBreakForce, float InAngularBreakForce )


code: static void SetCcdEnabled_AssumesLocked ( const FPhysicsActorHandle & InActorReference, bool bIsCcdEnabled )


code: static void SetCanVisualize ( const FPhysicsConstraintHandle & InConstraintRef, bool bInCanVisualize )


code: static void SetCollisionEnabled ( const FPhysicsConstraintHandle & InConstraintRef, bool bInCollisionEnabled )


code: static void SetComLocalPose_AssumesLocked ( const FPhysicsActorHandle & InHandle, const FTransform & InComLocalPose )


code: static void SetConstraintUserData ( const FPhysicsConstraintHandle & InConstraintRef, void * InUserData )


code: static void SetContactTransferScale_AssumesLocked ( const FPhysicsConstraintHandle & InConstraintRef, float InContactTransferScale )


code: static void SetDisabled ( const FPhysicsActorHandle & InPhysicsActor, bool bSetDisabled )


code: static void SetDriveLinearVelocity ( const FPhysicsConstraintHandle & InConstraintRef, const FVector & InLinVelocity )


code: static void SetDriveOrientation ( const FPhysicsConstraintHandle & InConstraintRef, const FQuat & InOrientation )


code: static void SetDrivePosition ( const FPhysicsConstraintHandle & InConstraintRef, const FVector & InPosition )


code: static void SetGeometry ( FPhysicsShapeHandle & InShape, [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< [Chaos::FImplicitObject](API\Runtime\Chaos\Chaos\FImplicitObject) > && InGeometry )


code: static void SetGravityEnabled_AssumesLocked ( const FPhysicsActorHandle & InActorReference, bool bEnabled )


code: static void SetGlobalPose_AssumesLocked ( const FPhysicsActorHandle & InActorReference, const FTransform & InNewPose, bool bAutoWake )


code: static void SetIgnoreAnalyticCollisions_AssumesLocked ( const FPhysicsActorHandle & InActorReference, bool bIsCcdEnabled )


code: static void SetInertiaConditioningEnabled_AssumesLocked ( const FPhysicsActorHandle & InActorReference, bool bEnabled )


code: static void SetInitialized_AssumesLocked ( const FPhysicsActorHandle & InHandle, bool InInitialized )


code: static void SetIsKinematic_AssumesLocked ( const FPhysicsActorHandle & InActorReference, bool bIsKinematic )


code: static void SetIsProbeShape ( const FPhysicsShapeHandle & InShape, bool bIsProbeShape )


code: static void SetDriveAngularVelocity ( const FPhysicsConstraintHandle & InConstraintRef, const FVector & InAngVelocity )


code: static void SetIsQueryShape ( const FPhysicsShapeHandle & InShape, bool bIsQueryShape )


code: static void SetIsSimulationShape ( const FPhysicsShapeHandle & InShape, bool bIsSimShape )


code: static void SetKinematicTarget_AssumesLocked ( const FPhysicsActorHandle & InActorReference, const FTransform & InNewTarget )


code: static void SetLinearDamping_AssumesLocked ( const FPhysicsActorHandle & InActorReference, float InDamping )


code: static void SetLinearLimit ( const FPhysicsConstraintHandle & InConstraintRef, float InLimit )


code: static void SetLinearVelocity_AssumesLocked ( const FPhysicsActorHandle & InActorReference, const FVector & InNewVelocity, bool bAutoWake )


code: static void SetLocalPose ( const FPhysicsConstraintHandle & InConstraintRef, const FTransform & InPose, [EConstraintFrame::Type](API\Runtime\PhysicsCore\Chaos\EConstraintFrame__Type) InFrame )


code: static void SetLocalTransform ( const FPhysicsShapeHandle & InShape, const FTransform & NewLocalTransform )


code: static void SetMaskFilter ( const FPhysicsShapeHandle & InShape, FMaskFilter InFilter )


code: static void SetMassConditioningEnabled_AssumesLocked ( const FPhysicsConstraintHandle & InConstraintRef, bool bInMassConditioningEnabled )


code: static void SetMassSpaceInertiaTensor_AssumesLocked ( FPhysicsActorHandle & InHandle, const FVector & InTensor )


code: static void SetMass_AssumesLocked ( FPhysicsActorHandle & InHandle, float InMass )


code: static void SetMaxAngularVelocity_AssumesLocked ( const FPhysicsActorHandle & InActorReference, float InMaxAngularVelocityRadians )


code: static void SetMaxDepenetrationVelocity_AssumesLocked ( const FPhysicsActorHandle & InActorReference, float InMaxDepenetrationVelocity )


code: static void SetMaxLinearVelocity_AssumesLocked ( const FPhysicsActorHandle & InActorReference, float InMaxLinearVelocity )


code: static void SetOneWayInteraction_AssumesLocked ( const FPhysicsActorHandle & InHandle, bool InOneWayInteraction )


code: static void SetParentDominates_AssumesLocked ( const FPhysicsConstraintHandle & InConstraintRef, bool bInParentDominates )


code: static void SetPlasticityLimits_AssumesLocked ( const FPhysicsConstraintHandle & InConstraintRef, float InLinearPlasticityLimit, float InAngularPlasticityLimit, EConstraintPlasticityType InLinearPlasticityType )


code: static void SetProjectionEnabled_AssumesLocked ( const FPhysicsConstraintHandle & InConstraintRef, bool bInProjectionEnabled, float InLinearAlpha, float InAngularAlpha, float InLinearTolerance, float InAngularToleranceDeg )


code: static void SetQueryFilter ( const FPhysicsShapeHandle & InShape, const [FCollisionFilterData](API\Runtime\Chaos\Chaos\FCollisionFilterData) & InFilter )


code: static void SetShockPropagationEnabled_AssumesLocked ( const FPhysicsConstraintHandle & InConstraintRef, bool bInShockPropagationEnabled, float InShockPropagationAlpha )


code: static void SetSendsSleepNotifies_AssumesLocked ( const FPhysicsActorHandle & InActorReference, bool bSendSleepNotifies )


code: static void SetSimulationFilter ( const FPhysicsShapeHandle & InShape, const [FCollisionFilterData](API\Runtime\Chaos\Chaos\FCollisionFilterData) & InFilter )


code: static void SetSleepEnergyThreshold_AssumesLocked ( const FPhysicsActorHandle & InActorReference, float InEnergyThreshold )


code: static void SetSolverPositionIterationCount_AssumesLocked ( const FPhysicsActorHandle & InHandle, uint32 InSolverIterationCount )


code: static void SetSmoothEdgeCollisionsEnabled_AssumesLocked ( const FPhysicsActorHandle & InActor, const bool bSmoothEdgeCollisionsEnabled )


code: static void SetSolverVelocityIterationCount_AssumesLocked ( const FPhysicsActorHandle & InHandle, uint32 InSolverIterationCount )


code: static void SetStabilizationEnergyThreshold_AssumesLocked ( const FPhysicsActorHandle & InHandle, float InThreshold )


code: static void SetSwingLimit ( const FPhysicsConstraintHandle & InConstraintRef, float InYLimit, float InZLimit, float InContactDistance )


code: static void SetTwistLimit ( const FPhysicsConstraintHandle & InConstraintRef, float InLowerLimit, float InUpperLimit, float InContactDistance )


code: static void SetUpdateKinematicFromSimulation_AssumesLocked ( const FPhysicsActorHandle & InActorReference, bool bUpdateKinematicFromSimulation )


code: static void SetUserData ( FPhysicsMaterialHandle & InHandle, void * InUserData )


code: static void SetUserData ( const FPhysicsShapeHandle & InShape, void * InUserData )


code: static void SetWakeCounter_AssumesLocked ( const FPhysicsActorHandle & InHandle, float InWakeCounter )


code: static void UpdateMaterial ( FPhysicsMaterialHandle & InHandle, [UPhysicalMaterial](API\Runtime\PhysicsCore\PhysicalMaterials\UPhysicalMaterial) * InMaterial )


code: static void WakeUp_AssumesLocked ( const FPhysicsActorHandle & InActorReference )


code: virtual ~FChaosEngineInterface()


className: FChaosEngineInterface

code: class FChaosEngineInterface


code: void AddActorsToScene_AssumesLocked ( [TArray](API\Runtime\Core\Containers\TArray)< FPhysicsActorHandle > & InHandles, const bool bImmediate )


code: void AddPieModifiedObject ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * InObj )


code: bool AreAnyTasksPending() const


description: Copies the acceleration structure out of the solver, does no thread safety checking so ensure calls to this are made at appropriate sync points if required

code: void CopySolverAccelerationStructure()


description: Flushes all pending global, task and solver command queues and refreshes the spatial acceleration for the scene. Required when querying against a currently non-running scene to ensure the scene is correctly represented

code: void Flush()


className: FOnPhysScenePostTick

code: typedef TMulticastDelegate_OneParam< void, [FChaosScene](API\Runtime\PhysicsCore\Chaos\FChaosScene) * > FOnPhysScenePostTick


code: FGraphEventArray GetCompletionEvents()


code: float GetNetworkDeltaTimeScale() const


description: Get the internal Chaos solver object

code: [Chaos::FPhysicsSolver](API\Runtime\Chaos\Chaos\FPhysicsSolver) * GetSolver() const


code: const [Chaos::ISpatialAcceleration](API\Runtime\Engine\Physics\Experimental\ISpatialAcceleration)< [Chaos::FAccelerationStructureHandle](API\Runtime\Chaos\Chaos\FAccelerationStructureHandle), [Chaos::FReal](API\Runtime\ChaosCore\Chaos\FReal), 3 > * GetSpacialAcceleration() const


code: bool IsCompletionEventComplete() const


code: virtual float OnStartFrame ( float InDeltaTime )


code: virtual void OnSyncBodies ( [Chaos::FPhysicsSolverBase](API\Runtime\Chaos\Chaos\Framework\FPhysicsSolverBase) * Solver )


code: void RemoveActorFromAccelerationStructure ( FPhysicsActorHandle Actor )


code: void RemoveActorFromAccelerationStructureImp ( [Chaos::FGeometryParticle](API\Runtime\Chaos\Chaos\FGeometryParticle) * Particle )


code: void SetNetworkDeltaTimeScale ( float InDeltaTimeScale )


code: void SetUpForFrame ( const FVector * NewGrav, float InDeltaSeconds, float InMinPhysicsDeltaTime, float InMaxPhysicsDeltaTime, float InMaxSubstepDeltaTime, int32 InMaxSubsteps, bool bSubstepping )


code: void UpdateActorInAccelerationStructure ( const FPhysicsActorHandle & Actor )


code: void UpdateActorsInAccelerationStructure ( const [TArrayView](API\Runtime\Core\Containers\TArrayView)< FPhysicsActorHandle > & Actors )


code: FChaosScene ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * OwnerPtr, [Chaos::FReal](API\Runtime\ChaosCore\Chaos\FReal) InAsyncDt )


className: FChaosScene

description: Low level Chaos scene used when building custom simulations that don't exist in the main world physics scene.

code: class FChaosScene

ChaosModule

type: FChaosSolversMo...

description: Control module for Chaos - cached to avoid constantly hitting the module manager.

MDeltaTime

type: float

OnPhysScenePostTick

type: FOnPhysScenePos...

Owner

type: UObject*

PieModifiedObjects

type: TArray<TObject...

description: List of objects that we modified during a PIE run for physics simulation caching.

SceneSolver

description: Solver representing this scene.


className: FChaosSceneCallbackInput

code: struct FChaosSceneCallbackInput : public [Chaos::FSimCallbackInput](API\Runtime\Chaos\Chaos\FSimCallbackInput)


description: Called before simulation step

code: virtual void OnPreSimulate_Internal()


description: Get a stat name to describe this callback in external profiling and STATS when Named events are enabled

code: virtual [FName](API\Runtime\Core\UObject\FName) GetFNameForStatId() const


className: FChaosSceneSimCallback

code: struct FChaosSceneSimCallback : public [Chaos::TSimCallbackObject< FChaosSceneCallbackInput >](API\Runtime\Chaos\Chaos\TSimCallbackObject)


className: FInlineShapeArray

description: Array that is intended for use when fetching shapes from a rigid body.

code: typedef [TArray](API\Runtime\Core\Containers\TArray)< FPhysicsShapeHandle, TInlineAllocator< [NumInlinedPxShapeElements](API\Runtime\PhysicsCore\Chaos\PhysicsInterfaceTypes) > > FInlineShapeArray


code: class FPhysicsAggregateReference_Chaos


code: const [Chaos::FConstraintBase](API\Runtime\Chaos\Chaos\FConstraintBase) * operator->() const


code: class FPhysicsConstraintReference_Chaos


code: const Chaos::FCapsule & GetCapsuleGeometry() const


code: const Chaos::TBox< [Chaos::FReal](API\Runtime\ChaosCore\Chaos\FReal), 3 > & GetBoxGeometry() const


code: const [Chaos::FConvex](API\Runtime\Chaos\Chaos\FConvex) & GetConvexGeometry() const


code: const [Chaos::FImplicitObject](API\Runtime\Chaos\Chaos\FImplicitObject) & GetGeometry() const


code: const [Chaos::TSphere](API\Runtime\Chaos\Chaos\TSphere)< [Chaos::FReal](API\Runtime\ChaosCore\Chaos\FReal), 3 > & GetSphereGeometry() const


code: const [Chaos::FTriangleMeshImplicitObject](API\Runtime\Chaos\Chaos\FTriangleMeshImplicitObject) & GetTriMeshGeometry() const


code: ECollisionShapeType GetType() const


code: [FPhysicsGeometryCollection_Chaos](API\Runtime\PhysicsCore\Chaos\FPhysicsGeometryCollection_Chaos) & operator= ( const [FPhysicsGeometryCollection_Chaos](API\Runtime\PhysicsCore\Chaos\FPhysicsGeometryCollection_Chaos) & Copy )


code: [FPhysicsGeometryCollection_Chaos](API\Runtime\PhysicsCore\Chaos\FPhysicsGeometryCollection_Chaos) & operator= ( [FPhysicsGeometryCollection_Chaos](API\Runtime\PhysicsCore\Chaos\FPhysicsGeometryCollection_Chaos) && Steal )


description: Delete default constructor, want only construction by interface (private constructor below)


description: No copying or assignment, move construction only, these are defaulted in the source file as they need to be able to delete physx::PxGeometryHolder which is incomplete here

code: FPhysicsGeometryCollection_Chaos ( const [FPhysicsGeometryCollection_Chaos](API\Runtime\PhysicsCore\Chaos\FPhysicsGeometryCollection_Chaos) & Copy )


code: FPhysicsGeometryCollection_Chaos ( [FPhysicsGeometryCollection_Chaos](API\Runtime\PhysicsCore\Chaos\FPhysicsGeometryCollection_Chaos) && Steal )


code: FPhysicsGeometryCollection_Chaos &40; const FPhysicsShapeReference_Chaos & InShape &41;


code: FPhysicsGeometryCollection_Chaos &40; const FPhysicsGeometry & InGeom &41;


description: Wrapper around geometry. This is really just needed to make the physx chaos abstraction easier

code: struct FPhysicsGeometryCollection_Chaos


code: const FPhysicsGeometry & GetGeometry() const


code: const FQuat & GetGeomOrientation() const


code: FTransform GetGeomPose ( const FVector & Pos ) const


code: FPhysicsShapeAdapter_Chaos ( const FQuat & Rot, const [FCollisionShape](API\Runtime\PhysicsCore\FCollisionShape) & CollisionShape )


code: class FPhysicsShapeAdapter_Chaos


code: bool Equals ( const [FPhysicsShapeReference_Chaos](API\Runtime\PhysicsCore\Chaos\FPhysicsShapeReference_Chaos) & Other ) const


code: const [Chaos::FImplicitObject](API\Runtime\Chaos\Chaos\FImplicitObject) & GetGeometry() const


code: bool operator== ( const [FPhysicsShapeReference_Chaos](API\Runtime\PhysicsCore\Chaos\FPhysicsShapeReference_Chaos) & Other ) const


code: FPhysicsShapeReference_Chaos ( [Chaos::FPerShapeData](API\Runtime\Chaos\Chaos\FPerShapeData) * ShapeIn, const FPhysicsActorHandle & ActorRefIn )


code: class FPhysicsShapeReference_Chaos

ActorRef

type: FPhysicsActorHa...


className: PhysicsInterfaceTypes::

description: Default number of inlined elements used in FInlineShapeArray. Increase if for instance character meshes use more than this number of physics bodies and are involved in many queries.

code: namespace PhysicsInterfaceTypes { enum { NumInlinedPxShapeElements = 32, } }


code: namespace PhysicsInterfaceTypes { enum EDriveType { X, Y, Z, Swing, Twist, Slerp, } }


code: namespace PhysicsInterfaceTypes { enum ELimitAxis { X, Y, Z, Twist, Swing1, Swing2, } }


description: Update the values inMat_ to reflect the values in thisUObject_.

code: void CopyTo ( [Chaos::FChaosPhysicsMaterial](API\Runtime\Chaos\Chaos\FChaosPhysicsMaterial) & Mat ) const


code: UChaosPhysicalMaterial ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


className: UChaosPhysicalMaterial

description: Physical materials are used to define the response of a physical object when interacting dynamically with the world.

code: class UChaosPhysicalMaterial : public [UObject](API\Runtime\CoreUObject\UObject\UObject)

AngularEtherDrag

description: Uniform angular ether drag, the resistance a body experiences to its rotation.

Friction

description: Surface properties.Friction value of a surface in motion, controls how easily things can slide on this surface (0 is frictionless, higher values increase the amount of friction)

LinearEtherDrag

description: Uniform linear ether drag, the resistance a body experiences to its translation.

Restitution

description: Restitution or 'bounciness' of this surface, between 0 (no bounce) and 1 (outgoing velocity is same as incoming).

SleepingAngularVelocityThreshold

description: How much to scale the damage threshold by on any destructible we are applied to

StaticFriction

description: Friction value of surface at rest, controls how easily things can slide on this surface (0 is frictionless, higher values increase the amount of friction)


className: InternalType

code: typedef storagetype InternalType


code: bool isSet ( enumtype e ) const


code: [ChaosFlags](API\Runtime\PhysicsCore\ChaosFlags)< enumtype, storagetype > operator~() const


className: ChaosFlags::operator bool

code: operator bool() const


className: ChaosFlags::operator uint16_t

code: operator uint16_t() const


className: ChaosFlags::operator uint32_t

code: operator uint32_t() const


className: ChaosFlags::operator uint8_t

code: operator uint8_t() const


code: [ChaosFlags](API\Runtime\PhysicsCore\ChaosFlags)< enumtype, storagetype > & operator= ( const [ChaosFlags](API\Runtime\PhysicsCore\ChaosFlags)< enumtype, storagetype > & f )


code: [ChaosFlags](API\Runtime\PhysicsCore\ChaosFlags)< enumtype, storagetype > & operator= ( enumtype e )


code: [ChaosFlags](API\Runtime\PhysicsCore\ChaosFlags)< enumtype, storagetype > operator& ( enumtype e ) const


code: [ChaosFlags](API\Runtime\PhysicsCore\ChaosFlags)< enumtype, storagetype > operator& ( const [ChaosFlags](API\Runtime\PhysicsCore\ChaosFlags)< enumtype, storagetype > & f ) const


code: [ChaosFlags](API\Runtime\PhysicsCore\ChaosFlags)< enumtype, storagetype > & operator&= ( enumtype e )


code: [ChaosFlags](API\Runtime\PhysicsCore\ChaosFlags)< enumtype, storagetype > & operator&= ( const [ChaosFlags](API\Runtime\PhysicsCore\ChaosFlags)< enumtype, storagetype > & f )