description:
Does the calling thread have ownership of the system-wide critical section?
True if the system-wide lock is obtained. WARNING: Returns true for abandoned locks so shared resources can be in undetermined states.

code: bool IsValid() const


description: Releases system-wide critical section if it is currently owned

module: Core

code: void Release()


code: FUnixSystemWideCriticalSection &40; const FUnixSystemWideCriticalSection & &41;


description: Construct a named, system-wide critical section and attempt to get access/ownership of it

code: FUnixSystemWideCriticalSection ( const [FString](API\Runtime\Core\Containers\FString) & InName, [FTimespan](API\Runtime\Core\Misc\FTimespan) InTimeout )


description: Destructor releases system-wide critical section if it is currently owned

code: ~FUnixSystemWideCriticalSection()


className: FUnixSystemWideCriticalSection

description: Unix implementation of the FSystemWideCriticalSection. Uses exclusive file locking.

code: class FUnixSystemWideCriticalSection


code: static void AutoUpdateGameThreadCPUTime ( double UpdateInterval )


className: CalibrationLog

description: Log information about calibrating the clock.

code: static char CalibrationLog = {0};


className: ClockSource

description: Clock source to use

code: static int ClockSource = -1;


description: Calibration log to be printed at later time

code: static void PrintCalibrationLog()


code: static bool UpdateCPUTime ( float DeltaSeconds )


code: static bool UpdateThreadCPUTime ( float )


description: Allocates a thread local store slot

code: static uint32 AllocTlsSlot()


className: FUnixTime

description: Unix implementation of the Time OS functions

code: struct FUnixTime : public [FGenericPlatformTime](API\Runtime\Core\GenericPlatform\FGenericPlatformTime)


description: Frees a previously allocated TLS slot

code: static void FreeTlsSlot ( uint32 SlotIndex )


description:
Reads the value stored at the specified TLS slot
the value stored in the slot

code: static void * GetTlsValue ( uint32 SlotIndex )


description: Returns the currently executing thread's id

code: static uint32 GetCurrentThreadId()


description: Sets a value in the specified TLS slot

code: static void SetTlsValue ( uint32 SlotIndex, void * Value )


className: ThreadIdTLSKey

description: TLS key to store TID

code: static uint32 ThreadIdTLSKey = FUnixTLS::AllocTlsSlot();


className: FUnixTLS

description: Unix implementation of the TLS OS functions

code: struct FUnixTLS : public [FGenericPlatformTLS](API\Runtime\Core\GenericPlatform\FGenericPlatformTLS)


className: tagRECT

description: IWYU pragma: begin_exports.

code: struct tagRECT


className: Type

code: enum Type { BeforeCustomVersionWasAdded, LinkTimeAnimBlueprintRootDiscovery, StoreMarkerNamesOnSkeleton, SerializeRigVMRegisterArrayState, IncreaseBoneIndexLimitPerChunk, UnlimitedBoneInfluences, AnimSequenceCurveColors, NotifyAndSyncMarkerGuids, SerializeRigVMRegisterDynamicState, SerializeGroomCards, SerializeRigVMEntries, SerializeHairBindingAsset, SerializeHairClusterCullingData, SerializeGroomCardsAndMeshes, GroomLODStripping, GroomBindingSerialization, VersionPlusOne, LatestVersion = VersionPlusOne - 1, }


className: GUID

description: The GUID for this custom version number.

code: static const [FGuid](API\Runtime\Core\Misc\FGuid) GUID;


className: FAnimObjectVersion

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

code: struct FAnimObjectVersion


code: enum Type { BeforeCustomVersionWasAdded, ConvertAnimNodeLookAtAxis, BoxSphylElemsUseRotators, ThumbnailSceneInfoAndAssetImportDataAreTransactional, AddedClothingMaskWorkflow, RemoveUIDFromSmartNameSerialize, CreateTargetReference, TuneSoftLimitStiffnessAndDamping, FixInvalidClothParticleMasses, CacheClothMeshInfluences, SmartNameRefactorForDeterministicCooking, RenameDisableAnimCurvesToAllowAnimCurveEvaluation, AddLODToCurveMetaData, FixupBadBlendProfileReferences, AllowMultipleAudioPluginSettings, ChangeRetargetSourceReferenceToSoftObjectPtr, SaveEditorOnlyFullPoseForPoseAsset, GeometryCacheAssetDeprecation, VersionPlusOne, LatestVersion = VersionPlusOne - 1, }


className: FAnimPhysObjectVersion

code: struct FAnimPhysObjectVersion


code: enum Type { BeforeCustomVersionWasAdded = 0, DefaultToScreenshotCameraCutAndFixedTonemapping, VersionPlusOne, LatestVersion = VersionPlusOne - 1, }


className: FAutomationObjectVersion

code: struct FAutomationObjectVersion


code: enum Type { BeforeCustomVersionWasAdded = 0, OverridenEventReferenceFixup, CleanBlueprintFunctionFlags, ArrayGetByRefUpgrade, EdGraphPinOptimized, AllowDeletionConformed, AdvancedContainerSupport, SCSHasComponentTemplateClass, ComponentTemplateClassSupport, ArrayGetFuncsReplacedByCustomNode, DisallowObjectConfigVars, VersionPlusOne, LatestVersion = VersionPlusOne - 1, }


className: FBlueprintsObjectVersion

code: struct FBlueprintsObjectVersion


className: ThreadStackUserData

description: Passed in through sigqueue for gathering of a callstack from a signal

code: struct ThreadStackUserData

type: union ThreadSta...

BackTrace

type: uint64 *

bCaptureCallStack

type: bool

description: If we want a backtrace or a callstack Backtrace is just a list of program counters and callstack is a symbolicated backtrace

bDone

type: TAtomic< bool >

CallStack

type: ANSICHAR *


code: enum Type { BeforeCustomVersionWasAdded = 0, VersionPlusOne, LatestVersion = VersionPlusOne - 1, }


className: FBuildObjectVersion

code: struct FBuildObjectVersion


code: enum Type { BeforeCustomVersionWasAdded, ChangeDefaultFilmbackToDigitalFilm, VersionPlusOne, LatestVersion = VersionPlusOne - 1, }


className: FCineCameraObjectVersion

code: struct FCineCameraObjectVersion


code: enum Type { BeforeCustomVersionWasAdded = 0, MaterialInputNativeSerialize, EnumProperties, SkeletalMaterialEditorDataStripping, FProperties, VersionPlusOne, LatestVersion = VersionPlusOne - 1, }


className: FCoreObjectVersion

code: struct FCoreObjectVersion


code: enum Type { BeforeCustomVersionWasAdded = 0, AddedTimestampedGeometryComponentCache, AddedCacheDataReduction, GeometryCollectionInDDC, GeometryCollectionInDDCAndAsset, ChaosArchiveAdded, FieldsAdded, DensityUnitsChanged, BulkSerializeArrays, GroupAndAttributeNameRemapping, ImplicitObjectDoCollideAttribute, VersionPlusOne, LatestVersion = VersionPlusOne - 1, }


className: FDestructionObjectVersion

code: struct FDestructionObjectVersion


code: FDevSystemGuidRegistration ( const [TMap](API\Runtime\Core\Containers\TMap)< [FGuid](API\Runtime\Core\Misc\FGuid), [FGuid](API\Runtime\Core\Misc\FGuid) > & SystemGuids )


className: FDevSystemGuidRegistration

code: struct FDevSystemGuidRegistration


code: static const [FDevSystemGuids](API\Runtime\Core\UObject\FDevSystemGuids) & Get()


code: static [FGuid](API\Runtime\Core\Misc\FGuid) GetSystemGuid ( [FGuid](API\Runtime\Core\Misc\FGuid) System )


className: FDevSystemGuids

code: struct FDevSystemGuids

type: constFGuid


description: Dumps all registered versions to log

code: static void DumpVersionsToLog()


className: FDevVersionRegistration

code: class FDevVersionRegistration : public [FCustomVersionRegistration](API\Runtime\Core\Serialization\FCustomVersionRegistration)


code: template<int N> FDevVersionRegistration ( [FGuid](API\Runtime\Core\Misc\FGuid) InKey, int32 Version, const TCHAR(&) InFriendlyName, CustomVersionValidatorFunc InValidatorFunc )


className: DifferentIdsFlag

code: static constexpr uint32 DifferentIdsFlag = 1u << 31;


className: DisplayIdMask

code: static constexpr uint32 DisplayIdMask = ~DifferentIdsFlag;


code: void SetLoadedComparisonId ( [FNameEntryId](API\Runtime\Core\UObject\FNameEntryId) ComparisonId )


code: void SetLoadedDifferentDisplayId ( [FNameEntryId](API\Runtime\Core\UObject\FNameEntryId) DisplayId )


code: [FName](API\Runtime\Core\UObject\FName) ToName ( uint32 Number ) const


code: FDisplayNameEntryId ( [FName](API\Runtime\Core\UObject\FName) Name )


code: static [FDisplayNameEntryId](API\Runtime\Core\UObject\FDisplayNameEntryId) FromComparisonId ( [FNameEntryId](API\Runtime\Core\UObject\FNameEntryId) ComparisonId )


code: FDisplayNameEntryId &40; FNameEntryId Id, FNameEntryId CmpId &41;


className: FDisplayNameEntryId

description: Note that only display entries should be saved to make output deterministic.

code: class FDisplayNameEntryId


code: static const [FGuid](API\Runtime\Core\Misc\FGuid) GUID;


className: Type

code: enum Type { BeforeCustomVersionWasAdded = 0, GatheredTextProcessVersionFlagging, GatheredTextPackageCacheFixesV1, RootMetaDataSupport, GatheredTextPackageCacheFixesV2, TextFormatArgumentDataIsVariant, SplineComponentCurvesInStruct, ComboBoxControllerSupportUpdate, RefactorMeshEditorMaterials, AddedFontFaceAssets, UPropertryForMeshSection, WidgetGraphSchema, AddedBackgroundBlurContentSlot, StableUserDefinedEnumDisplayNames, AddedInlineFontFaceAssets, UPropertryForMeshSectionSerialize, FastWidgetTemplates, MaterialThumbnailRenderingChanges, NewSlateClippingSystem, MovieSceneMetaDataSerialization, GatheredTextEditorOnlyPackageLocId, AddedAlwaysSignNumberFormattingOption, AddedMaterialSharedInputs, AddedMorphTargetSectionIndices, SerializeInstancedStaticMeshRenderData, MeshDescriptionNewSerialization_MovedToRelease, MeshDescriptionNewAttributeFormat, ChangeSceneCaptureRootComponent, StaticMeshDeprecatedRawMesh, MeshDescriptionBulkDataGuid, MeshDescriptionRemovedHoles, ChangedWidgetComponentWindowVisibilityDefault, CultureInvariantTextSerializationKeyStability, ScrollBarThicknessChange, RemoveLandscapeHoleMaterial, MeshDescriptionTriangles, ComputeWeightedNormals, SkeletalMeshBuildRefactor, SkeletalMeshMoveEditorSourceDataToPrivateAsset, NumberParsingOptionsNumberLimitsAndClamping, SkeletalMeshSourceDataSupport16bitOfMaterialNumber, VersionPlusOne, LatestVersion = VersionPlusOne - 1, }


className: FEditorObjectVersion

code: struct FEditorObjectVersion


code: enum Type { BeforeCustomVersionWasAdded = 0, FixSerializationOfBulkAndExtraData, BookmarkExtensibilityUpgrade, MediaFrameworkUserDataLazyObject, LiveLinkTimeSynchronization, AjaMediaConfiguration, HasUDataprepRecipe, HasUDatatprepAssetInterface, MeshDescriptionBulkDataGuidIsHash, LiveLinkControllerSplitPerRole, CoreTechParametricSurfaceOptim, VersionPlusOne, LatestVersion = VersionPlusOne - 1, }


className: FEnterpriseObjectVersion

description: Custom serialization version for changes made in Dev-Enterprise stream

code: struct FEnterpriseObjectVersion


code: enum Type { BeforeCustomVersionWasAdded = 0, RemovedConvexHullsFromTriangleMeshImplicitObject, SerializeParticleBounds, SerializeEvolutionBV, SerializeEvolutionGenericAcceleration, GlobalElementsHaveBounds, SpatialIdxSerialized, HeightfieldData, SerializeMultiStructures, KinematicTargets, TrimeshSerializesBV, SerializeBroadphaseType, ScaledGeometryIsConcrete, TrimeshSerializesAABBTree, SerializeHashResult, FlushEvolutionInternalAccelerationQueue, SerializeShapeWorldSpaceBounds, AddDynamicKinematicSOA, AddedMaterialManager, AddTrimeshMaterialIndices, AddConvexCenterOfMassAndVolume, KinematicCentersOfMass, AddShapeCollisionDisable, HeightfieldImplicitBounds, AddDampingToRigids, TBoxReplacedWithTAABB, SerializePerShapeDataSimulateFlag, ImmutableAABBTree, TrimeshCanUseSmallIndices, UnionObjectsCanAvoidHierarchy, CapsulesNoUnionOrAABBs, ConvexUsesTPlaneConcrete, HeightfieldUsesHeightsDirectly, TriangleMeshHasFaceIndexMap, UniquePayloadIdx, SerializeCollisionTraceType, ForceRebuildBodySetupIndices, PhysicsMaterialSleepCounterThreshold, AddShapeSimAndQueryCollisionEnabled, RemoveShapeSimAndQueryDuplicateRepresentations, RemovedAABBTreeFullBounds, AddOneWayInteraction, VersionPlusOne, LatestVersion = VersionPlusOne - 1, }


className: FExternalPhysicsCustomObjectVersion


code: enum Type { BeforeCustomVersionWasAdded = 0, AddedMaterialMasks, VersionPlusOne, LatestVersion = VersionPlusOne - 1, }


code: enum Type { BeforeCustomVersionWasAdded = 0, WorldCompositionTile3DOffset, MaterialInstanceSerializeOptimization_ShaderFName, CullDistanceRefactor_RemovedDefaultDistance, CullDistanceRefactor_NeverCullHLODsByDefault, CullDistanceRefactor_NeverCullALODActorsByDefault, SaveGeneratedMorphTargetByEngine, ConvertReductionSettingOptions, StaticParameterTerrainLayerWeightBlendType, FixUpNoneNameAnimationCurves, EnsureActiveBoneIndicesToContainParents, SerializeInstancedStaticMeshRenderData, CachedMaterialQualityNodeUsage, FontOutlineDropShadowFixup, NewSkeletalMeshImporterWorkflow, NewLandscapeMaterialPerLOD, RemoveUnnecessaryTracksFromPose, FoliageLazyObjPtrToSoftObjPtr, REVERTED_StoreTimelineNamesInTemplate, AddBakePoseOverrideForSkeletalMeshReductionSetting, StoreTimelineNamesInTemplate, WidgetStopDuplicatingAnimations, AllowSkeletalMeshToReduceTheBaseLOD, ShrinkCurveTableSize, WidgetAnimationDefaultToSelfFail, FortHUDElementNowRequiresTag, FortMappedCookedAnimation, SupportVirtualBoneInRetargeting, FixUpWaterMetadata, MoveWaterMetadataToActor, ReplaceLakeCollision, AnimLayerGuidConformation, MakeOceanCollisionTransient, FFieldPathOwnerSerialization, FixUpUnderwaterPostProcessMaterial, SupportMultipleWaterBodiesPerExclusionVolume, RigVMByteCodeDeterminism, LandscapePhysicalMaterialRenderData, FixupRuntimeVirtualTextureVolume, FixUpRiverCollisionComponents, FixDuplicateRiverSplineMeshCollisionComponents, ContainsStableActorGUIDs, LevelsetSerializationSupportForBodySetup, ChaosSolverPropertiesMoved, GameFeatureData_MovedComponentListAndCheats, ChaosClothAddfictitiousforces, ChaosConvexVariableStructureDataAndVerticesArray, RemoveLandscapeWaterInfo, ChaosClothAddWeightedValue, ChaosClothAddTetherStiffnessWeightMap, ChaosClothFixLODTransitionMaps, ChaosClothAddTetherScaleAndDragLiftWeightMaps, ChaosClothAddMaterialWeightMaps, SerializeFloatChannelShowCurve, LandscapeGrassSingleArray, AddedSubSequenceEntryWarpCounter, WaterBodyComponentRefactor, BPGCCookedEditorTags, TerrainLayerWeightsAreNotParameters, GravityOverrideDefinedInWorldSpace, AnimDynamicsEditableChainParameters, WaterZonesRefactor, ChaosClothFasterDamping, MigratedFunctionHandlersToDefaults, ChaosInertiaConvertedToVec3, MigratedEventDefinitionToDefaults, LevelInstanceActorGuidSerialize, SingleFrameAndKeyAnimModel, RemappedEvaluateWorldPositionOffsetInRayTracing, WaterBodyComponentCollisionSettingsRefactor, WidgetInheritedNamedSlots, WaterHLODSupportAdded, PoseWatchMigrateSkeletonDrawParametersToPoseElement, WaterExclusionVolumeExcludeAllDefault, WaterNontessellatedLODSupportAdded, HierarchicalSimplificationMethodEnumAdded, WorldPartitionStreamingCellsNamingShortened, WorldPartitionActorDescSerializeContentBundleGuid, WorldPartitionActorDescSerializeActorIsRuntimeOnly, NaniteMaterialOverride, WorldPartitionHLODActorDescSerializeStats, WorldPartitionStreamingSourceComponentTargetDeprecation, FixedLocalizationGatherForExternalActorPackage, WorldPartitionHLODActorUseSourceCellGuid, ChaosGeometryCollectionInternalFacesAttribute, DynamicCastNodesUsePureStateEnum, WorldPartitionActorFilter, AudioAttenuationNonSpatializedRadiusBlend, WorldPartitionActorClassDescSerialize, WorldPartitionFActorContainerIDu64ToGuid, WorldPartitionPrivateDataLayers, ChaosImplicitObjectUnionBVHRefactor, LevelInstanceActorDescDeltaSerializeFilter, FixNaniteLandscapeMeshDDCKey, ChaosGeometryCollectionConnectionEdgeGroup, WaterBodyStaticMeshComponents, WorldPartitionActorDescSerializeInvalidBounds, NavigationLinkID32To64, WorldPartitionActorDescSerializeEditorOnlyReferences, WorldPartitionActorDescSerializeSoftObjectPathSupport, WorldPartitionClasDescGuidTransient, WorldPartitionActorDescIsMainWorldOnly, WorldPartitionActorFilterStringAssetPath, PackedLevelActorDesc, WorldPartitionRuntimeSpatialHashCVarOverrides, WorldPartitionHLODSourceActorsRefactor, WaterBodyStaticMeshRename, GeometryCollectionConvertVertexColorToSRGB, WaterOwningZonePointerFixup, WaterBodyStaticMeshDuplicateTransient, MVVMConvertPropertyPathToSkeletalClass, WaterBodyStaticMeshFixup, VersionPlusOne, LatestVersion = VersionPlusOne - 1, }


className: FFortniteMainBranchObjectVersion

code: struct FFortniteMainBranchObjectVersion


code: static [TMap](API\Runtime\Core\Containers\TMap)< [FGuid](API\Runtime\Core\Misc\FGuid), [FGuid](API\Runtime\Core\Misc\FGuid) > GetSystemGuids()


code: enum Type { BeforeCustomVersionWasAdded = 0, DisableLevelset_v14_10, ChaosClothAddTethersToCachedData, ChaosKinematicTargetRemoveScale, ActorComponentUCSModifiedPropertiesSparseStorage, FixupNaniteLandscapeMeshes, RemoveUselessLandscapeMeshesCookedCollisionData, SerializeAnimCurveCompressionCodecGuidOnCook, FixNaniteLandscapeMeshNames, LandscapeSharedPropertiesEnforcement, WorldPartitionRuntimeCellGuidWithCellSize, NaniteMaterialOverrideUsesEditorOnly, VersionPlusOne, LatestVersion = VersionPlusOne - 1, }


code: enum Type { BeforeCustomVersionWasAdded = 0, AddedWorldDataLayersActorDesc, FixedDataLayerInstanceDesc, WorldPartitionActorDescSerializeDataLayerAssets, RemappedEvaluateWorldPositionOffsetInRayTracing, WorldPartitionActorDescNativeBaseClassSerialization, WorldPartitionActorDescTagsSerialization, WorldPartitionActorDescPropertyMapSerialization, AddShapeIsProbe, PhysicsAssetNewSolverSettings, ChaosGeometryCollectionSaveLevelsAttribute, VersionPlusOne, LatestVersion = VersionPlusOne - 1, }


className: FFortniteSeasonBranchObjectVersion


className: FFortniteShaderworkObjectVersion

code: struct FFortniteShaderworkObjectVersion


code: enum Type { BeforeCustomVersionWasAdded = 0, AtomPrimitiveNewSerialization, AtomDeprecatingRedundantColorStructs, VersionPlusOne, LatestVersion = VersionPlusOne - 1, }


code: enum Type { BeforeCustomVersionWasAdded = 0, UseBodySetupCollisionProfile, AnimBlueprintSubgraphFix, MeshSocketScaleUtilization, ExplicitAttachmentRules, MoveCompressedAnimDataToTheDDC, FixNonTransactionalPins, SmartNameRefactor, AddSourceReferenceSkeletonToRig, ConstraintInstanceBehaviorParameters, PoseAssetSupportPerBoneMask, PhysAssetUseSkeletalBodySetup, RemoveSoundWaveCompressionName, AddInternalClothingGraphicalSkinning, WheelOffsetIsFromWheel, MoveCurveTypesToSkeleton, CacheDestructibleOverlaps, GeometryCacheMissingMaterials, LODsUseResolutionIndependentScreenSize, BlendSpacePostLoadSnapToGrid, SupportBlendSpaceRateScale, LODHysteresisUseResolutionIndependentScreenSize, ChangeAudioComponentOverrideSubtitlePriorityDefault, HardSoundReferences, EnforceConstInAnimBlueprintFunctionGraphs, InputKeySelectorTextStyle, EdGraphPinContainerType, ChangeAssetPinsToString, LocalVariablesBlueprintVisible, RemoveUField_Next, UserDefinedStructsBlueprintVisible, PinsStoreFName, UserDefinedStructsStoreDefaultInstance, FunctionTerminatorNodesUseMemberReference, EditableEventsUseConstRefParameters, BlueprintGeneratedClassIsAlwaysAuthoritative, EnforceBlueprintFunctionVisibility, StoringUCSSerializationIndex, VersionPlusOne, LatestVersion = VersionPlusOne - 1, }


className: FFrameworkObjectVersion

code: struct FFrameworkObjectVersion


className: GUID


code: enum Type { BeforeCustomVersionWasAdded = 0, CompressGeometryCache, DynamicMeshVertexLayoutChange, ExplicitMotionVectors, VersionPlusOne, LatestVersion = VersionPlusOne - 1, }


className: FGeometryObjectVersion

code: struct FGeometryObjectVersion


className: FLazyName::operator FName

code: operator FName() const


className: FFortniteValkyrieBranchObjectVersion


code: template<int N> FLazyName ( const WIDECHAR(&) Literal )


code: template<int N> FLazyName ( const ANSICHAR(&) Literal )


code: FLazyName ( [FName](API\Runtime\Core\UObject\FName) Name )


className: FLazyName

description: Lazily constructedFNamethat helps avoid allocating FNames during static initialization

code: class FLazyName


code: enum Type { BeforeCustomVersionWasAdded = 0, UncompressedReflectionCapturesForCookedBuilds, VersionPlusOne, LatestVersion = VersionPlusOne - 1, }


className: FLoadTimesObjectVersion

code: struct FLoadTimesObjectVersion


code: enum Type { BeforeCustomVersionWasAdded = 0, SerializeGUIDsInMediaSourceInsteadOfPlainNames, SerializeGUIDsInPlatformMediaSourceInsteadOfPlainNames, VersionPlusOne, LatestVersion = VersionPlusOne - 1, }


className: FMediaFrameworkObjectVersion

code: struct FMediaFrameworkObjectVersion


code: bool operator== ( EName Name ) const


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


className: FMemoryImageName

description: Predictably sized structure for representing anFNamein memory images while allowing the size to be smaller thanFScriptNamewhen case-preserving behavior is not required.

code: struct FMemoryImageName

FName

type: friend


code: bool operator< ( [FMinimalName](API\Runtime\Core\UObject\FMinimalName) Rhs ) const


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


className: FMinimalName

description: The minimum amount of data required to reconstruct a name This is smaller thanFNamewhen WITH_CASE_PRESERVING_NAME is set, but you lose the case-preserving behavior. The size of this type is not portable across different platforms and configurations, as withFNameitself.

code: struct FMinimalName


code: static const [FGuid](API\Runtime\Core\Misc\FGuid) GUID;


className: Type

code: enum Type { BeforeCustomVersionWasAdded = 0, InstancedStaticMeshLightmapSerialization, LQVolumetricLightmapLayers, StoreReflectionCaptureCompressedMobile, VersionPlusOne, LatestVersion = VersionPlusOne - 1, }


className: FMobileObjectVersion

code: struct FMobileObjectVersion


description: Add/remove an exemption to the formatting applied by NameToDisplayString. Example: exempt the compound word "MetaHuman" to ensure its not reformatted as "Meta Human".

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


description: Converts anFNameto a readable format, in place, appending to an existing string (ala GetFullName)

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


code: void AppendString ( FWideStringBuilderBase & Out ) const


code: void AppendString ( FUtf8StringBuilderBase & Out ) const


code: template<typename StringBuilderType> void AppendStringInternal ( StringBuilderType & Out ) const


code: template<typename StringBufferType> void AppendStringInternal &40; StringBufferType & Out &41; const


description: Run autotest on FNames.

code: static void AutoTest()


code: int32 CompareIndexes ( const [FName](API\Runtime\Core\UObject\FName) & Other ) const


code: int32 Compare ( const [FName](API\Runtime\Core\UObject\FName) & Other ) const


description: Only call this if youreallyknow what you're doing

code: static [FName](API\Runtime\Core\UObject\FName) CreateFromDisplayId ( [FNameEntryId](API\Runtime\Core\UObject\FNameEntryId) DisplayId, int32 Number )


code: static [TArray](API\Runtime\Core\Containers\TArray)< const [FNameEntry](API\Runtime\Core\UObject\FNameEntry) * > DebugDump()


code: static void DisplayHash ( class [FOutputDevice](API\Runtime\Core\Misc\FOutputDevice) & Ar )


description: Fast non-alphabetical order that is only stable during this process' lifetime.

code: bool FastLess ( const [FName](API\Runtime\Core\UObject\FName) & Other ) const


code: static [FNameEntryId](API\Runtime\Core\UObject\FNameEntryId) GetComparisonIdFromDisplayId ( [FNameEntryId](API\Runtime\Core\UObject\FNameEntryId) DisplayId )


code: const [FNameEntry](API\Runtime\Core\UObject\FNameEntry) * GetComparisonNameEntry() const


code: static [FNameEntry](API\Runtime\Core\UObject\FNameEntry) const * GetEntry ( EName Ename )


code: static [FNameEntry](API\Runtime\Core\UObject\FNameEntry) const * GetEntry ( [FNameEntryId](API\Runtime\Core\UObject\FNameEntryId) Id )


code: const [FNameEntry](API\Runtime\Core\UObject\FNameEntry) * GetDisplayNameEntry() const


description: Size of all name entries.

code: static int32 GetNameEntryMemorySize()


description: Size of Name Table object as a whole

code: static int32 GetNameTableMemorySize()


description: number of ansi names in name table

code: static int32 GetNumAnsiNames()


description: number of wide names in name table

code: static int32 GetNumWideNames()


description: Copy ANSI name without number part. Mustonlybe used for ANSI FNames. Doesn't allocate.

code: void GetPlainANSIString ( ANSICHAR(&) AnsiName ) const


description: Copy wide name without number part. Mustonlybe used for wide FNames. Doesn't allocate.

code: void GetPlainWIDEString ( WIDECHAR(&) WideName ) const


description: Convert name without number part into TCHAR buffer and returns string length. Doesn't allocate.

code: uint32 GetPlainNameString ( TCHAR(&) OutName ) const


description: Get the number of characters, excluding null-terminator, thatToString()would yield

code: uint32 GetStringLength() const


description: All FNames are valid except for stomped memory, dangling pointers, etc. Should only be used to investigate such bugs and not in production code.

code: bool IsValid() const


description: Check to see if thisFNamematches the otherFName, potentially also checking for any case variations

code: bool IsEqual ( const [FName](API\Runtime\Core\UObject\FName) & Other, const ENameCase CompareMethod, const bool bCompareNumber ) const


description: True forFName(),FName(NAME_None)andFName("None")

code: bool IsNone() const


description: Paranoid sanity check, same asIsValid()

code: bool IsValidIndexFast() const


description:
Takes anFNameand checks to see that it follows the rules that Unreal requires for package or group names.
true if the name is valid

code: bool IsValidGroupName ( [FText](API\Runtime\Core\Internationalization\FText) & OutReason, bool bIsGroupName ) const


description:
Takes anFNameand checks to see that it follows the rules that Unreal requires for object names.
true if the name is valid

code: bool IsValidObjectName ( [FText](API\Runtime\Core\Internationalization\FText) & OutReason ) const


description:
Takes anFNameand checks to see that it follows the rules that Unreal requires.
true if the name is valid

code: bool IsValidXName ( [FText](API\Runtime\Core\Internationalization\FText) & OutReason, const [FString](API\Runtime\Core\Containers\FString) & InInvalidChars ) const


description:
Checks to see that aFNamefollows the rules that Unreal requires.
true if the name is valid

code: bool IsValidXName ( const [FString](API\Runtime\Core\Containers\FString) & InInvalidChars, [FText](API\Runtime\Core\Internationalization\FText) * OutReason, const [FText](API\Runtime\Core\Internationalization\FText) * InErrorCtx ) const


description:
Checks to see that a given name-like string follows the rules that Unreal requires.
true if the name is valid

code: static bool IsValidXName ( const [FName](API\Runtime\Core\UObject\FName) InName, const [FString](API\Runtime\Core\Containers\FString) & InInvalidChars, [FText](API\Runtime\Core\Internationalization\FText) * OutReason, const [FText](API\Runtime\Core\Internationalization\FText) * InErrorCtx )


code: static bool IsValidXName ( const TCHAR * InName, const [FString](API\Runtime\Core\Containers\FString) & InInvalidChars, [FText](API\Runtime\Core\Internationalization\FText) * OutReason, const [FText](API\Runtime\Core\Internationalization\FText) * InErrorCtx )


code: static bool IsValidXName ( const [FString](API\Runtime\Core\Containers\FString) & InName, const [FString](API\Runtime\Core\Containers\FString) & InInvalidChars, [FText](API\Runtime\Core\Internationalization\FText) * OutReason, const [FText](API\Runtime\Core\Internationalization\FText) * InErrorCtx )


description: Get name without number part as a dynamically allocated string


code: static bool IsValidXName ( const FStringView & InName, const [FString](API\Runtime\Core\Containers\FString) & InInvalidChars, [FText](API\Runtime\Core\Internationalization\FText) * OutReason, const [FText](API\Runtime\Core\Internationalization\FText) * InErrorCtx )


description: Slow alphabetical order that is stable / deterministic over process runs.

code: bool LexicalLess ( const [FName](API\Runtime\Core\UObject\FName) & Other ) const


description:
Takes a string and breaks it down into a human readable string. For example - "bCreateSomeStuff" becomes "Create Some Stuff?" and "DrawScale3D" becomes "Draw Scale 3D".
the sanitized version of the display name

code: static [FString](API\Runtime\Core\Containers\FString) NameToDisplayString ( const [FString](API\Runtime\Core\Containers\FString) & InDisplayName, const bool bIsBool )


code: bool operator== ( [FName](API\Runtime\Core\UObject\FName) Other ) const


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


code: static [FString](API\Runtime\Core\Containers\FString) SafeString ( [FNameEntryId](API\Runtime\Core\UObject\FNameEntryId) InDisplayIndex, int32 InstanceNumber )


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


description:
Printing FNames in logging or on screen can be problematic when they contain Whitespace characters such as
 and , so this will return anFNamebased upon the callingFName, but with any Whitespace characters potentially problematic for showing in a log or on screen omitted.
the newFNamebased upon the callingFName, but with any Whitespace characters potentially problematic for showing in a log or on screen omitted.

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


className: StringBufferSize

description: Buffer size required for any null-terminatedFNamestring, i.e. [name] '_' [digits] '\0'

code: static constexpr uint32 StringBufferSize = NAME_SIZE + 1 + 10;


code: void SetNumber ( const int32 NewNumber )


description: FNamemust not be used after teardown

code: static void TearDown()


description: Get the EName that thisFNamerepresents or nullptr

code: const EName * ToEName() const


description:
Converts anFNameto a readable format
String representation of the name


description: Converts anFNameto a readable format, in place

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


code: void ToString ( FWideStringBuilderBase & Out ) const


code: void ToString ( FUtf8StringBuilderBase & Out ) const


description: Note that a default constructedFNamereturns "None" instead of ""

code: uint32 ToString ( TCHAR * Out, uint32 OutSize ) const


description: Returns an integer that compares equal in the same way FNames do, only usable within the current process

code: uint64 ToUnstableInt() const


description:
Converts an ANSIFNameto a readable format appended to the string builder.
Whether the string is ANSI. A return of false indicates that the string was wide and was not written.

code: bool TryAppendAnsiString ( FAnsiStringBuilderBase & Out ) const


description: Default constructor, initialized to None

code: FName()


description: Create anFName. If FindType is FNAME_Find, and the name doesn't already exist, then the name will be NAME_None. The check for existance or not depends on UE_FNAME_OUTLINE_NUMBER. When UE_FNAME_OUTLINE_NUMBER is 0, we only check for the string part. When UE_FNAME_OUTLINE_NUMBER is 1, we check for whole name including the number.

code: FName ( const WIDECHAR * Name, EFindName FindType )


code: FName ( const ANSICHAR * Name, EFindName FindType )


code: FName ( const [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * Name, EFindName FindType )


code: template<int N> uint32 ToString ( TCHAR(&) Out ) const


code: FName ( [TStringView](API\Runtime\Core\Containers\TStringView)< ANSICHAR > View, EFindName FindType )


description: Create anFNamewith a hardcoded string index.

code: FName ( [TStringView](API\Runtime\Core\Containers\TStringView)< WIDECHAR > View, EFindName FindType )


code: FName ( [TStringView](API\Runtime\Core\Containers\TStringView)< [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) > View, EFindName FindType )


description: Create anFName. Will add the string to the name table if it does not exist. When UE_FNAME_OUTLINE_NUMBER is set, will also add the combination of base string and number to the name table if it doesn't exist.

code: FName ( const WIDECHAR * Name, int32 Number )


code: FName ( const ANSICHAR * Name, int32 Number )


code: FName ( const [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * Name, int32 Number )


code: FName ( [TStringView](API\Runtime\Core\Containers\TStringView)< ANSICHAR > View, int32 InNumber )


code: FName ( EName Ename )


code: FName ( [TStringView](API\Runtime\Core\Containers\TStringView)< WIDECHAR > View, int32 InNumber )


code: FName ( [TStringView](API\Runtime\Core\Containers\TStringView)< [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) > View, int32 InNumber )


description: Create anFNamefrom its component parts Only call this if youreallyknow what you're doing

code: FName ( [FNameEntryId](API\Runtime\Core\UObject\FNameEntryId) InComparisonIndex, [FNameEntryId](API\Runtime\Core\UObject\FNameEntryId) InDisplayIndex, int32 InNumber )


description: CreateFNamefrom non-null string with known length

code: FName ( int32 Len, const WIDECHAR * Name, EFindName FindType )


code: FName ( int32 Len, const ANSICHAR * Name, EFindName FindType )


code: FName ( int32 Len, const [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * Name, EFindName FindType )


code: FName ( int32 Len, const WIDECHAR * Name, int32 Number )


code: FName ( int32 Len, const ANSICHAR * Name, int32 Number )


code: FName ( int32 Len, const [UTF8CHAR](API\Runtime\Core\GenericPlatform\FGenericPlatformTypes\UTF8CHAR) * Name, int32 Number )


description: Create anFName. If FindType is FNAME_Find, and the string part of the name doesn't already exist, then the name will be NAME_None

code: FName ( const TCHAR * Name, int32 InNumber, bool bSplitName )


description: Scary no init constructor, used for something obscure inUObjectBase

code: FName ( ENoInit )


code: FName ( [FMinimalName](API\Runtime\Core\UObject\FMinimalName) InName )


code: FName ( [FScriptName](API\Runtime\Core\UObject\FScriptName) InName )


code: FName ( [FMemoryImageName](API\Runtime\Core\UObject\FMemoryImageName) InName )


description: Create anFNamewith a hardcoded string index and (instance).

code: FName ( EName Ename, int32 InNumber )


description: Create anFNamefrom an existing string, but with a different instance.

code: FName ( [FName](API\Runtime\Core\UObject\FName) Other, int32 InNumber )


description: Constructor used byFLinkerLoadwhen loading its name table; Creates anFNamewith an instance number of 0 that does not attempt to split theFNameinto string and number portions. Also, this version skips calculating the hashes of the names if possible

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


className: FName

description: Public name, available to the world. Names are stored as a combination of an index into a table of unique strings and an instance number. Names are case-insensitive, but case-preserving (when WITH_CASE_PRESERVING_NAME is 1)

code: class FName


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


className: FNameBuilder

description: A string builder with inline storage for FNames.

code: class FNameBuilder : public [TStringBuilderWithBuffer< FName::StringBufferSize >](API\Runtime\Core\Containers\TStringBuilderWithBuffer)


className: BlockBits

code: static constexpr uint32 BlockBits = 13;


className: EntryStride

code: static constexpr uint32 EntryStride = alignof(FNameEntry);


className: MaxLength

code: static constexpr uint32 MaxLength = NAME_SIZE;


className: OffsetBits

code: static constexpr uint32 OffsetBits = 16;


className: OffsetMask

code: static constexpr uint32 OffsetMask = (1 << OffsetBits) - 1;


className: UnusedMask

code: static constexpr uint32 UnusedMask = UINT32_MAX << BlockBits << OffsetBits;


className: FNameDebugVisualizer

code: struct FNameDebugVisualizer


description: Appends name to string builder. Entry must not be wide.

code: void AppendAnsiNameToString ( FAnsiStringBuilderBase & OutString ) const


description: Appends name to string with path separator usingFString::PathAppend().

code: void AppendNameToPathString ( [FString](API\Runtime\Core\Containers\FString) & OutString ) const


description: Appends name to string. May allocate.

code: void AppendNameToString ( [FString](API\Runtime\Core\Containers\FString) & OutString ) const


description: Appends name to string builder.

code: void AppendNameToString ( FWideStringBuilderBase & OutString ) const


description: Appends name to string. May allocate.

code: void AppendNameToString ( FUtf8StringBuilderBase & OutString ) const


code: void DebugDump ( [FOutputDevice](API\Runtime\Core\Misc\FOutputDevice) & Out ) const


description: Copy null-terminated name to ANSICHAR buffer without allocating. Entry must not be wide.

code: void GetAnsiName ( ANSICHAR(&) OutName ) const


description: Copy null-terminated name to TCHAR buffer without allocating.

code: void GetName ( TCHAR(&) OutName ) const


description: Copy name to a dynamically allocatedFString.


description:
Returns the size in bytes forFNameEntrystructure. This is != sizeof(FNameEntry) as we only allocated as needed.
required size ofFNameEntrystructure to hold this string (might be wide or ansi)

code: static int32 GetSize ( const TCHAR * Name )


code: static int32 GetSize ( int32 Length, bool bIsPureAnsi )


code: const ANSICHAR &42; GetUnterminatedName &40; ANSICHAR(&) OptionalDecodeBuffer &41; const


description: Copy unterminated name to TCHAR buffer without allocating.

code: const WIDECHAR &42; GetUnterminatedName &40; WIDECHAR(&) OptionalDecodeBuffer &41; const


code: void GetUnterminatedName ( TCHAR * OutName, uint32 OutSize ) const


description: Copy null-terminated name to WIDECHAR buffer without allocating. Entry must be wide.

code: void GetWideName ( WIDECHAR(&) OutName ) const


description: Returns whether this name entry is represented via WIDECHAR or ANSICHAR.

code: bool IsWide() const


code: FNameStringView MakeView ( union FNameBuffer & OptionalDecodeBuffer ) const


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


className: FNameEntry

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

code: struct FNameEntry

NumberedName

type: FNumberedData


className: FNameEntryHeader

description: Implementation detail exposed for debug visualizers

code: struct FNameEntryHeader

bIsWide

type: uint16:  1


description: Fast non-alphabetical order that is only stable during this process' lifetime

code: int32 CompareFast ( [FNameEntryId](API\Runtime\Core\UObject\FNameEntryId) Rhs ) const


description: Slow alphabetical order that is stable / deterministic over process runs

code: int32 CompareLexical ( [FNameEntryId](API\Runtime\Core\UObject\FNameEntryId) Rhs ) const


code: bool FastLess ( [FNameEntryId](API\Runtime\Core\UObject\FNameEntryId) Rhs ) const


code: static [FNameEntryId](API\Runtime\Core\UObject\FNameEntryId) FromEName ( EName Ename )


description: Create from unstable int produced by this process

code: static [FNameEntryId](API\Runtime\Core\UObject\FNameEntryId) FromUnstableInt ( uint32 UnstableInt )


code: bool LexicalLess ( [FNameEntryId](API\Runtime\Core\UObject\FNameEntryId) Rhs ) const


className: FNameEntryId::operator bool

description: Returns true if thisFNameEntryIdis not equivalent to NAME_None.

code: operator bool() const


code: bool operator== ( [FNameEntryId](API\Runtime\Core\UObject\FNameEntryId) Rhs ) const


code: bool operator> ( [FNameEntryId](API\Runtime\Core\UObject\FNameEntryId) Rhs ) const


code: bool operator< ( [FNameEntryId](API\Runtime\Core\UObject\FNameEntryId) Rhs ) const


code: bool operator!= ( [FNameEntryId](API\Runtime\Core\UObject\FNameEntryId) Rhs ) const


description: Get process specific integer

code: uint32 ToUnstableInt() const


description: Default initialize to be equal to NAME_None.

code: FNameEntryId()


className: FNameEntryId

description: Opaque id to a deduplicated name

code: struct FNameEntryId


description: Returns direct access to null-terminated name if narrow

code: ANSICHAR const * GetAnsiName() const


description: ReturnsFStringof name portion minus number.FStringof name portion minus number.


description: Returns direct access to null-terminated name if wide

code: WIDECHAR const * GetWideName() const


code: FNameEntrySerialized ( const [FNameEntry](API\Runtime\Core\UObject\FNameEntry) & NameEntry )


code: FNameEntrySerialized ( enum ELinkerNameTableConstructor )


className: FNameEntrySerialized

description: This struct is only used during loading/saving and is not part of the runtime costs

code: struct FNameEntrySerialized

type: union FNameEntr...

NonCasePreservingHash

description: These are not used anymore but recalculated on save to maintain serialization format.


code: bool operator() ( const [FName](API\Runtime\Core\UObject\FName) & A, const [FName](API\Runtime\Core\UObject\FName) & B ) const


code: bool operator() ( [FNameEntryId](API\Runtime\Core\UObject\FNameEntryId) A, [FNameEntryId](API\Runtime\Core\UObject\FNameEntryId) B ) const


className: FNameFastLess

code: struct FNameFastLess


className: FNameLexicalLess

code: struct FNameLexicalLess


className: GUID

description: The GUID for this custom version number.

code: static const [FGuid](API\Runtime\Core\Misc\FGuid) GUID;


className: Type

code: enum Type { BeforeCustomVersionWasAdded = 0, VersionPlusOne, LatestVersion = VersionPlusOne - 1, }


className: FNetworkingObjectVersion

code: struct FNetworkingObjectVersion


code: enum Type { BeforeCustomVersionWasAdded = 0, SkeletalMeshVertexSampling = 1, VersionPlusOne, LatestVersion = VersionPlusOne - 1, }


className: FNiagaraObjectVersion

code: struct FNiagaraObjectVersion


className: FOnlineObjectVersion

code: struct FOnlineObjectVersion


description: Creates and returns aFPackageFileVersionbased on a single EUnrealEngineObjectUEVersion and no other versions.

code: static [FPackageFileVersion](API\Runtime\Core\UObject\FPackageFileVersion) CreateUE4Version ( int32 Version )


code: static [FPackageFileVersion](API\Runtime\Core\UObject\FPackageFileVersion) CreateUE4Version ( EUnrealEngineObjectUE4Version Version )


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


description: Returns true if this object is compatible with theFPackageFileVersionpassed in as the parameter. This means that all version numbers for the current object are equal or greater than the corresponding version numbers of the other structure.

code: bool IsCompatible ( const [FPackageFileVersion](API\Runtime\Core\UObject\FPackageFileVersion) & Other ) const


description: FPackageFileVersioncomparisons

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


description: UE4 version comparisons

code: bool operator>= ( EUnrealEngineObjectUE4Version Version ) const


description: UE5 version comparisons

code: bool operator>= ( EUnrealEngineObjectUE5Version Version ) const


description: UE5 version comparisons

code: bool operator< ( EUnrealEngineObjectUE5Version Version ) const


description: UE4 version comparisons

code: bool operator< ( EUnrealEngineObjectUE4Version Version ) const


description: UE4 version comparisons

code: bool operator!= ( EUnrealEngineObjectUE4Version Version ) const


description: UE5 version comparisons

code: bool operator!= ( EUnrealEngineObjectUE5Version Version ) const


description: FPackageFileVersioncomparisons

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


description: Set all versions to the default state

code: void Reset()


description: Returns the highest valid version number which is considered to be the 'true' version number

code: int32 ToValue() const


code: FPackageFileVersion ( int32 UE4Version, EUnrealEngineObjectUE5Version UE5Version )


code: static const [FGuid](API\Runtime\Core\Misc\FGuid) GUID;


className: FPackageFileVersion

description: This object combines all of our version enums into a single easy to use structure which allows us to update older version numbers independently of the newer version numbers.

code: struct FPackageFileVersion

description: UE4 file version

description: UE5 file version


className: FPhysicsObjectVersion

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

code: struct FPhysicsObjectVersion


code: enum Type { BeforeCustomVersionWasAdded = 0, PerShapeData, SerializeGTGeometryParticles, GroomWithDescription, GroomWithImportSettings, TriangleMeshHasVertexIndexMap, VariableConvexStructureData, AddCCDEnableFlag, ChaosClothAddWeightedValue, ConvexUsesVerticesArray, ChaosClothAddfictitiousforces, ChaosClothAddTetherStiffnessWeightMap, ChaosClothFixLODTransitionMaps, ChaosConvexUsesHalfEdges, ChaosConvexHasUniqueEdgeSet, GeometryCollectionUserDefinedCollisionShapes, ChaosKinematicTargetRemoveScale, AddCollisionConstraintFlag, AddDisabledFlag, AddChaosMaxLinearAngularSpeed, GeometryCollectionConvexDefaults, VersionPlusOne, LatestVersion = VersionPlusOne - 1, }


code: enum Type { BeforeCustomVersionWasAdded = 0, VersionPlusOne, LatestVersion = VersionPlusOne - 1, }


className: FPlatformObjectVersion

code: struct FPlatformObjectVersion


code: namespace Freeze { void Freeze::ApplyMemoryImageNamePatch ( void * NameDst, const [FMemoryImageName](API\Runtime\Core\UObject\FMemoryImageName) & Name, const [FPlatformTypeLayoutParameters](API\Runtime\Core\Serialization\FPlatformTypeLayoutParameters) & LayoutParams ) }


code: namespace Freeze { uint32 Freeze::IntrinsicAppendHash ( const [FMemoryImageName](API\Runtime\Core\UObject\FMemoryImageName) * DummyObject, const [FTypeLayoutDesc](API\Runtime\Core\Serialization\FTypeLayoutDesc) & TypeDesc, const [FPlatformTypeLayoutParameters](API\Runtime\Core\Serialization\FPlatformTypeLayoutParameters) & LayoutParams, [FSHA1](API\Runtime\Core\Misc\FSHA1) & Hasher ) }


code: namespace Freeze { uint32 Freeze::IntrinsicUnfrozenCopy ( const [FMemoryUnfreezeContent](API\Runtime\Core\Serialization\FMemoryUnfreezeContent) & Context, const [FMemoryImageName](API\Runtime\Core\UObject\FMemoryImageName) & Object, void * OutDst ) }


code: namespace Freeze { void Freeze::IntrinsicWriteMemoryImage ( [FMemoryImageWriter](API\Runtime\Core\Serialization\FMemoryImageWriter) & Writer, const [FMemoryImageName](API\Runtime\Core\UObject\FMemoryImageName) & Object, const [FTypeLayoutDesc](API\Runtime\Core\Serialization\FTypeLayoutDesc) & ) }


code: namespace Freeze { void Freeze::IntrinsicWriteMemoryImage ( [FMemoryImageWriter](API\Runtime\Core\Serialization\FMemoryImageWriter) & Writer, const [FScriptName](API\Runtime\Core\UObject\FScriptName) & Object, const [FTypeLayoutDesc](API\Runtime\Core\Serialization\FTypeLayoutDesc) & ) }


code: enum Type { BeforeCustomVersionWasAdded = 0, MoveReflectionCaptureDataToMapBuildData, VersionPlusOne, LatestVersion = VersionPlusOne - 1, }


className: FReflectionCaptureObjectVersion

code: struct FReflectionCaptureObjectVersion


code: enum Type { BeforeCustomVersionWasAdded = 0, StaticMeshExtendedBoundsFix, NoSyncAsyncPhysAsset, LevelTransArrayConvertedToTArray, AddComponentNodeTemplateUniqueNames, UPropertryForMeshSectionSerialize, ConvertHLODScreenSize, SpeedTreeBillboardSectionInfoFixup, EventSectionParameterStringAssetRef, SkyLightRemoveMobileIrradianceMap, RenameNoTwistToAllowTwistInTwoBoneIK, MaterialLayersParameterSerializationRefactor, AddSkeletalMeshSectionDisable, RemovedMaterialSharedInputCollection, HISMCClusterTreeMigration, PinDefaultValuesVerified, FixBrokenStateMachineReferencesInTransitionGetters, MeshDescriptionNewSerialization, UnclampRGBColorCurves, LinkTimeAnimBlueprintRootDiscoveryBugFix, TrailNodeBlendVariableNameChange, PropertiesSerializeRepCondition, FocalDistanceDisablesDOF, Unused_SoundClass2DReverbSend, GroomAssetVersion1, GroomAssetVersion2, SerializeAnimModifierState, GroomAssetVersion3, DeprecateFilmbackSettings, CustomImplicitCollisionType, FFieldPathOwnerSerialization, MeshDescriptionNewFormat, PinTypeIncludesUObjectWrapperFlag, WeightFMeshToMeshVertData, AnimationGraphNodeBindingsDisplayedAsPins, SerializeRigVMOffsetSegmentPaths, AbcVelocitiesSupport, MarginAddedToConvexAndBox, StructureDataAddedToConvex, AddedFrontRightUpAxesToLiveLinkPreProcessor, FixupCopiedEventSections, RemoteControlSerializeFunctionArgumentsSize, AddedSubSequenceEntryWarpCounter, LonglatTextureCubeDefaultMaxResolution, GeometryCollectionCacheRemovesMassToLocal, VersionPlusOne, LatestVersion = VersionPlusOne - 1, }


className: FReleaseObjectVersion

code: struct FReleaseObjectVersion


code: enum Type { BeforeCustomVersionWasAdded = 0, IndirectLightingCache3BandSupport, CustomReflectionCaptureResolutionSupport, RemovedTextureStreamingLevelData, IntroducedMeshDecals, ReflectionCapturesStoreAverageBrightness, ChangedPlanarReflectionFadeDefaults, RemovedRenderTargetSize, MovedParticleCutoutsToRequiredModule, MapBuildDataSeparatePackage, TextureStreamingMeshUVChannelData, TypeHandlingForMaterialSqrtNodes, FixedBSPLightmaps, DistanceFieldSelfShadowBias, FixedLegacyMaterialAttributeNodeTypes, ShaderResourceCodeSharing, MotionBlurAndTAASupportInSceneCapture2d, AddedTextureRenderTargetFormats, FixedMeshUVDensity, AddedbUseShowOnlyList, VolumetricLightmaps, MaterialAttributeLayerParameters, StoreReflectionCaptureBrightnessForCooking, ModelVertexBufferSerialization, ReplaceLightAsIfStatic, ShaderPermutationId, IncreaseNormalPrecision, VirtualTexturedLightmaps, GeometryCacheFastDecoder, LightmapHasShadowmapData, DiaphragmDOFOnlyForDeferredShadingRenderer, VirtualTexturedLightmapsV2, SkyAtmosphereStaticLightingVersioning, ExplicitSRGBSetting, VolumetricLightmapStreaming, RemovedSM4, MaterialShaderMapIdSerialization, StaticMeshSectionForceOpaqueField, AutoExposureChanges, RemovedEmulatedInstancing, PerInstanceCustomData, AnisotropicMaterial, AutoExposureForceOverrideBiasFlag, AutoExposureDefaultFix, VolumeExtinctionBecomesRGB, VirtualTexturedLightmapsV3, NaniteFallbackTarget, NaniteForceMaterialUsage, VersionPlusOne, LatestVersion = VersionPlusOne - 1, }


className: FRenderingObjectVersion

code: struct FRenderingObjectVersion


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


className: FScriptName

description: The full amount of data required to reconstruct a case-preserving name This will be the maximum size of anFNameacross all values of WITH_CASE_PRESERVING_NAME and UE_FNAME_OUTLINE_NUMBER and is used to store anFNamein cases where the size of a name must be constant between build configurations (eg, blueprint bytecode) the layout is not guaranteed to be the same asFNameeven if the size is the same, so memory cannot be reinterpreted between the two. The layout here must be as expected by FScriptBytecodeWriter and XFER_NAME

code: struct FScriptName


code: static const [FGuid](API\Runtime\Core\Misc\FGuid) GUID;


className: FSequencerObjectVersion

code: struct FSequencerObjectVersion


code: enum Type { BeforeCustomVersionWasAdded = 0, RenameMediaSourcePlatformPlayers, ConvertEnableRootMotionToForceRootLock, ConvertMultipleRowsToTracks, WhenFinishedDefaultsToRestoreState, EvaluationTree, WhenFinishedDefaultsToProjectDefault, FloatToIntConversion, PurgeSpawnableBlueprints, FinishUMGEvaluation, SerializeFloatChannel, ModifyLinearKeysForOldInterp, SerializeFloatChannelCompletely, SpawnableImprovements, VersionPlusOne, LatestVersion = VersionPlusOne - 1, }


code: struct FUE5CookerObjectVersion


code: enum Type { BeforeCustomVersionWasAdded = 0, VersionPlusOne, LatestVersion = VersionPlusOne - 1, }


code: enum Type { BeforeCustomVersionWasAdded = 0, LWCTypesInShaders, VersionPlusOne, LatestVersion = VersionPlusOne - 1, }


description: Custom serialization version for changes made in //UE5/Main stream


code: static [TMap](API\Runtime\Core\Containers\TMap)< [FGuid](API\Runtime\Core\Misc\FGuid), [FGuid](API\Runtime\Core\Misc\FGuid) > GetSystemGuids()


code: enum Type { BeforeCustomVersionWasAdded = 0, GeometryCollectionNaniteData, GeometryCollectionNaniteDDC, RemovingSourceAnimationData, MeshDescriptionNewFormat, PartitionActorDescSerializeGridGuid, ExternalActorsMapDataPackageFlag, AnimationAddedBlendProfileModes, WorldPartitionActorDescSerializeDataLayers, RenamingAnimationNumFrames, WorldPartitionHLODActorDescSerializeHLODLayer, GeometryCollectionNaniteCooked, AddedCookedBoolFontFaceAssets, WorldPartitionHLODActorDescSerializeCellHash, GeometryCollectionNaniteTransient, AddedLandscapeSplineActorDesc, AddCollisionConstraintFlag, MantleDbSerialize, AnimSyncGroupsExplicitSyncMethod, FLandscapeActorDescFixupGridIndices, FoliageTypeIncludeInHLOD, IntroducingAnimationDataModel, WorldPartitionActorDescSerializeActorLabel, WorldPartitionActorDescSerializeArchivePersistent, FixForceExternalActorLevelReferenceDuplicates, SerializeMeshDescriptionBase, ConvexUsesVerticesArray, WorldPartitionActorDescSerializeHLODInfo, AddDisabledFlag, MoveCustomAttributesToDataModel, BlendSpaceRuntimeTriangulation, BlendSpaceSmoothingImprovements, RemovingTessellationParameters, SparseClassDataStructSerialization, PackedLevelInstanceBoundsFix, AnimNodeConstantDataRefactorPhase0, MaterialSavedCachedData, RemoveDecalBlendMode, DirLightsAreAtmosphereLightsByDefault, WorldPartitionStreamingCellsNamingShortened, WorldPartitionActorDescGetStreamingBounds, MeshDescriptionVirtualization, TextureSourceVirtualization, RigVMCopyOpStoreNumBytes, MaterialTranslucencyPass, GeometryCollectionUserDefinedCollisionShapes, RemovedAtmosphericFog, SkyAtmosphereAffectsHeightFogWithBetterDefault, BlendSpaceSampleOrdering, GeometryCollectionCacheRemovesMassToLocal, EdGraphPinSourceIndex, VirtualizedBulkDataHaveUniqueGuids, RigVMMemoryStorageObject, RayTracedShadowsType, SkelMeshSectionVisibleInRayTracingFlagAdded, AnimGraphNodeTaggingAdded, DynamicMeshCompactedSerialization, ConvertReductionBaseSkeletalMeshBulkDataToInlineReductionCacheData, SkeletalMeshLODModelMeshInfo, TextureDoScaleMipsForAlphaCoverage, VolumetricCloudReflectionSampleCountDefaultUpdate, UseTriangleMeshBVH, DynamicMeshAttributesWeightMapsAndNames, FKControlNamingScheme, RichCurveKeyInvalidTangentMode, ForceUpdateAnimationAssetCurveTangents, SoundWaveVirtualizationUpdate, MaterialFeatureLevelNodeFixForSM6, GeometryCollectionPerChildDamageThreshold, AddRigidParticleControlFlags, LiveLinkComponentPickerPerController, RemoveTriangleMeshBVHFaces, LensComponentNodalOffset, FixGpuAlwaysRunningUpdateScriptNoneInterpolated, WorldPartitionSerializeStreamingPolicyOnCook, WorldPartitionActorDescRemoveBoundsRelevantSerialization, AnimationDataModelInterface_BackedOut, LandscapeSplineActorDescDeprecation, BackoutAnimationDataModelInterface, MobileStationaryLocalLights, ManagedArrayCollectionAlwaysSerializeValue, LensComponentDistortion, ImgMediaPathResolutionWithEngineOrProjectTokens, AddLowResolutionHeightField, DecreaseLowResolutionHeightField, GeometryCollectionDamagePropagationData, VehicleFrictionForcePositionChange, AddSetMeshDeformerFlag, WorldPartitionActorDescActorAndClassPaths, ReintroduceAnimationDataModelInterface, IncreasedSkinWeightPrecision, MaterialHasIsUsedWithVolumetricCloudFlag, UpdateHairDescriptionBulkData, SpawnActorFromClassTransformScaleMethod, RigVMLazyEvaluation, PoseAssetRawDataGUIDUpdate, RigVMSaveFunctionAccessInModel, RigVMSerializeExecuteContextStruct, VisualLoggerTimeStampAsDouble, MaterialInstanceBasePropertyOverridesThinSurface, MaterialRefractionModeNone, RigVMSaveSerializedGraphInGraphFunctionData, PerPlatformAnimSequenceTargetFrameRate, NiagaraGrid2DDefaultUnnamedAttributesZero, RigVMGeneratedClass, NullPinSubCategoryObjectFix, AccessSpecifiersForCustomEvents, GroomAssetWidthOverride, AnimationRemoveSmartNames, NiagaraSpriteRendererFacingAlignmentAutoDefault, GroomAssetRemoveInAssetSerialization, IncreaseMaterialAttributesInputMask, NiagaraSimStageNumIterationsBindings, SkeletalVertexAttributes, RigVMExternalExecuteContextStruct, DataflowSeparateInputOutputSerialization, ClothCollectionTetherInitialization, OpenColorIOAssetCacheSerialization, ClothCollectionSingleLodSchema, VersionPlusOne, LatestVersion = VersionPlusOne - 1, }


code: struct FUE5MainStreamObjectVersion


code: enum Type { BeforeCustomVersionWasAdded = 0, HLODBatchingPolicy, SerializeSceneComponentStaticBounds, ChaosClothAddTethersToCachedData, SerializeActorLabelInCookedBuilds, ConvertWorldPartitionHLODsCellsToName, ChaosClothRemoveKinematicTethers, SerializeSkeletalMeshMorphTargetRenderData, StripMorphTargetSourceDataForCookedBuilds, VersionPlusOne, LatestVersion = VersionPlusOne - 1, }


description: Custom serialization version for changes made in //UE5/Private-Frosty stream


code: enum Type { BeforeCustomVersionWasAdded = 0, ReflectionMethodEnum, WorldPartitionActorDescSerializeHLODInfo, RemovingTessellation, LevelInstanceSerializeRuntimeBehavior, PoseAssetRuntimeRefactor, WorldPartitionActorDescSerializeActorFolderPath, HairStrandsVertexFormatChange, AddChaosMaxLinearAngularSpeed, PackedLevelInstanceVersion, PackedLevelInstanceBoundsFix, CustomPropertyAnimGraphNodesUseOptionalPinManager, TextFormatArgumentData64bitSupport, MaterialLayerStacksAreNotParameters, MaterialInterfaceSavedCachedData, AddClothMappingLODBias, AddLevelActorPackagingScheme, WorldPartitionActorDescSerializeAttachParent, ConvertedActorGridPlacementToSpatiallyLoadedFlag, ActorGridPlacementDeprecateDefaultValueFixup, PackedLevelActorUseWorldPartitionActorDesc, AddLevelActorFolders, RemoveSkeletalMeshLODModelBulkDatas, ExcludeBrightnessFromEncodedHDRCubemap, VolumetricCloudSampleCountUnification, PoseAssetRawDataGUID, ConvolutionBloomIntensity, WorldPartitionHLODActorDescSerializeHLODSubActors, LargeWorldCoordinates, BlueprintPinsUseRealNumbers, UpdatedDirectionalLightShadowDefaults, GeometryCollectionConvexDefaults, ChaosClothFasterDamping, WorldPartitionLandscapeActorDescSerializeLandscapeActorGuid, AddedInertiaTensorAndRotationOfMassAddedToConvex, ChaosInertiaConvertedToVec3, SerializeFloatPinDefaultValuesAsSinglePrecision, AnimLayeredBoneBlendMasks, StoreReflectionCaptureEncodedHDRDataInRG11B10Format, RawAnimSequenceTrackSerializer, RemoveDuplicatedStyleInfo, LinkedAnimGraphMemberReference, DynamicMeshComponentsDefaultUseExternalTangents, MediaCaptureNewResizeMethods, RigVMSaveDebugMapInGraphFunctionData, LocalExposureDefaultChangeFrom1, WorldPartitionActorDescSerializeActorIsListedInSceneOutliner, OpenColorIODisabledDisplayConfigurationDefault, VersionPlusOne, LatestVersion = VersionPlusOne - 1, }


description: Custom serialization version for changes made in //UE5/Release-* stream

code: struct FUE5ReleaseStreamObjectVersion


code: enum Type { BeforeCustomVersionWasAdded = 0, SupportAjaLTCPin, VersionPlusOne, LatestVersion = VersionPlusOne - 1, }


className: FVirtualProductionObjectVersion

description: Custom serialization version for changes made in Dev-VirtualProduction stream

code: struct FVirtualProductionObjectVersion


code: enum Type { BeforeCustomVersionWasAdded = 0, UseFNameInsteadOfEControllerHandForMotionSource, UseBoolsForARSessionConfigPlaneDetectionConfiguration, UseSubobjectForStereoLayerShapeProperties, VersionPlusOne, LatestVersion = VersionPlusOne - 1, }


className: FVRObjectVersion

code: struct FVRObjectVersion


className: TAutoWeakObjectPtr::operator bool

description: Deprecated* Implicit conversion fromTAutoWeakObjectPtrto the pointer type has been deprecated - useGet()instead

code: operator bool() const


className: TAutoWeakObjectPtr::operator const T *

code: operator const T *() const


className: TAutoWeakObjectPtr::operator T *

code: operator T *() const


description: NULL constructor

code: TAutoWeakObjectPtr()


description: Construct from a raw pointer

code: TAutoWeakObjectPtr ( const T * Target )


description: Construct from the base type

code: TAutoWeakObjectPtr ( const [TWeakObjectPtr](API\Runtime\Core\UObject\TWeakObjectPtr)< T > & Other )


className: TAutoWeakObjectPtr

description: Automatic version of the weak object pointer

code: template<class T> class TAutoWeakObjectPtr : public [TWeakObjectPtr< T >](API\Runtime\Core\UObject\TWeakObjectPtr)


className: TGetTypeLayoutHelper<                          FMemoryImageName >::Do

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


code: template<> struct TGetTypeLayoutHelper< FMemoryImageName >


className: TGetTypeLayoutHelper<                          FScriptName >::Do

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


className: TGetTypeLayoutHelper<                          FScriptName >

code: template<> struct TGetTypeLayoutHelper< FScriptName >


className: THasTypeLayout<                          FScriptName >

code: template<> struct THasTypeLayout< FScriptName >


className: TIsContiguousContainer< FNameBuilder >

code: template<> struct TIsContiguousContainer< FNameBuilder >


className: TIsPODType< FName >

description: FNames act like PODs.

code: template<> struct TIsPODType< FName >


className: TIsZeroConstructType< class FName >

code: template<> struct TIsZeroConstructType< class FName >


className: TMemoryImageNameLayout

code: template<bool bCasePreserving> struct TMemoryImageNameLayout


className: THasTypeLayout<                          FMemoryImageName >

code: template<> struct THasTypeLayout< FMemoryImageName >


className: TMemoryImageNameLayout< false >

code: template<> struct TMemoryImageNameLayout< false >

ComparisonIndex

type: FNameEntryId


className: TMemoryImageNameLayout< true >

code: template<> struct TMemoryImageNameLayout< true > : public [Freeze::TMemoryImageNameLayout< false >](API\Runtime\Core\UObject\TMemoryImageNameLayout_false)


description: Adds a function delegate to this multi-cast delegate's invocation list

code: void Add ( const [TScriptDelegate](API\Runtime\Core\UObject\TScriptDelegate)< [ThreadSafetyMode](API\Runtime\Core\UObject\TMulticastScriptDelegate\ThreadSafetyMode) > & InDelegate )


description: Deprecated* Deprecated - remove after TScriptDelegateTraitsis removed

code: template<typename OtherThreadSafetyMode, std::enable_if_t<([UE::Core::Private::BackwardCompatibilityCheck](API\Runtime\Core\UObject\UE__Core__Private__BackwardCompa-)< InThreadSafetyMode, OtherThreadSafetyMode >()), int >> void Add ( const [TScriptDelegate](API\Runtime\Core\UObject\TScriptDelegate)< OtherThreadSafetyMode > & InDelegate )


code: void AddInternal ( [UnicastDelegateType](API\Runtime\Core\UObject\TScriptDelegate) && InDelegate )


description: Adds a function delegate to this multi-cast delegate's invocation list if a delegate with the same signature doesn't already exist in the invocation list

code: void AddUnique ( const [TScriptDelegate](API\Runtime\Core\UObject\TScriptDelegate)< [ThreadSafetyMode](API\Runtime\Core\UObject\TMulticastScriptDelegate\ThreadSafetyMode) > & InDelegate )


code: template<typename OtherThreadSafetyMode, std::enable_if_t<([UE::Core::Private::BackwardCompatibilityCheck](API\Runtime\Core\UObject\UE__Core__Private__BackwardCompa-)< InThreadSafetyMode, OtherThreadSafetyMode >()), int >> void AddUnique ( const [TScriptDelegate](API\Runtime\Core\UObject\TScriptDelegate)< OtherThreadSafetyMode > & InDelegate )


description: Adds a function delegate to this multi-cast delegate's invocation list, if a delegate with that signature doesn't already exist

code: void AddUniqueInternal ( [UnicastDelegateType](API\Runtime\Core\UObject\TScriptDelegate) && InDelegate )


description: Removes all functions from this delegate's invocation list

code: void Clear()


description: Cleans up any delegates in our invocation list that have expired (performance is O(N))

code: void CompactInvocationList() const


description:
Checks whether a function delegate is already a member of this multi-cast delegate's invocation list
True if the delegate is already in the list.

code: bool Contains ( const [TScriptDelegate](API\Runtime\Core\UObject\TScriptDelegate)< [ThreadSafetyMode](API\Runtime\Core\UObject\TMulticastScriptDelegate\ThreadSafetyMode) > & InDelegate ) const


code: template<typename OtherThreadSafetyMode, std::enable_if_t<([UE::Core::Private::BackwardCompatibilityCheck](API\Runtime\Core\UObject\UE__Core__Private__BackwardCompa-)< InThreadSafetyMode, OtherThreadSafetyMode >()), int >> bool Contains ( const [TScriptDelegate](API\Runtime\Core\UObject\TScriptDelegate)< OtherThreadSafetyMode > & InDelegate ) const


code: bool Contains ( const [UObject](API\Runtime\CoreUObject\UObject\UObject) * InObject, [FName](API\Runtime\Core\UObject\FName) InFunctionName ) const


code: [TArray](API\Runtime\Core\Containers\TArray)< typename [UnicastDelegateType::WeakPtrType](API\Runtime\Core\UObject\TScriptDelegate\WeakPtrType) * > GetAllObjectRefsEvenIfUnreachable() const


description:
Returns all objects associated with this multicast-delegate. For advanced uses only  you should never need call this function in normal circumstances.
List of objects bound to this delegate

code: [TArray](API\Runtime\Core\Containers\TArray)< [UObject](API\Runtime\CoreUObject\UObject\UObject) * > GetAllObjects() const


description:
Returns all objects associated with this multicast-delegate, even if unreachable. For advanced uses only  you should never need call this function in normal circumstances.
List of objects bound to this delegate

code: [TArray](API\Runtime\Core\Containers\TArray)< [UObject](API\Runtime\CoreUObject\UObject\UObject) * > GetAllObjectsEvenIfUnreachable() const


description: Returns the amount of memory allocated by this delegate's invocation list, not including sizeof(*this).

code: SIZE_T GetAllocatedSize() const


className: InvocationListType

code: typedef [TArray](API\Runtime\Core\Containers\TArray)< [UnicastDelegateType](API\Runtime\Core\UObject\TScriptDelegate) > InvocationListType


description:
Checks to see if any functions are bound to this multi-cast delegate
True if any functions are bound

code: bool IsBound() const


code: [TMulticastScriptDelegate](API\Runtime\Core\UObject\TMulticastScriptDelegate) & operator= ( [TMulticastScriptDelegate](API\Runtime\Core\UObject\TMulticastScriptDelegate) && Other )


code: [TMulticastScriptDelegate](API\Runtime\Core\UObject\TMulticastScriptDelegate) & operator= ( const [TMulticastScriptDelegate](API\Runtime\Core\UObject\TMulticastScriptDelegate) & Other )


description: Executes a multi-cast delegate by calling all functions on objects bound to the delegate. Always safe to call, even if when no objects are bound, or if objects have expired. In general, you should never call this function directly. Instead, callBroadcast()on a derived class.

code: template<class UObjectTemplate> void ProcessMulticastDelegate ( void * Parameters ) const


description: Removes a function from this multi-cast delegate's invocation list (performance is O(N)). Note that the order of the delegates may not be preserved!

code: void Remove ( const [TScriptDelegate](API\Runtime\Core\UObject\TScriptDelegate)< [ThreadSafetyMode](API\Runtime\Core\UObject\TMulticastScriptDelegate\ThreadSafetyMode) > & InDelegate )


code: template<typename OtherThreadSafetyMode, std::enable_if_t<([UE::Core::Private::BackwardCompatibilityCheck](API\Runtime\Core\UObject\UE__Core__Private__BackwardCompa-)< InThreadSafetyMode, OtherThreadSafetyMode >()), int >> void Remove ( const [TScriptDelegate](API\Runtime\Core\UObject\TScriptDelegate)< OtherThreadSafetyMode > & InDelegate )


code: void Remove ( const [UObject](API\Runtime\CoreUObject\UObject\UObject) * InObject, [FName](API\Runtime\Core\UObject\FName) InFunctionName )


description: This method also compacts the invocation list.

code: void RemoveAll ( const [UObject](API\Runtime\CoreUObject\UObject\UObject) * Object )


code: void RemoveInternal ( const [UnicastDelegateType](API\Runtime\Core\UObject\TScriptDelegate) & InDelegate ) const


code: void RemoveInternal ( const [UObject](API\Runtime\CoreUObject\UObject\UObject) * InObject, [FName](API\Runtime\Core\UObject\FName) InFunctionName ) const


className: Super

code: typedef [TDelegateAccessHandlerBase](API\Runtime\Core\Delegates\TDelegateAccessHandlerBase)< InThreadSafetyMode > Super


description:
Converts this delegate to a string representation
Delegate in string format

code: template<typename UObjectTemplate> [FString](API\Runtime\Core\Containers\FString) ToString() const


className: UnicastDelegateType

code: typedef [TScriptDelegate](API\Runtime\Core\UObject\TScriptDelegate)< typename [UE::Core::Private::TScriptDelegateTraits](API\Runtime\Core\UObject\TScriptDelegateTraits)< InThreadSafetyMode >::UnicastThreadSafetyModeForMulticasts > UnicastDelegateType


code: TMulticastScriptDelegate ( const [TMulticastScriptDelegate](API\Runtime\Core\UObject\TMulticastScriptDelegate) & Other )


code: TMulticastScriptDelegate ( [TMulticastScriptDelegate](API\Runtime\Core\UObject\TMulticastScriptDelegate) && Other )


className: TMulticastScriptDelegate

description: Script multi-cast delegate base class

code: template<typename InThreadSafetyMode> class TMulticastScriptDelegate : public [TDelegateAccessHandlerBase< UE::Core::Private::TScriptDelegateTraits< InThreadSafetyMode >::ThreadSafetyMode >](API\Runtime\Core\Delegates\TDelegateAccessHandlerBase)

InvocationList

type: InvocationListT...

description: Ordered list functions to invoke when the Broadcast function is called


className: TNameOf< FName >::GetName

code: static TCHAR const &42; GetName&40;&41;


className: TNameOf< FName >

code: template<> struct TNameOf< FName >


description: Unbinds this delegate (another name to provide a similar interface toTMulticastScriptDelegate)

code: void Clear()


description: Binds aUFunctionto this delegate.

code: void BindUFunction ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * InObject, const [FName](API\Runtime\Core\UObject\FName) & InFunctionName )


code: template<typename OtherThreadSafetyMode> static [TScriptDelegate](API\Runtime\Core\UObject\TScriptDelegate) CopyFrom ( const [TScriptDelegate](API\Runtime\Core\UObject\TScriptDelegate)< OtherThreadSafetyMode > & Other )


description:
Gets the name of the function to call on the bound object
Function name


description:
Gets the object bound to this delegate
The object


description:
Gets the object bound to this delegate (const)
The object

code: const [UObject](API\Runtime\CoreUObject\UObject\UObject) * GetUObject() const


description:
Gets the object bound to this delegate, even if the object is unreachable
The object


description:
Gets the object bound to this delegate (const), even if the object is unreachable
The object

code: const [UObject](API\Runtime\CoreUObject\UObject\UObject) * GetUObjectEvenIfUnreachable() const


description:
Checks to see if the user object bound to this delegate is still valid
True if the object is still valid and it's safe to execute the function call

code: bool IsBound() const


description:
Checks to see if this delegate is bound to the given user object.
True if this delegate is bound to InUserObject, false otherwise.

code: bool IsBoundToObject ( void const * InUserObject ) const


description:
Checks to see if this delegate is bound to the given user object, even if the object is unreachable.
True if this delegate is bound to InUserObject, false otherwise.

code: bool IsBoundToObjectEvenIfUnreachable ( void const * InUserObject ) const


description:
Checks to see if the user object bound to this delegate will ever be valid again
True if the object is still valid and it's safe to execute the function call

code: bool IsCompactable() const


code: [TScriptDelegate](API\Runtime\Core\UObject\TScriptDelegate) & operator= ( const [TScriptDelegate](API\Runtime\Core\UObject\TScriptDelegate) & Other )


description: Deprecated* Deprecated - remove after TScriptDelegateTraitsis removed

code: template<typename OtherThreadSafetyMode, std::enable_if_t<([UE::Core::Private::BackwardCompatibilityCheck](API\Runtime\Core\UObject\UE__Core__Private__BackwardCompa-)< InThreadSafetyMode, OtherThreadSafetyMode >()), int >> [TScriptDelegate](API\Runtime\Core\UObject\TScriptDelegate) & operator= ( const [TScriptDelegate](API\Runtime\Core\UObject\TScriptDelegate)< OtherThreadSafetyMode > & Other )


description: Comparison operators

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


code: template<typename OtherThreadSafetyMode, std::enable_if_t<([UE::Core::Private::BackwardCompatibilityCheck](API\Runtime\Core\UObject\UE__Core__Private__BackwardCompa-)< InThreadSafetyMode, OtherThreadSafetyMode >()), int >> bool operator== ( const [TScriptDelegate](API\Runtime\Core\UObject\TScriptDelegate)< OtherThreadSafetyMode > & Other ) const


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


code: template<typename OtherThreadSafetyMode, std::enable_if_t<([UE::Core::Private::BackwardCompatibilityCheck](API\Runtime\Core\UObject\UE__Core__Private__BackwardCompa-)< InThreadSafetyMode, OtherThreadSafetyMode >()), int >> bool operator!= ( const [TScriptDelegate](API\Runtime\Core\UObject\TScriptDelegate)< OtherThreadSafetyMode > & Other ) const


description: Executes a delegate by calling the named function on the object bound to the delegate. You should always first verify that the delegate is safe to execute by callingIsBound()before calling this function. In general, you should never call this function directly. Instead, callExecute()on a derived class.

code: template<class UObjectTemplate> void ProcessDelegate ( void * Parameters ) const


code: template<class UObjectTemplate> [FString](API\Runtime\Core\Containers\FString) ToString() const


description: Unbinds this delegate

code: void Unbind()


description: Default constructor.

code: TScriptDelegate()


code: TScriptDelegate ( const [TScriptDelegate](API\Runtime\Core\UObject\TScriptDelegate) & Other )


code: template<typename OtherThreadSafetyMode, std::enable_if_t<([UE::Core::Private::BackwardCompatibilityCheck](API\Runtime\Core\UObject\UE__Core__Private__BackwardCompa-)< InThreadSafetyMode, OtherThreadSafetyMode >()), int >> TScriptDelegate ( const [TScriptDelegate](API\Runtime\Core\UObject\TScriptDelegate)< OtherThreadSafetyMode > & Other )


className: TScriptDelegate

description: Script delegate base class.

code: template<typename InThreadSafetyMode> class TScriptDelegate : public [TDelegateAccessHandlerBase< UE::Core::Private::TScriptDelegateTraits< InThreadSafetyMode >::ThreadSafetyMode >](API\Runtime\Core\Delegates\TDelegateAccessHandlerBase)

FunctionName

type: FName

description: Name of the function to call on the bound object

Object

type: WeakPtrType

description: The object bound to this delegate, or nullptr if no object is bound


className: UnicastThreadSafetyModeForMulticasts


className: WeakPtrType

description: Although templated, WeakPtrType is not intended to be anything other thanFWeakObjectPtr, and is only a template for module organization reasons.


className: TScriptDelegateTraits

code: template<typename InThreadSafetyMode> struct TScriptDelegateTraits


className: TStaticGetTypeLayoutHelper<                          FMemoryImageName >::CallAppendHash

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


className: TStaticGetTypeLayoutHelper<                          FMemoryImageName >::CallDestroy

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


className: TStaticGetTypeLayoutHelper<                          FMemoryImageName >::CallGetTargetAlignment

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


className: TStaticGetTypeLayoutHelper<                          FMemoryImageName >::CallToString

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


className: TStaticGetTypeLayoutHelper<                          FMemoryImageName >::CallUnfrozenCopy

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


className: TStaticGetTypeLayoutHelper<                          FMemoryImageName >::CallWriteMemoryImage

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


className: TStaticGetTypeLayoutHelper<                          FMemoryImageName >::Do

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


code: template<> struct TStaticGetTypeLayoutHelper< FMemoryImageName >


className: TStaticGetTypeLayoutHelper<                          FScriptName >::CallAppendHash


className: TStaticGetTypeLayoutHelper<                          FScriptName >::CallDestroy


className: TStaticGetTypeLayoutHelper<                          FScriptName >::CallGetTargetAlignment


className: TStaticGetTypeLayoutHelper<                          FScriptName >::CallToString


className: TStaticGetTypeLayoutHelper<                          FScriptName >::CallUnfrozenCopy


className: TStaticGetTypeLayoutHelper<                          FScriptName >::CallWriteMemoryImage


className: TStaticGetTypeLayoutHelper<                          FScriptName >::Do


code: template<> struct TStaticGetTypeLayoutHelper< FScriptName >


className: ElementType

description: Although templated, these parameters are not intended to be anything other than the default, and are only templates for module organization reasons.

code: typedef T ElementType


description: Dereference the weak pointer. This is an optimized version implying bEvenIfPendingKill=false.

code: T * Get() const


description:
Dereference the weak pointer
nullptr if this object is gone or the weak pointer is explicitly null, otherwise a valid uobject pointer

code: T * Get ( bool bEvenIfPendingKill ) const


description: Deferences the weak pointer even if its marked RF_Unreachable. This is needed to resolve weak pointers during GC (such as ::AddReferenceObjects)

code: T * GetEvenIfUnreachable() const


description: Hash function.

code: uint32 GetWeakPtrTypeHash() const


description: Returns true if two weak pointers were originally set to the same object, even if they are now stale

code: bool HasSameIndexAndSerialNumber ( const [TWeakObjectPtr](API\Runtime\Core\UObject\TWeakObjectPtr) & Other ) const


description: Returns true if this pointer was explicitly assigned to null, was reset, or was never initialized. If this returns true,IsValid()andIsStale()will both return false.

code: bool IsExplicitlyNull() const


description:
Slightly different than !IsValid(), returns true if this used to point to aUObject, but doesn't any more and has not been assigned or reset in the mean time.
true if this used to point at a real object but no longer does.

code: bool IsStale ( bool bIncludingIfPendingKill, bool bThreadsafeTest ) const


description:
Test if this points to a liveUObject. This is an optimized version implying bEvenIfPendingKill=false, bThreadsafeTest=false. This should be done only when needed as excess resolution of the underlying pointer can cause performance issues. Note that IsValid can not be used on another thread as it will incorrectly return false during the mark phase of the GC due to the Unreachable flag being set. (see bThreadsafeTest above)
true ifGet()would return a valid non-null pointer

code: bool IsValid() const


description:
Test if this points to a liveUObject. This should be done only when needed as excess resolution of the underlying pointer can cause performance issues.
true ifGet()would return a valid non-null pointer

code: bool IsValid ( bool bEvenIfPendingKill, bool bThreadsafeTest ) const


description: Dereference the weak pointer

code: T * operator->() const


className: TWeakObjectPtr::operator bool

description: This is explicitly not added to avoid resolving weak pointers too often - useGet()once in a function.

code: operator bool() const


description: Copy from an object pointer

code: template<class U> [TEnableIf](API\Runtime\Core\Templates\TEnableIf)<![TLosesQualifiersFromTo](API\Runtime\Core\Templates\TLosesQualifiersFromTo)< U, T >::Value, [TWeakObjectPtr](API\Runtime\Core\UObject\TWeakObjectPtr) & >::Type operator= ( U * Object )


code: [TWeakObjectPtr](API\Runtime\Core\UObject\TWeakObjectPtr) & operator= ( const [TWeakObjectPtr](API\Runtime\Core\UObject\TWeakObjectPtr) & )


description: Assign from another weak pointer, intended for derived-to-base conversions

code: template<typename OtherT, typename> [TWeakObjectPtr](API\Runtime\Core\UObject\TWeakObjectPtr) & operator= ( const [TWeakObjectPtr](API\Runtime\Core\UObject\TWeakObjectPtr)< OtherT, TWeakObjectPtrBase > & Other )


description: Compare weak pointers for equality. If both pointers would return nullptr fromGet()they count as equal even if they were not initialized to the same object.

code: template<typename RhsT, typename> bool operator== ( const [TWeakObjectPtr](API\Runtime\Core\UObject\TWeakObjectPtr)< RhsT, TWeakObjectPtrBase > & Rhs ) const


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


code: bool operator== ( TYPE_OF_NULLPTR ) const


description: Compare weak pointers for inequality

code: template<typename RhsT, typename> bool operator!= ( const [TWeakObjectPtr](API\Runtime\Core\UObject\TWeakObjectPtr)< RhsT, TWeakObjectPtrBase > & Rhs ) const


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


code: bool operator!= ( TYPE_OF_NULLPTR ) const


description: Dereference the weak pointer

code: T & operator*() const


description: Reset the weak pointer back to the null state

code: void Reset()


description: Weak object pointer serialization, this forwards toFArchive::operator<<(struct FWeakObjectPtr&)or an override

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


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


description: Construct from a null pointer

code: TWeakObjectPtr ( TYPE_OF_NULLPTR )


description: Construct from an object pointer

code: template<typename U, typename> TWeakObjectPtr ( U Object )


description: Construct from another weak pointer of another type, intended for derived-to-base conversions

code: template<typename OtherT, typename> TWeakObjectPtr ( const [TWeakObjectPtr](API\Runtime\Core\UObject\TWeakObjectPtr)< OtherT, TWeakObjectPtrBase > & Other )


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


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


className: TWeakObjectPtrMapKeyFuncs

description: MapKeyFuncs for TWeakObjectPtrs which allow the key to become stale without invalidating the map.

code: template<typename KeyType, typename ValueType, bool bInAllowDuplicateKeys> struct TWeakObjectPtrMapKeyFuncs : public [TDefaultMapKeyFuncs< KeyType, ValueType, bInAllowDuplicateKeys >](API\Runtime\Core\Containers\TDefaultMapKeyFuncs)


className: TWeakObjectPtr

description: TWeakObjectPtris the templated version of the genericFWeakObjectPtr

code: template<class T, class TWeakObjectPtrBase> struct TWeakObjectPtr : private TWeakObjectPtrBase


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


className: KeyInitType

code: typedef [DefaultKeyFuncs](API\Runtime\Core\Containers\DefaultKeyFuncs)< ElementType, bInAllowDuplicateKeys >::[KeyInitType](API\Runtime\Core\Containers\DefaultKeyFuncs\KeyInitType) KeyInitType


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


className: TWeakObjectPtrSetKeyFuncs

description: SetKeyFuncs for TWeakObjectPtrs which allow the key to become stale without invalidating the set.

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


description: This function only exists to allow compatibility between multicast and unicast delegate types which use an explicitFWeakObjectPtrtemplate parameter.

code: namespace UE { namespace Core { namespace Private { template<typename From, typename To> constexpr bool UE::Core::Private::BackwardCompatibilityCheck() } } }


className: UnicastThreadSafetyModeForMulticasts


code: FInitParams ( FStringView InProjectName, const [FConfigFile](API\Runtime\Core\Misc\FConfigFile) & InConfigFile )


className: FInitParams

description: The set of parameters to be used when initializing the virtualization system. The members must remain valid for the duration of the call to Initialize. It is not expected that any virtualization system will store a reference to the members, if they want to retain the data then they will make their own copies.

code: struct FInitParams

ConfigFile

type: constFConfigFi...

description: The config file to load the settings from (will default to GEngineIni)

ProjectName

type: FStringView

description: The name of the current project (will default toFApp::GetProjectName())


className: FActivity

code: struct FActivity

CyclesSpent

description: The total number of cycles spent on the activity across all threads.

PayloadCount

description: The number of payloads that have been involved by the activity.

TotalBytes

description: The total size of all payloads involved in the activity, in bytes.


className: FPayloadActivityInfo

description: Profiling data containing all activity relating to payloads.

code: struct FPayloadActivityInfo

Cache

type: FActivity


className: EStatus

code: enum EStatus { Error = -1, Pending = 0, Success = 1, }


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


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


code: void SetPayload ( const [FCompressedBuffer](API\Runtime\Core\Compression\FCompressedBuffer) & InPayload )


code: void SetPayload ( [FCompressedBuffer](API\Runtime\Core\Compression\FCompressedBuffer) && InPayload )


code: FPullRequest ( const [FIoHash](API\Runtime\Core\IO\FIoHash) & InIdentifier )


className: FPullRequest

description: Data structure representing a payload pull request

code: struct FPullRequest


description: Returns the context of the payload

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


description: Return the identifer used in the request


description: Returns the payload


description: Returns the size of the payload when it was on disk

code: uint64 GetPayloadSize() const


code: const [FPushResult](API\Runtime\Core\Virtualization\FPushResult) & GetResult() const


code: void SetResult ( [FPushResult](API\Runtime\Core\Virtualization\FPushResult) InResult )


description: Create a request for a payload already in memory

code: FPushRequest ( const [FIoHash](API\Runtime\Core\IO\FIoHash) & InIdentifier, const [FCompressedBuffer](API\Runtime\Core\Compression\FCompressedBuffer) & InPayload, const [FString](API\Runtime\Core\Containers\FString) & InContext )


code: FPushRequest ( const [FIoHash](API\Runtime\Core\IO\FIoHash) & InIdentifier, [FCompressedBuffer](API\Runtime\Core\Compression\FCompressedBuffer) && InPayload, [FString](API\Runtime\Core\Containers\FString) && InContext )


description: Create a request for a payload to be loaded on demand

code: FPushRequest ( const [FIoHash](API\Runtime\Core\IO\FIoHash) & InIdentifier, [IPayloadProvider](API\Runtime\Core\Virtualization\IPayloadProvider) & InProvider, [FString](API\Runtime\Core\Containers\FString) && InContext )


className: FPushRequest

description: Data structure representing a request to push a payload to a backend storage system. Note that a request can either before for payload already in memory (in which case the payload should be passed into the constructor as aFCompressedBuffer) or by aIPayloadProviderwhich will provide the payload on demand.

code: struct FPushRequest


description: Records the status of the push, negative values indicate an error, positive values indicate that the payload is stored in the target backend(s) and a zero value means that the operation has not yet run

code: enum EStatus { Error = -5, ProcessDisabled = -4, NoBackend = -3, Invalid = -2, Filtered = -1, Pending = 0, AlreadyExisted = 1, Pushed = 2, }


code: static [FPushResult](API\Runtime\Core\Virtualization\FPushResult) GetAsFiltered ( [EPayloadFilterReason](API\Runtime\Core\Virtualization\UE__Virtualization__EPayloadFilt-) Reason )


description: Returns why the payload was rejected by the filtering system (if there was one)


description: Returns true if the payload was rejected by the filtering system

code: bool IsFiltered() const


description: Returns true if the payload is stored in the target backend(s) after the operation completed

code: bool IsVirtualized() const


description: Returns true if the payload was actually uploaded to the target backend(s)

code: bool WasPushed() const


code: FPushResult &40; EStatus InStatus &41;


code: FPushResult &40; EStatus InStatus, EPayloadFilterReason InReason &41;


className: FPushResult

description: The result of a push operation on a single payload

code: struct FPushResult


className: FRehydrationInfo

description: Info about a rehydration operation

code: struct FRehydrationInfo

NumPayloadsRehydrated

description: The number of payloads that needed to be rehydrated

OriginalSize

description: Size of the package before it was rehydrated

RehydratedSize

description: Size of the package after rehydration, this does not including padding if any was applied


description: Add an error message to the result

code: void AddError ( const [FText](API\Runtime\Core\Internationalization\FText) & ErrorMsg )


description: Add an error message to the result

code: void AddError ( [FText](API\Runtime\Core\Internationalization\FText) && ErrorMsg )


description: Returns how many errors the process has currently encountered

code: int32 GetNumErrors() const


description: Returns if the rehydration process succeeded or not

code: bool WasSuccessful() const


className: FRehydrationResult

description: Contains the results of the package virtualization process

code: struct FRehydrationResult

CheckedOutPackages

type: TArray<FString...

description: A list of packages that were checked out of revision control during the process

Errors

type: TArray<FText>

description: A list of errors encountered during the process

RehydratedPackages

description: A list of packages that were actually rehydrated and had payloads added to local storage

TimeTaken

type: double

description: The length of time that the process took in seconds


description: Returns if the virtualization process succeeded or not


className: FVirtualizationResult

code: struct FVirtualizationResult

DescriptionTags

description: A list of tags associated with the group of packages that were virtualized

VirtualizedPackages

description: A list of packages that were actually virtualized and had locally stored payloads removed


description: Returns the current size of the payload on disk.

code: uint64 GetPayloadSize ( const [FIoHash](API\Runtime\Core\IO\FIoHash) & Identifier )


description: Should return the payload for the givenFIoHash. If the provider fails to find the payload then it should return a nullFCompressedBufferto indicate the error.

code: [FCompressedBuffer](API\Runtime\Core\Compression\FCompressedBuffer) RequestPayload ( const [FIoHash](API\Runtime\Core\IO\FIoHash) & Identifier )


description: Note that this has only been tested with perforce and so other source control solutions are currently unsupported.

code: bool SyncPayloadSidecarFile ( const [FPackagePath](API\Runtime\CoreUObject\Misc\FPackagePath) & PackagePath )


className: IPayloadProvider

description: Note that if the backend graph contains multiple backends then payloads may be requested multiple times. It will be up to the provider implementation to decide if a requested payload should be cached in case of future access or not. The methods are not const in order to make it easier for derived classes to cache the results if needed without the use of mutable.

code: class IPayloadProvider


className: IVirtualizationSourceControlUtilities

code: class IVirtualizationSourceControlUtilities : public [IModularFeature](API\Runtime\Core\Features\IModularFeature)


description: When called the system should write any performance stats that it has been gathering to the log file

code: void DumpStats() const


description: Deprecated* Call ::QueryPayloadStatuses instead

code: bool DoPayloadsExist ( [TArrayView](API\Runtime\Core\Containers\TArrayView)< const [FIoHash](API\Runtime\Core\IO\FIoHash) > Ids, [EStorageType](API\Runtime\Core\Virtualization\UE__Virtualization__EStorageType) StorageType, [TArray](API\Runtime\Core\Containers\TArray)< [EPayloadStatus](API\Runtime\Core\Virtualization\UE__Virtualization__EPayloadStat-) > & OutStatuses )


className: ENotification

code: enum ENotification { PushBegunNotification, PushEndedNotification, PushFailedNotification, PullBegunNotification, PullEndedNotification, PullFailedNotification, }


description:
Run checks to see if the payload can be virtualized or not.
The reasons why the payload can not be virtualized, encoded as a bitfield of EPayloadFilterReason. This bitfield will beEPayloadFilterReason::None(0) if no reason was found.

code: [EPayloadFilterReason](API\Runtime\Core\Virtualization\UE__Virtualization__EPayloadFilt-) FilterPayload ( const [UObject](API\Runtime\CoreUObject\UObject\UObject) * Owner ) const


className: FOnNotification

description: Declare delegate for notifications

code: typedef TTSMulticastDelegate< void([ENotification](API\Runtime\Core\Virtualization\IVirtualizationSystem\ENotification), const [FIoHash](API\Runtime\Core\IO\FIoHash) &)> FOnNotification


description: Gather analytics data. Stats will only be collected if ENABLE_COOK_STATS is enabled.

code: void GatherAnalytics ( [TArray](API\Runtime\Core\Containers\TArray)< [FAnalyticsEventAttribute](API\Runtime\Analytics\FAnalyticsEventAttribute) > & Attributes ) const


description: Gain access to the current virtualization system active for the project. If the system has not yet been initialized then calling this method will initialize it.

code: static [IVirtualizationSystem](API\Runtime\Core\Virtualization\IVirtualizationSystem) & Get()


description: Access profiling info relating to accumulated payload activity. Stats will only be collected if ENABLE_COOK_STATS is enabled.


className: GetPayloadActivityInfoFuncRef

code: typedef [TFunctionRef](API\Runtime\Core\GenericPlatform\TFunctionRef)< void(const [FString](API\Runtime\Core\Containers\FString) &DebugName, const [FString](API\Runtime\Core\Containers\FString) &ConfigName, const [FPayloadActivityInfo](API\Runtime\Core\Virtualization\FPayloadActivityInfo) &PayloadInfo)> GetPayloadActivityInfoFuncRef


description:
NOTE: This is a bit of an odd ball option to be included in the VirtualizationSystem API but at the moment we don't really have a better place for it. This might be removed or replaced in future releases.
True if the calling code should continue with submitting files if the virtualization process failed. If it returns false then the calling code should prevent the submit.


description: Access profiling info relating to payload activity per backend. Stats will only be collected if ENABLE_COOK_STATS is enabled.

code: void GetPayloadActivityInfo ( [GetPayloadActivityInfoFuncRef](API\Runtime\Core\Virtualization\IVirtualizationSystem\GetPayloadActivi-) ) const


description:
NOTE: Although it is relatively easy to access cached FConfigFiles, systems should use the one provided by InitParams to ensure that the correct settings are parsed.
True if the system was initialized correctly, otherwise false. Note that if the method returns false then the system will be deleted and the default FNullVirtualizationSystem will be used instead.

code: bool Initialize ( const [FInitParams](API\Runtime\Core\Virtualization\FInitParams) & InitParams )


description: Poll to see if content virtualization is enabled or not.

code: bool IsEnabled() const


description: Returns true if a virtualization system has been initialized and false if not

code: static bool IsInitialized()


description: Poll to see if pushing virtualized content to the given backend storage type is enabled or not.

code: bool IsPushingEnabled ( [EStorageType](API\Runtime\Core\Virtualization\UE__Virtualization__EStorageType) StorageType ) const


description: FPullRequest

code: bool PullData ( [TArrayView](API\Runtime\Core\Containers\TArrayView)< [FPullRequest](API\Runtime\Core\Virtualization\FPullRequest) > Requests )


description:
Pull a single payload from the virtualization backends.
A valid buffer representing the payload if the pull was successful. An invalid buffer if the pull failed.

code: [FCompressedBuffer](API\Runtime\Core\Compression\FCompressedBuffer) PullData ( const [FIoHash](API\Runtime\Core\IO\FIoHash) & Id )


description: FPullRequest

code: bool PullData ( [FPullRequest](API\Runtime\Core\Virtualization\FPullRequest) Request )


description:
Push one or more payloads to a backend storage system.FPushRequest.
When StorageType isEStorageType::Cachethis will return true as long each payload ends up being stored in at least one of the cache backends. When StorageType isEStorageType::Persistentthis will only return true if each payload endd up being stored inallof the backends. This is because the cache backends are not considered essential and it is not the end of the world if a payload is missing but the persistent backends must be reliable.

code: bool PushData ( [TArrayView](API\Runtime\Core\Containers\TArrayView)< [FPushRequest](API\Runtime\Core\Virtualization\FPushRequest) > Requests, [EStorageType](API\Runtime\Core\Virtualization\UE__Virtualization__EStorageType) StorageType )