description: Whether or not this track has any data in it.

code: virtual bool IsEmpty() const


description: Removes animation data.

module: HairStrandsCore

code: virtual void RemoveAllAnimationData()


description: Removes a section from this track.

code: virtual void RemoveSection ( [UMovieSceneSection](API\Runtime\MovieScene\UMovieSceneSection) & Section )


description: Removes a section from this track at a particular index

code: virtual void RemoveSectionAt ( int32 SectionIndex )


description:
Does this track support this section class type?
Whether this track supports this section class type

code: virtual bool SupportsType ( [TSubclassOf](API\Runtime\CoreUObject\Templates\TSubclassOf)< [UMovieSceneSection](API\Runtime\MovieScene\UMovieSceneSection) > SectionClass ) const


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


className: UMovieSceneGroomCacheTrack

description: Handles animation of GroomCache


module: HairStrandsEditor

code: static void ApplyImportSettings ( struct [FGroomCacheImportSettings](API\Plugins\HairStrandsCore\FGroomCacheImportSettings) & ImportSettings, [FGroomAnimationInfo](API\Plugins\HairStrandsCore\FGroomAnimationInfo) & AnimInfo )


code: static [TArray](API\Runtime\Core\Containers\TArray)< [UGroomCache](API\Plugins\HairStrandsCore\UGroomCache) * > ImportGroomCache ( const [FString](API\Runtime\Core\Containers\FString) & SourceFilename, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IGroomTranslator](API\Plugins\HairStrandsEditor\IGroomTranslator) > Translator, const [FGroomAnimationInfo](API\Plugins\HairStrandsCore\FGroomAnimationInfo) & InAnimInfo, [FHairImportContext](API\Plugins\HairStrandsEditor\FHairImportContext) & HairImportContext, [UGroomAsset](API\Plugins\HairStrandsCore\UGroomAsset) * GroomAssetForCache, [EGroomCacheImportType](API\Plugins\HairStrandsCore\EGroomCacheImportType) ImportType )


code: static [UGroomCache](API\Plugins\HairStrandsCore\UGroomCache) * ProcessToGroomCache ( [FGroomCacheProcessor](API\Plugins\HairStrandsCore\FGroomCacheProcessor) & Processor, const [FGroomAnimationInfo](API\Plugins\HairStrandsCore\FGroomAnimationInfo) & AnimInfo, [FHairImportContext](API\Plugins\HairStrandsEditor\FHairImportContext) & ImportContext, const [FString](API\Runtime\Core\Containers\FString) & ObjectNameSuffix )


code: static void SetupImportSettings ( struct [FGroomCacheImportSettings](API\Plugins\HairStrandsCore\FGroomCacheImportSettings) & ImportSettings, const [FGroomAnimationInfo](API\Plugins\HairStrandsCore\FGroomAnimationInfo) & AnimInfo )


description: Return the index of the active binding.

code: virtual int32 GetActiveBindingIndex() const


className: FGroomCacheImporter

code: struct FGroomCacheImporter


description: Returns the localized name of this toolkit type (typically just "editor")

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


description: EndIToolkitinterface Retrieves the current custom asset.

code: virtual [UGroomAsset](API\Plugins\HairStrandsCore\UGroomAsset) * GetCustomAsset() const


description: BeginIToolkitinterface

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


description: Returns the localized name of this toolkit

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


description: Returns the localized tooltip text of this toolkit

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


description: Returns the localize prefix string to use for tab labels in world-centric mode.

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


description: Returns the color and opacity to use for the color that appears behind the tab text for this toolkit's tab in world-centric mode.

code: virtual [FLinearColor](API\Runtime\Core\Math\FLinearColor) GetWorldCentricTabColorScale() const


description: Edits the specified asset object

code: void InitCustomAssetEditor ( const [EToolkitMode::Type](API\Editor\EditorFramework\Toolkits\EToolkitMode__Type) Mode, const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< class [IToolkitHost](API\Editor\EditorFramework\Toolkits\IToolkitHost) > & InitToolkitHost, [UGroomAsset](API\Plugins\HairStrandsCore\UGroomAsset) * InCustomAsset )


code: virtual bool IsPrimaryEditor() const


description: Called when this toolkit is being closed

code: virtual void OnClose()


description: Set preview of a particular binding.

code: virtual void PreviewBinding ( int32 BindingIndex )


description: IToolkitinterface

code: virtual void RegisterTabSpawners ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< class [FTabManager](API\Runtime\Slate\Framework\Docking\FTabManager) > & TabManager )


description: Set the current custom asset.

code: virtual void SetCustomAsset ( [UGroomAsset](API\Plugins\HairStrandsCore\UGroomAsset) * InCustomAsset )


code: static const [FName](API\Runtime\Core\UObject\FName) TabId_BindingProperties;


code: static const [FName](API\Runtime\Core\UObject\FName) TabId_CardsProperties;


code: static const [FName](API\Runtime\Core\UObject\FName) TabId_InterpolationProperties;


code: static const [FName](API\Runtime\Core\UObject\FName) TabId_LODProperties;


code: static const [FName](API\Runtime\Core\UObject\FName) TabId_MaterialProperties;


code: static const [FName](API\Runtime\Core\UObject\FName) TabId_MeshesProperties;


code: static const [FName](API\Runtime\Core\UObject\FName) TabId_PhysicsProperties;


code: static const [FName](API\Runtime\Core\UObject\FName) TabId_RenderingProperties;


code: static const [FName](API\Runtime\Core\UObject\FName) TabId_PreviewGroomComponent;


code: static const [FName](API\Runtime\Core\UObject\FName) TabId_Viewport;


className: ToolkitFName

code: static const [FName](API\Runtime\Core\UObject\FName) ToolkitFName;


description: Unregister tabs that this toolkit can spawn

code: virtual void UnregisterTabSpawners ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< class [FTabManager](API\Runtime\Slate\Framework\Docking\FTabManager) > & TabManager )


code: FGroomCustomAssetEditorToolkit()


description: Destructor


className: FGroomCustomAssetEditorToolkit

code: class FGroomCustomAssetEditorToolkit : public [IGroomCustomAssetEditorToolkit](API\Plugins\HairStrandsEditor\IGroomCustomAssetEditorToolkit)


code: static [FGroomEditor](API\Plugins\HairStrandsEditor\FGroomEditor) & Get()


description: Get new instances of HairStrandsTranslators

code: [TArray](API\Runtime\Core\Containers\TArray)< [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IGroomTranslator](API\Plugins\HairStrandsEditor\IGroomTranslator) > > GetHairTranslators()


className: GroomEditorAppIdentifier


description: Register HairStrandsTranslator to add support for import by the HairStandsFactory

code: template<typename TranslatorType> void RegisterHairTranslator()


description: Called before the module is unloaded, right before the module object is destroyed. During normal shutdown, this is called in reverse order that modules finishStartupModule(). This means that, as long as a module references dependent modules in it'sStartupModule(), it can safely reference those dependencies inShutdownModule()as well.

code: virtual void ShutdownModule()


description: FModuleManager::Get().LoadModuleChecked(TEXT("HTTP"));

code: virtual void StartupModule()


description:
Override this to set whether your module is allowed to be unloaded on the fly
Whether the module supports shutdown separate from the rest of the engine.

code: virtual bool SupportsDynamicReloading()


className: FGroomEditor

description: Implements the HairStrands module

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


description: Pure virtual to override; describe and instantiate the commands in here by using the UI COMMAND macro.

code: virtual void RegisterCommands()


className: FGroomEditorCommands

code: class FGroomEditorCommands : public [TCommands< FGroomEditorCommands >](API\Runtime\Slate\Framework\Commands\TCommands)

BeginHairPlaceTool

type: TSharedPtr<FUI...


description: Return the name of this style


description: Default constructor.

code: FGroomEditorStyle()


description: Destructor.

code: ~FGroomEditorStyle()


className: FGroomEditorStyle

description: Implements the visual style of the Groom asset editor UI.

code: class FGroomEditorStyle : public [FSlateStyleSet](API\Runtime\SlateCore\Styling\FSlateStyleSet)


code: FGroomViewportLODCommands()


className: FGroomViewportLODCommands

code: class FGroomViewportLODCommands : public [TCommands< FGroomViewportLODCommands >](API\Runtime\Slate\Framework\Commands\TCommands)


code: FHairImportContext ( [UGroomImportOptions](API\Plugins\HairStrandsCore\UGroomImportOptions) * InImportOptions, [UObject](API\Runtime\CoreUObject\UObject\UObject) * InParent, [UClass](API\Runtime\CoreUObject\UObject\UClass) * InClass, [FName](API\Runtime\Core\UObject\FName) InName, EObjectFlags InFlags )


className: FHairImportContext

code: struct FHairImportContext

Class

type: UClass*

Flags

type: EObjectFlags

ImportOptions

type: UGroomImportOpt...

Name

type: FName

Parent

type: UObject*


code: static [UGroomAsset](API\Plugins\HairStrandsCore\UGroomAsset) * ImportHair ( const [FHairImportContext](API\Plugins\HairStrandsEditor\FHairImportContext) & ImportContext, [FHairDescription](API\Plugins\HairStrandsCore\FHairDescription) & HairDescription, [UGroomAsset](API\Plugins\HairStrandsCore\UGroomAsset) * ExistingHair )


className: FHairStrandsImporter

code: struct FHairStrandsImporter


description: Set preview of a particular binding.

code: void PreviewBinding ( int32 BindingIndex )


code: int32 GetActiveBindingIndex() const


description: Retrieves the current custom asset.

code: [UGroomAsset](API\Plugins\HairStrandsCore\UGroomAsset) * GetCustomAsset() const


description: Set the current custom asset.

code: void SetCustomAsset ( [UGroomAsset](API\Plugins\HairStrandsCore\UGroomAsset) * InCustomAsset )


className: IGroomCustomAssetEditorToolkit

code: class IGroomCustomAssetEditorToolkit : public [FAssetEditorToolkit](API\Editor\UnrealEd\Toolkits\FAssetEditorToolkit)


description: Open a file for multiple translations at different frame indices

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


description: Return true if a given file can be translated (by checking its content if necessary)

code: bool CanTranslate ( const [FString](API\Runtime\Core\Containers\FString) & FilePath )


description: Clean up after finishing translations

code: virtual void EndTranslation()


description: Return the file format supported by the translator in the form "ext;file format description"


description: Return true if a given file extension is supported by the translator

code: bool IsFileExtensionSupported ( const [FString](API\Runtime\Core\Containers\FString) & FileExtension ) const


description: Translate a given file into a HairDescription; return true if successful

code: bool Translate ( const [FString](API\Runtime\Core\Containers\FString) & FilePath, [FHairDescription](API\Plugins\HairStrandsCore\FHairDescription) & OutHairDescription, const struct [FGroomConversionSettings](API\Plugins\HairStrandsCore\FGroomConversionSettings) & ConversionSettings )


description: Translate a given file into a HairDescription at the requested frame index; return true if successful

code: virtual bool Translate ( uint32 FrameIndex, [FHairDescription](API\Plugins\HairStrandsCore\FHairDescription) & OutHairDescription, const struct [FGroomConversionSettings](API\Plugins\HairStrandsCore\FGroomConversionSettings) & ConversionSettings )


description: Translate a given file into a HairDescription at the requested frame time (in seconds); return true if successful

code: virtual bool Translate ( float FrameTime, [FHairDescription](API\Plugins\HairStrandsCore\FHairDescription) & OutHairDescription, const struct [FGroomConversionSettings](API\Plugins\HairStrandsCore\FGroomConversionSettings) & ConversionSettings )


description: Translate a given file into a HairDescription with info about Groom animation if OutAnimInfo is not null; return true if successful

code: virtual bool Translate ( const [FString](API\Runtime\Core\Containers\FString) & FilePath, [FHairDescription](API\Plugins\HairStrandsCore\FHairDescription) & OutHairDescription, const struct [FGroomConversionSettings](API\Plugins\HairStrandsCore\FGroomConversionSettings) & ConversionSettings, struct [FGroomAnimationInfo](API\Plugins\HairStrandsCore\FGroomAnimationInfo) * OutAnimInfo )


code: virtual ~IGroomTranslator()


className: IGroomTranslator

code: class IGroomTranslator


description: Importing.

code: virtual bool CanImport() const


description: Gets a list of categories this asset is in, these categories are used to help organize

code: virtual TConstArrayView< [FAssetCategoryPath](API\Editor\AssetDefinition\Misc\FAssetCategoryPath) > GetAssetCategories() const


code: virtual [TSoftClassPtr](API\Runtime\CoreUObject\UObject\TSoftClassPtr)< [UObject](API\Runtime\CoreUObject\UObject\UObject) > GetAssetClass() const


code: virtual [FLinearColor](API\Runtime\Core\Math\FLinearColor) GetAssetColor() const


description: UAssetDefinitionBegin.

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


code: void GetResolvedSourceFilePaths ( const [TArray](API\Runtime\Core\Containers\TArray)< [UObject](API\Runtime\CoreUObject\UObject\UObject) * > & TypeAssets, [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & OutSourceFilePaths ) const


description: UAssetDefinitionBegin.

code: virtual EAssetCommandResult OpenAssets ( const [FAssetOpenArgs](API\Editor\AssetDefinition\FAssetOpenArgs) & OpenArgs ) const


code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)() class UAssetDefinition_GroomAsset : public [UAssetDefinitionDefault](API\Editor\UnrealEd\UAssetDefinitionDefault)


code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)() class UAssetDefinition_GroomBindingAsset : public [UAssetDefinitionDefault](API\Editor\UnrealEd\UAssetDefinitionDefault)


code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)() class UAssetDefinition_GroomCacheAsset : public [UAssetDefinitionDefault](API\Editor\UnrealEd\UAssetDefinitionDefault)


description: Return a quaternion which aligns this actor type to the specified surface normal

code: virtual FQuat AlignObjectToSurfaceNormal ( const FVector & InSurfaceNormal, const FQuat & ActorRotation ) const


code: virtual bool CanCreateActorFrom ( const [FAssetData](API\Runtime\CoreUObject\AssetRegistry\FAssetData) & AssetData, [FText](API\Runtime\Core\Internationalization\FText) & OutErrorMsg )


description: Given an instance of an actor, find the wrapped asset object which can be used to create a validFAssetData. Returns nullptr if the given ActorInstance is not valid for this factory. Override this function if the factory actor is a different class than the asset data's class which this factory operates on. For example, if this is the static mesh actor factory, the class of the asset data isUStaticMesh, but the actor factory's class isAStaticMeshActor

code: virtual [UObject](API\Runtime\CoreUObject\UObject\UObject) * GetAssetFromActorInstance ( [AActor](API\Runtime\Engine\GameFramework\AActor) * ActorInstance )


description: Subclasses may implement this to modify the actor after it has been spawned IMPORTANT: If you override this, you should usually also overridePostCreateBlueprint()!

code: virtual void PostSpawnActor ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * Asset, [AActor](API\Runtime\Engine\GameFramework\AActor) * NewActor )


description: Override this in derived factory classes if needed. This is called after a blueprint is created by this factory to update the blueprint's CDO properties with state from the asset for this factory. IMPORTANT: If you override this, you should usually also overridePostSpawnActor()!

code: virtual void PostCreateBlueprint ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * Asset, [AActor](API\Runtime\Engine\GameFramework\AActor) * CDO )


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


className: UGroomActorFactory

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(MinimalAPI, Config=Editor) class UGroomActorFactory : public [UActorFactory](API\Editor\UnrealEd\ActorFactories\UActorFactory)


description:
Create a new object by class.
The new object.

code: virtual [UObject](API\Runtime\CoreUObject\UObject\UObject) * FactoryCreateNew ( [UClass](API\Runtime\CoreUObject\UObject\UClass) * InClass, [UObject](API\Runtime\CoreUObject\UObject\UObject) * InParent, [FName](API\Runtime\Core\UObject\FName) InName, EObjectFlags Flags, [UObject](API\Runtime\CoreUObject\UObject\UObject) * Context, [FFeedbackContext](API\Runtime\Core\Misc\FFeedbackContext) * Warn )


description: Returns true if this factory should be shown in the New Asset menu (by default calls CanCreateNew).

code: virtual bool ShouldShowInNewMenu() const


description: These disable the standard gizmo, which is probably want we want in these tools as we can't hit-test the standard gizmo...

code: virtual bool AllowWidgetMove()


className: UGroomBindingFactory

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(MinimalAPI) class UGroomBindingFactory : public [UFactory](API\Editor\UnrealEd\Factories\UFactory)


code: static const FEditorModeID EM_GroomEditorModeId = TEXT("EM_GroomEditorMode");


description: Focus events

code: virtual void Enter()


description: Called when we "end" this editor mode (ie switch to another tab)

code: virtual void Exit()


className: UGroomEditorMode

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Transient) class UGroomEditorMode : public [UBaseLegacyWidgetEdMode](API\Editor\UnrealEd\Tools\UBaseLegacyWidgetEdMode)

ViewportWorldInteraction

type: UViewportWorldI...

description: Cached pointer to the viewport world interaction object we're using to interact with mesh elements


className: UGroomFactory

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(MinimalAPI) class UGroomFactory : public [UFactory](API\Editor\UnrealEd\Factories\UFactory)


description:
Whether the specified file can be imported by this factory.
true if the file is supported, false otherwise.

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


description:
The default implementation of this method will load the contents of the entire file into a byte buffer and call FactoryCreateBinary. User defined factories may override this behavior to process the provided file name on their own.
The new object.

code: virtual [UObject](API\Runtime\CoreUObject\UObject\UObject) * FactoryCreateFile ( [UClass](API\Runtime\CoreUObject\UObject\UClass) * InClass, [UObject](API\Runtime\CoreUObject\UObject\UObject) * InParent, [FName](API\Runtime\Core\UObject\FName) InName, EObjectFlags Flags, const [FString](API\Runtime\Core\Containers\FString) & Filename, const TCHAR * Parms, [FFeedbackContext](API\Runtime\Core\Misc\FFeedbackContext) * Warn, bool & bOutOperationCanceled )


description: Creates a list of file extensions supported by this factory

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


code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IGroomTranslator](API\Plugins\HairStrandsEditor\IGroomTranslator) > GetTranslator ( const [FString](API\Runtime\Core\Containers\FString) & Filename )


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


className: UHairStrandsFactory

description: Implements a factory for UHairStrands objects.

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(HideCategories=Object) class UHairStrandsFactory : public [UFactory](API\Editor\UnrealEd\Factories\UFactory)

GroomCacheImportOptions

type: UGroomCacheImpo...


description:
Check to see if the handler is capable of reimporting the object
true if this handler is capable of reimporting the provided object

code: virtual bool CanReimport ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * Obj, [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & OutFilenames )


description: Get the import priority for this handler. Import handlers with higher priority values will take precedent over lower priorities.

code: virtual int32 GetPriority() const


description: Attempt to reimport the specified object from its sourceEReimportResult::Succeededif this handler was able to handle reimporting the provided object,EReimportResult::Failedif this handler was unable to handle reimporting the provided object orEReimportResult::Cancelledif the handler was cancelled part-way through re-importing the provided object.

code: virtual [EReimportResult::Type](API\Editor\UnrealEd\EReimportResult__Type) Reimport ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * Obj )


description: Sets the reimport path(s) for the specified object

code: virtual void SetReimportPaths ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * Obj, const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & NewReimportPaths )


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


className: UReimportGroomCacheFactory

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(HideCategories=Object) class UReimportGroomCacheFactory : public [UHairStrandsFactory](API\Plugins\HairStrandsEditor\UHairStrandsFactory), public [FReimportHandler](API\Editor\UnrealEd\FReimportHandler)


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


className: UReimportHairStrandsFactory

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(HideCategories=Object) class UReimportHairStrandsFactory : public [UHairStrandsFactory](API\Plugins\HairStrandsEditor\UHairStrandsFactory), public [FReimportHandler](API\Editor\UnrealEd\FReimportHandler)


description: Pure virtual that must be overloaded by the inheriting class. Use this method to serialize any UObjects contained that you wish to keep around.

code: virtual void AddReferencedObjects ( [FReferenceCollector](API\Runtime\CoreUObject\UObject\FReferenceCollector) & Collector )


code: virtual void BindCommands()


code: void Construct ( const [FArguments](API\Editor\UnrealEd\SEditorViewport\FArguments) & InArgs )


description: FLevelEditorModule& LevelEditorModule =FModuleManager::GetModuleChecked(TEXT("LevelEditor"));TSharedPtrLevelEditorExtenders = LevelEditorModule.GetMenuExtensibilityManager()->GetAllExtenders();

code: virtual [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FExtender](API\Runtime\Slate\Framework\MultiBox\FExtender) > GetExtenders() const


code: int32 GetLODModelCount() const


code: int32 GetLODSelection() const


description: Overload this method to report a name for your referencer

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


description: Get the viewport widget.

code: virtual [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< class [SEditorViewport](API\Editor\UnrealEd\SEditorViewport) > GetViewportWidget()


code: bool IsLODModelSelected ( int32 InLODSelection ) const


description: Event handlers

code: bool IsTogglePreviewGridChecked() const


description: Implement this to add a viewport toolbar to the inside top of the viewport.

code: virtual [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > MakeViewportToolbar()


description: SEditorViewportinterface

code: virtual [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FEditorViewportClient](API\Editor\UnrealEd\FEditorViewportClient) > MakeEditorViewportClient()


description: Called to inform the host that a button was clicked (typically used to focus on a particular viewport in a multi-viewport setup)

code: virtual void OnFloatingButtonClicked()


description: Called when the user wants to focus the viewport to the current selection


description: The visibility of widgets in the viewport (e.g, menus). Note this is not the visibility of the scene rendered in the viewport

code: virtual [EVisibility](API\Runtime\SlateCore\Layout\EVisibility) OnGetViewportContentVisibility() const


description: Implement this to add an arbitrary set of toolbars or other overlays to the inside of the viewport.

code: virtual void PopulateViewportOverlays ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< class [SOverlay](API\Runtime\SlateCore\Widgets\SOverlay) > Overlay )


code: void OnSetLODModel ( int32 InLODSelection )


description: Set the component to preview.

code: void SetGroomComponent ( [UGroomComponent](API\Plugins\HairStrandsCore\UGroomComponent) * GroomComponent )


description: Set the mesh on which we are grooming

code: void SetStaticMeshComponent ( [UStaticMeshComponent](API\Runtime\Engine\Components\UStaticMeshComponent) * StaticGroomTarget )


description: Ticks this widget with Geometry. Override in derived classes, but always call the parent implementation.

code: virtual void Tick ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & AllottedGeometry, const double InCurrentTime, const float InDeltaTime )


description: Set the mesh on which we are grooming

code: void SetSkeletalMeshComponent ( [USkeletalMeshComponent](API\Runtime\Engine\Components\USkeletalMeshComponent) * SkeletalGroomTarget )


description: Event handlers

code: void TogglePreviewGrid()


code: ~SGroomEditorViewport()


className: SGroomEditorViewport

description: Material Editor Preview viewport widget

code: class SGroomEditorViewport : public [SEditorViewport](API\Editor\UnrealEd\SEditorViewport), public [FGCObject](API\Runtime\CoreUObject\UObject\FGCObject), public [ICommonEditorViewportToolbarInfoProvider](API\Editor\UnrealEd\ICommonEditorViewportToolbarInfo-)


description: Called before the module is unloaded, right before the module object is destroyed. During normal shutdown, this is called in reverse order that modules finishStartupModule(). This means that, as long as a module references dependent modules in it'sStartupModule(), it can safely reference those dependencies inShutdownModule()as well.

module: HDRIBackdrop

code: virtual void ShutdownModule()


className: FHDRIBackdropModule

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


description: IModuleInterfaceimplementation

code: virtual void StartupModule()


code: static void RegisterPlacement()


className: FHDRIBackdropPlacement

code: class FHDRIBackdropPlacement


code: static [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [ISlateStyle](API\Runtime\SlateCore\Styling\ISlateStyle) > Get()


className: StyleSet

code: static [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FSlateStyleSet](API\Runtime\SlateCore\Styling\FSlateStyleSet) > StyleSet;


className: FHDRIBackdropStyle

code: class FHDRIBackdropStyle


className: EHotfixResult

module: Hotfix

code: enum EHotfixResult { Failed, Success, SuccessNoChange, SuccessNeedsReload, SuccessNeedsRelaunch, }


className: EUpdateCompletionStatus

description: Possible outcomes at the end of an update check

code: enum EUpdateCompletionStatus { UpdateUnknown, UpdateSuccess, UpdateSuccess_NoChange, UpdateSuccess_NeedsReload, UpdateSuccess_NeedsRelaunch, UpdateSuccess_NeedsPatch, UpdateFailure_PatchCheck, UpdateFailure_HotfixCheck, UpdateFailure_NotLoggedIn, }


className: EUpdateState

description: Various states the update manager flows through as it checks for patches/hotfixes

code: enum EUpdateState { UpdateIdle, UpdatePending, CheckingForPatch, DetectingPlatformEnvironment, CheckingForHotfix, WaitingOnInitialLoad, InitialLoadComplete, UpdateComplete, }


className: FHotfixModule

description: Module for Hotfix base implementation

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


className: FOnHotfixAvailableComplete

description: Delegate fired when a check for hotfix files (but not application) completes

code: typedef TBaseDelegate_OneParam< void, [EHotfixResult](API\Plugins\Hotfix\EHotfixResult) > FOnHotfixAvailableComplete


className: FOnHotfixComplete

description: Delegate fired when the hotfix process has completed

code: typedef TMulticastDelegate_OneParam< void, [EHotfixResult](API\Plugins\Hotfix\EHotfixResult) > FOnHotfixComplete


className: FOnHotfixProcessedFile

description: Delegate fired for each new/updated file after it is applied

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


className: FOnHotfixProgress

description: Delegate fired as progress of hotfix file reading happens

code: typedef TMulticastDelegate_FourParams< void, uint32, uint32, uint64, uint64 > FOnHotfixProgress


className: FOnHotfixRemovedFile

description: Delegate fired for each removed file

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


className: FOnHotfixUpdatedFile

description: Delegate fired for each added/updated file

code: typedef TMulticastDelegate_TwoParams< void, const [FString](API\Runtime\Core\Containers\FString) &, const [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & > FOnHotfixUpdatedFile


className: FOnUpdateCheckComplete

description: Delegate fired when a single update check has completed

code: typedef TMulticastDelegate_OneParam< void, [EUpdateCompletionStatus](API\Plugins\Hotfix\EUpdateCompletionStatus) > FOnUpdateCheckComplete


className: FOnUpdateHotfixProcessedFile

description: Delegate fired when a single file hotfix is applied

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


className: FOnUpdateHotfixProcessedFileDelegate


className: FOnUpdateHotfixProgress

description: Delegate fired when progress on a hotfix download is made

code: typedef TMulticastDelegate_FourParams< void, uint32, uint32, uint64, uint64 > FOnUpdateHotfixProgress


className: FOnUpdateStatusChanged

description: Delegate fired when changes to the update progress have been made

code: typedef TMulticastDelegate_OneParam< void, [EUpdateState](API\Plugins\Hotfix\EUpdateState) > FOnUpdateStatusChanged


className: FUpdateContextDefinition

description: Defines the behavior to use during an update check.

AdditionalTags

type: TSet<FString>

description: Additional tags for extensibility.

bCheckAvailabilityOnly

type: bool

description: Whether to perform an update, or to only check for the presence of an update.

bEnabled

description: Whether to perform any checks.

bPatchCheckEnabled

description: Whether to check for patches during the update process.

bPlatformEnvironmentDetectionEnabled

description: Whether to attempt detection of the platforms environment.

Name

type: FString

description: The name used to lookup the context definition.


className: LexToString

code: [FString](API\Runtime\Core\Containers\FString) LexToString ( [EUpdateCompletionStatus](API\Plugins\Hotfix\EUpdateCompletionStatus) Status )


code: virtual [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) AddOnHotfixCompleteDelegate_Handle ( const [FOnHotfixCompleteDelegate](API\Plugins\Hotfix\FOnHotfixCompleteDelegate) & Delegate )


code: virtual [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) AddOnHotfixProcessedFileDelegate_Handle ( const [FOnHotfixProcessedFileDelegate](API\Plugins\Hotfix\FOnHotfixProcessedFileDelegate) & Delegate )


code: virtual [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) AddOnHotfixProgressDelegate_Handle ( const [FOnHotfixProgressDelegate](API\Plugins\Hotfix\FOnHotfixProgressDelegate) & Delegate )


code: virtual [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) AddOnHotfixRemovedFileDelegate_Handle ( const [FOnHotfixRemovedFileDelegate](API\Plugins\Hotfix\FOnHotfixRemovedFileDelegate) & Delegate )


code: virtual [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) AddOnHotfixUpdatedFileDelegate_Handle ( const [FOnHotfixUpdatedFileDelegate](API\Plugins\Hotfix\FOnHotfixUpdatedFileDelegate) & Delegate )


description: Looks at each file returned via the hotfix and processes them


description:
Called when a file needs custom processing (see above). Override this to provide your own processing methods
whether the file was successfully processed

code: virtual bool ApplyHotfixProcessing ( const [FCloudFileHeader](API\Plugins\OnlineSubsystem\FCloudFileHeader) & FileHeader )


description: Stores off the INI file for restoration later

code: [FConfigFileBackup](API\Plugins\Hotfix\UOnlineHotfixManager\FConfigFileBackup) & BackupIniFile ( const [FString](API\Runtime\Core\Containers\FString) & IniName, const [FConfigFile](API\Runtime\Core\Misc\FConfigFile) * ConfigFile )


description: the config cache key used to associate ini file entries within the config cache

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


description: Builds the list of files that are different between two runs of the hotfix process

code: void BuildHotfixFileListDeltas()


description: Check for available hotfix files (but do not apply them)

code: virtual void CheckAvailability ( [FOnHotfixAvailableComplete](API\Plugins\Hotfix\FOnHotfixAvailableComplete) & InCompletionDelegate )


code: virtual void ClearOnHotfixCompleteDelegates ( void * Object )


code: virtual void ClearOnHotfixCompleteDelegate_Handle ( [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) & Handle )


code: virtual void ClearOnHotfixProcessedFileDelegate_Handle ( [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) & Handle )


code: virtual void ClearOnHotfixProcessedFileDelegates ( void * Object )


code: virtual void ClearOnHotfixProgressDelegates ( void * Object )


code: virtual void ClearOnHotfixProgressDelegate_Handle ( [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) & Handle )


code: virtual void ClearOnHotfixRemovedFileDelegate_Handle ( [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) & Handle )


code: virtual void ClearOnHotfixRemovedFileDelegates ( void * Object )


code: virtual void ClearOnHotfixUpdatedFileDelegate_Handle ( [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) & Handle )


code: virtual void ClearOnHotfixUpdatedFileDelegates ( void * Object )


className: FConfigFileBackup

code: struct FConfigFileBackup

ClassesReloaded

type: TArray<FString...

description: UClasses reloaded as a result of the current ini

ConfigData

type: FConfigFile

description: Previous ini data backed up

IniName

description: Name of the ini file backed up


description: Checks each file listed to see if it is a hotfix file to process

code: void FilterHotfixFiles()


description: Factory method that returns the configured hotfix manager

code: static [UOnlineHotfixManager](API\Plugins\Hotfix\UOnlineHotfixManager) * Get ( [UWorld](API\Runtime\Engine\Engine\UWorld) * World )


description:
Override this to change the default caching directory
the default caching directory


description: the config file entry for the ini file name in question

code: [FConfigFile](API\Runtime\Core\Misc\FConfigFile) * GetConfigFile ( const [FString](API\Runtime\Core\Containers\FString) & IniName )


description: Allow the application to override the dedicated server filename prefix.

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


description: Finds the header associated with the file name

code: [FCloudFileHeader](API\Plugins\OnlineSubsystem\FCloudFileHeader) * GetFileHeaderFromDLName ( const [FString](API\Runtime\Core\Containers\FString) & FileName )


description: the human readable name of the file

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


description: the config file name after stripping any extra info (platform, debug prefix, etc.)

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


description: our current world

code: [UWorld](API\Runtime\Engine\Engine\UWorld) * GetWorld() const


description:
Override this to change the default INI file handling (merge delta INI changes into the config cache)
whether the merging was successful or not

code: virtual bool HotfixIniFile ( const [FString](API\Runtime\Core\Containers\FString) & FileName, const [FString](API\Runtime\Core\Containers\FString) & IniData )


description: Override this to change the default PAK file handling:

code: virtual bool HotfixPakFile ( const [FCloudFileHeader](API\Plugins\OnlineSubsystem\FCloudFileHeader) & FileHeader )


className: FPendingFileDLProgress

code: struct FPendingFileDLProgress


description: Used in PatchAssetsFromIniFiles to hotfix only a row in a table. If ChangedTables is not null then HandleDataTableChanged will not be called and the caller should call it on the data tables in ChangedTables when they're ready to

code: void HotfixRowUpdate ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * Asset, const [FString](API\Runtime\Core\Containers\FString) & AssetPath, const [FString](API\Runtime\Core\Containers\FString) & RowName, const [FString](API\Runtime\Core\Containers\FString) & ColumnName, const [FString](API\Runtime\Core\Containers\FString) & NewValue, [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & ProblemStrings, [TSet](API\Runtime\Core\Containers\TSet)< class [UDataTable](API\Runtime\Engine\Engine\UDataTable) * > * ChangedTables )


description:
Override this to change the default INI file handling (merge whole INI files into the config cache)
whether the merging was successful or not

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


description: Used in PatchAssetsFromIniFiles to hotfix an entire table.

code: void HotfixTableUpdate ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * Asset, const [FString](API\Runtime\Core\Containers\FString) & AssetPath, const [FString](API\Runtime\Core\Containers\FString) & JsonData, [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & ProblemStrings )


description:
Is this hotfix file compatible with the current build If the file has version information it is compared with compatibility If the file has NO version information it is assumed compatible
true if file is compatible, false otherwise

code: bool IsCompatibleHotfixFile ( const [FString](API\Runtime\Core\Containers\FString) & InFilename, [FString](API\Runtime\Core\Containers\FString) & OutFilename )


code: bool IsMapLoaded ( const [FString](API\Runtime\Core\Containers\FString) & MapName )


description: Called once the list of hotfix files has been retrieved

code: void OnEnumerateFilesComplete ( bool bWasSuccessful, const [FString](API\Runtime\Core\Containers\FString) & ErrorStr )


description: Called once the list of hotfix files has been retrieved and we only want to see if a hotfix is necessary

code: void OnEnumerateFilesForAvailabilityComplete ( bool bWasSuccessful, const [FString](API\Runtime\Core\Containers\FString) & ErrorStr, [FOnHotfixAvailableComplete](API\Plugins\Hotfix\FOnHotfixAvailableComplete) InCompletionDelegate )


description: Notify used byCheckAvailability()

code: virtual void OnHotfixAvailablityCheck ( const [TArray](API\Runtime\Core\Containers\TArray)< [FCloudFileHeader](API\Plugins\OnlineSubsystem\FCloudFileHeader) > & PendingChangedFiles, const [TArray](API\Runtime\Core\Containers\TArray)< [FCloudFileHeader](API\Plugins\OnlineSubsystem\FCloudFileHeader) > & PendingRemoveFiles )


code: virtual void OnHotfixTableValueDouble ( [UObject](API\Runtime\CoreUObject\UObject\UObject) & Asset, const [FString](API\Runtime\Core\Containers\FString) & RowName, const [FString](API\Runtime\Core\Containers\FString) & ColumnName, const double & OldValue, const double & NewValue )


code: virtual void OnHotfixTableValueFloat ( [UObject](API\Runtime\CoreUObject\UObject\UObject) & Asset, const [FString](API\Runtime\Core\Containers\FString) & RowName, const [FString](API\Runtime\Core\Containers\FString) & ColumnName, const float & OldValue, const float & NewValue )


description: Called after modifying table values byHotfixRowUpdate()

code: virtual void OnHotfixTableValueInt64 ( [UObject](API\Runtime\CoreUObject\UObject\UObject) & Asset, const [FString](API\Runtime\Core\Containers\FString) & RowName, const [FString](API\Runtime\Core\Containers\FString) & ColumnName, const int64 & OldValue, const int64 & NewValue )


code: virtual void OnHotfixTableValueName ( [UObject](API\Runtime\CoreUObject\UObject\UObject) & Asset, const [FString](API\Runtime\Core\Containers\FString) & RowName, const [FString](API\Runtime\Core\Containers\FString) & ColumnName, const [FName](API\Runtime\Core\UObject\FName) & OldValue, const [FName](API\Runtime\Core\UObject\FName) & NewValue )


code: virtual void OnHotfixTableValueObject ( [UObject](API\Runtime\CoreUObject\UObject\UObject) & Asset, const [FString](API\Runtime\Core\Containers\FString) & RowName, const [FString](API\Runtime\Core\Containers\FString) & ColumnName, const [UObject](API\Runtime\CoreUObject\UObject\UObject) * OldValue, const [UObject](API\Runtime\CoreUObject\UObject\UObject) * NewValue )


code: virtual void OnHotfixTableValueSoftObject ( [UObject](API\Runtime\CoreUObject\UObject\UObject) & Asset, const [FString](API\Runtime\Core\Containers\FString) & RowName, const [FString](API\Runtime\Core\Containers\FString) & ColumnName, const [FSoftObjectPtr](API\Runtime\CoreUObject\UObject\FSoftObjectPtr) & OldValue, const [FSoftObjectPtr](API\Runtime\CoreUObject\UObject\FSoftObjectPtr) & NewValue )


code: virtual void OnHotfixTableValueString ( [UObject](API\Runtime\CoreUObject\UObject\UObject) & Asset, const [FString](API\Runtime\Core\Containers\FString) & RowName, const [FString](API\Runtime\Core\Containers\FString) & ColumnName, const [FString](API\Runtime\Core\Containers\FString) & OldValue, const [FString](API\Runtime\Core\Containers\FString) & NewValue )


description: Called as files are downloaded to determine when to apply the hotfix data

code: void OnReadFileComplete ( bool bWasSuccessful, const [FString](API\Runtime\Core\Containers\FString) & FileName )


description: Called as files are downloaded to provide progress notifications

code: void OnReadFileProgress ( const [FString](API\Runtime\Core\Containers\FString) & FileName, uint64 BytesRead )


description: Called after any hotfixes are applied to apply last-second changes to certain asset types from .ini file data

code: virtual void PatchAssetsFromIniFiles()


description: Called after the C++ constructor and after the properties have been initialized, including those loaded from config. This is called before any serialization or other setup has happened.

code: virtual void PostInitProperties()


description:
Called prior to reading the file data.
whether the file was successfully preprocessed

code: virtual bool PreProcessDownloadedFileData ( [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & FileData ) const


code: virtual bool PreProcessDownloadedFileData ( const [FCloudFileHeader](API\Plugins\OnlineSubsystem\FCloudFileHeader) & FileHeader, [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & FileData ) const


description: Starts the async reading process for the hotfix files

code: void ReadHotfixFiles()


description: Restores any changed INI files to their default loaded state

code: void RestoreBackupIniFiles()


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


code: virtual bool ShouldPerformHotfix()


description: Starts the fetching of hotfix data from the OnlineTitleFileInterface that is registered for this game

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Hotfix") virtual void StartHotfixProcess()


description: Cleans up and fires the delegate indicating it's done

code: void TriggerHotfixComplete ( [EHotfixResult](API\Plugins\Hotfix\EHotfixResult) HotfixResult )


code: virtual void TriggerOnHotfixCompleteDelegates ( [EHotfixResult](API\Plugins\Hotfix\EHotfixResult) Param1 )


code: virtual void TriggerOnHotfixProcessedFileDelegates ( const [FString](API\Runtime\Core\Containers\FString) & Param1, const [FString](API\Runtime\Core\Containers\FString) & Param2 )


code: virtual void TriggerOnHotfixProgressDelegates ( uint32 Param1, uint32 Param2, uint64 Param3, uint64 Param4 )


code: virtual void TriggerOnHotfixRemovedFileDelegates ( const [FString](API\Runtime\Core\Containers\FString) & Param1 )


code: virtual void TriggerOnHotfixUpdatedFileDelegates ( const [FString](API\Runtime\Core\Containers\FString) & Param1, const [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & Param2 )


description: Unmounts any changed PAK files so they can be re-mounted after downloading

code: void UnmountHotfixFiles()


description: Fires the progress delegate with our updated progress

code: void UpdateProgress ( uint32 FileCount, uint64 UpdateSize )


description:
Override this method to look at the file information for any game specific hotfix processing NOTE: Make sure to call Super to get default handling of files
true if the file needs some kind of processing, false to have hotfixing ignore the file

code: virtual bool WantsHotfixProcessing ( const [FCloudFileHeader](API\Plugins\OnlineSubsystem\FCloudFileHeader) & FileHeader )


code: UOnlineHotfixManager ( [FVTableHelper](API\Runtime\CoreUObject\UObject\FVTableHelper) & Helper )


className: UOnlineHotfixManager

description: This class manages the downloading and application of hotfix data Hotfix data is a set of non-executable files downloaded and applied to the game. The base implementation knows how to handle INI, PAK, and locres files. NOTE: Each INI/PAK file must be prefixed by the platform name they are targeted at

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Config=Engine) class UOnlineHotfixManager : public [UObject](API\Runtime\CoreUObject\UObject\UObject)

AssetsHotfixedFromIniFiles

type: TArray<TObject...

description: Array of objects that we're forcing to remain resident because we've applied live hotfixes and won't get an opportunity to reapply changes if the object is evicted from memory.

AsyncFlushContext

type: TUniquePtr<FAs...

description: Asynchronously flush async loading before starting the hotfixing process.

bHotfixingInProgress

description: Some title file interfaces aren't re-entrant so handle it ourselves

bHotfixNeedsMapReload

description: Set to true if any PAK file contains an update to a level that is currently loaded

bLogMountedPakContents

description: Whether we want to log all of the files that are in a mounted pak file or not

ChangedHotfixFileList

type: TArray<FCloudF...

description: The set of hotfix files that have changed from the last time we applied them

ChangedOrRemovedPakCount

description: If we have removed or changed a currently mounted PAK file, then we'll need to restart the app because there's no simple undo for objects that were loaded and possibly rooted

DebugPrefix

description: Used to prevent development work from interfering with playtests, etc.

DefaultPrefix

description: Normally will be "Default" but could be different if we have a debug prefix

GameContentPath

description: Holds a chunk of string that will be swapped for Game during processing pak files (MyGame/Content/Maps -> /Game/Maps)

HotfixFileList

description: The filtered list of files that are part of the hotfix

HotfixManagerClassName

description: Tells the factory method which class to contruct

IniBackups

type: TArray<FConfig...

description: Backup copies of INI files that change during hotfixing so they can be undone afterward

LastHotfixFileList

description: The last set of hotfix files that was applied so we can determine whether we are up to date or not

MountedPakFiles

description: Holds which files have been mounted for unmounting

OnEnumerateFilesCompleteDelegate

type: FOnEnumerateFil...

description: Callbacks for when the title file interface is done

OnEnumerateFilesCompleteDelegateHandle

type: FDelegateHandle

OnHotfixCompleteDelegates

type: FOnHotfixComple...

description: Delegate fired when the hotfix process has completed

OnHotfixProcessedFileDelegates

type: FOnHotfixProces...

description: Delegate fired for each new/updated file after it is applied

OnHotfixProgressDelegates

type: FOnHotfixProgre...

description: Delegate fired as the hotfix files are read

OnHotfixRemovedFileDelegates

type: FOnHotfixRemove...

description: Delegate fired for each removed file

OnHotfixUpdatedFileDelegates

type: FOnHotfixUpdate...

description: Delegate fired for each added/updated file

OnlineTitleFile

type: IOnlineTitleFil...

description: The online interface to use for downloading the hotfix files

OnReadFileCompleteDelegate

type: FOnReadFileComp...

OnReadFileProgressDelegate

type: FOnReadFileProg...

OSSName

description: Tells the hotfix manager which OSS to use. Uses the default if empty

OwnerWorld

type: TWeakObjectPtr<...

description: Our passed-in World

PendingHotfixFiles

type: TMap<FString, ...

description: Holds which files are pending download

PlatformPrefix

description: Used to match any PAK files for this platform

RemovedHotfixFileList

description: The set of hotfix files that have been removed from the last time we applied them

ServerPrefix

description: Used to match any server-only hotfixes

TotalBytes

description: Tracks the size of the files being processed as part of the hotfix

TotalFiles

description: Tracks how many files are being processed as part of the hotfix


description: Announce that the update check has completed

code: virtual void CheckComplete ( [EUpdateCompletionStatus](API\Plugins\Hotfix\EUpdateCompletionStatus) Result, bool bUpdateTimestamp )


className: DelayCb

description: Fire a delegate after a given amount of time

code: typedef [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< void(void)> DelayCb


description: true if update checks are enabled

code: virtual bool ChecksEnabled() const


description: true if the backend environment requires update checks

code: virtual bool EnvironmentWantsPatchCheck() const


className: EUpdateStartResult

code: enum EUpdateStartResult { None, UpdateStarted, UpdateCached, }


description: the last result of the update manager


description: a pointer to the game instance

code: [UGameInstance](API\Runtime\Engine\Engine\UGameInstance) * GetGameInstance() const


description: the load progress (0..1)

code: float GetLoadProgress() const


description: a pointer to the hotfix manager

code: template<typename THotfixManager> THotfixManager * GetHotfixManager() const


description: the current state of the update check process


description: a pointer to the world

code: [UWorld](API\Runtime\Engine\Engine\UWorld) * GetWorld() const


description: Initial preload of assets is complete

code: virtual void InitialPreloadComplete()


description: true if at least one update been completed

code: bool HasCompletedInitialUpdate() const


description: Availability check complete

code: virtual void HotfixAvailabilityCheckComplete ( [EHotfixResult](API\Plugins\Hotfix\EHotfixResult) Result )


code: void InstallBundlePatchCheckComplete ( EInstallBundleManagerPatchCheckResult PatchResult )


description: true if the update manager is actively checking

code: bool IsActivelyUpdating() const


description: true if blocking for initial load is enabled


description: true if hotfixing is enabled

code: bool IsHotfixingEnabled() const


description: true if the update manager is actively checking or about to

code: bool IsUpdating() const


description: Called when application has been reactivated


description: Called when application is about to be deactivated


description: Callback when detecting platform environment completes

code: void OnDetectPlatformEnvironmentComplete ( const [FOnlineError](API\Plugins\OnlineSubsystem\FOnlineError) & Result )


code: virtual void OnHotfixCheckComplete ( [EHotfixResult](API\Plugins\Hotfix\EHotfixResult) Result )


code: virtual void OnHotfixProcessedFile ( const [FString](API\Runtime\Core\Containers\FString) & FriendlyName, const [FString](API\Runtime\Core\Containers\FString) & CachedName )


code: virtual void OnHotfixProgress ( uint32 NumDownloaded, uint32 TotalFiles, uint64 NumBytes, uint64 TotalBytes )


description: delegate triggered when update check is complete


description: delegate triggered when hotfix file is applied


description: delegate triggered when update status has changed


description: delegate triggered when hotfix file download progress has been made


code: void PatchCheckComplete ( [EPatchCheckResult](API\Plugins\PatchCheck\EPatchCheckResult) PatchResult )


description: Called after the C++ constructor and after the properties have been initialized, including those loaded from config. This is called before any serialization or other setup has happened.

code: virtual void PostInitProperties()


description: Put the update manager in a pending state so it can alert the game that a check is imminent

code: void SetPending()


description: Reset so you can call StartCheck again

code: virtual void Reset()


description: Register deactivate/reactivate delegates

code: void RegisterDelegates()


description: Called from ReloadConfig after the object has reloaded its configuration data.

code: virtual void PostReloadConfig ( [FProperty](API\Runtime\CoreUObject\UObject\FProperty) * PropertyThatWasLoaded )


description: Start an patch and hotfix check

code: virtual void StartCheck ( bool bInCheckHotfixOnly )


description: Change the state of the update manager

code: virtual void SetUpdateState ( [EUpdateState](API\Plugins\Hotfix\EUpdateState) NewState )


description:
Internal call for StartCheck
whether or not the check started, returned a cached value, or did nothing (already in progress)

code: virtual [EUpdateStartResult](API\Plugins\Hotfix\UUpdateManager\EUpdateStartResult) StartCheckInternal ( bool bInCheckHotfixOnly )


description: Check for the availability of changed hotfix files only


description: Hotfix check

code: virtual void StartHotfixCheck()


description: Preload game assets after patch/hotfix check is complete but before game is alerted

code: virtual void StartInitialPreload()


description: Patch check

code: virtual void StartPatchCheck()


description: Query for platform environment before continuing with hotfixing This configures the Mcp backend correctly


description: Start an update check using properties defined by context.

code: void StartUpdateCheck ( const [FString](API\Runtime\Core\Containers\FString) & ContextName )


description: Tick function during initial preload

code: virtual bool Tick ( float DeltaTime )


description:
Internal call for StartUpdateCheck
whether or not the check started, returned a cached value, or did nothing (already in progress)

code: virtual [EUpdateStartResult](API\Plugins\Hotfix\UUpdateManager\EUpdateStartResult) StartUpdateCheckInternal ( const [FUpdateContextDefinition](API\Plugins\Hotfix\FUpdateContextDefinition) & ContextDefinition )


description: Unregister deactivate/reactivate delegates

code: void UnregisterDelegates()


className: UUpdateManager

description: Checks the system and/or backend for the possibility of a patch and hotfix Will not apply a hotfix if a pending patch is available Notifies the game of the result of the check

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Config=Engine) class UUpdateManager : public [UObject](API\Runtime\CoreUObject\UObject\UObject)

AppSuspendedUpdateCheckTimeSeconds

description: If application is suspended longer than this, trigger an update check when resuming

bCheckHotfixAvailabilityOnly

type: bool

description: Is this run only checking and not applying

bInitialUpdateFinished

description: Has the first update completed

bPlatformEnvironmentDetected

description: True if we've already detected the backend environment

CurrentUpdateState

type: EUpdateState

description: Current state of the update

DeactivatedTime

type: FDateTime

description: Time when application was deactivated

HotfixAvailabilityCheckCompleteDelay

type: float

description: Amount of time to wait between the internal hotfix availability check completing and advancing to the next stage

HotfixCheckCompleteDelay

description: Amount of time to wait between the internal hotfix check completing and advancing to the next stage

HotfixCompleteDelegateHandle

description: Delegates to hotfix updates

LastCompletionResult

type: EUpdateCompleti...

description: Last update check result (0:normal, 1:availability only)

LastHotfixResult

type: EHotfixResult

description: Result of the last hotfix

LastPatchCheckResult

type: EInstallBundleM...

description: Result of the last patch check

LastUpdateCheck

description: Timestamp of last update check (0:normal, 1:availability only)

LoadStartTime

type: double

description: The time at which we started the initial load after updates completed

UpdateCheckAvailabilityCompleteDelay

description: Amount of time to wait at the end of the entire check before notifying listening entities (availability check only)

UpdateCheckCachedResponseDelay

description: Amount of time to wait before returning a cached response when updates are started.

UpdateCheckStartDelay

description: Amount of time to wait before starting an update check.

WorstNumFilesPendingLoadViewed

description: What was the maximum number of pending async loads we've seen so far


module: HTNPlanner

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


className: UHTNBrainComponent

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)() class UHTNBrainComponent : public [UBrainComponent](API\Runtime\AIModule\UBrainComponent)

Planner

type: FHTNPlanner


className: EHTNWorldStateCheck

code: enum EHTNWorldStateCheck { Less, LessOrEqual, Equal, NotEqual, GreaterOrEqual, Greater, IsTrue, MAX, }


className: FActionID

code: typedef uint16 FActionID


className: EHTNWorldStateOperation

code: enum EHTNWorldStateOperation { Set, Increase, Decrease, MAX, }


className: FActionParameter

code: typedef int32 FActionParameter


className: FConditionFunctionPtr

code: typedef bool(* FConditionFunctionPtr


code: [FHTNBuilder_Method](API\Plugins\HTNPlanner\FHTNBuilder_Method) & AddMethod ( const [FHTNCondition](API\Plugins\HTNPlanner\FHTNCondition) & Condition )


code: [FHTNBuilder_Method](API\Plugins\HTNPlanner\FHTNBuilder_Method) & AddMethod ( const [TArray](API\Runtime\Core\Containers\TArray)< [FHTNCondition](API\Plugins\HTNPlanner\FHTNCondition) > & Conditions )


code: struct FHTNBuilder_CompositeTask

Methods

type: TArray<FHTNBui...


code: [FHTNBuilder_CompositeTask](API\Plugins\HTNPlanner\FHTNBuilder_CompositeTask) & AddCompositeTask ( const [FName](API\Runtime\Core\UObject\FName) & TaskName )


code: [FHTNBuilder_PrimitiveTask](API\Plugins\HTNPlanner\FHTNBuilder_PrimitiveTask) & AddPrimitiveTask ( const [FName](API\Runtime\Core\UObject\FName) & TaskName )


description:
Optimizes stored information. After the Domain is compiled it's impossible to extend it
true if compilation was successful. False otherwise, look for warnings and errors in the log

code: bool Compile()


description: Using DomainInstance information populate this domain builder instance

code: void Decompile()


code: [FHTNBuilder_CompositeTask](API\Plugins\HTNPlanner\FHTNBuilder_CompositeTask) * FindCompositeTask ( const [FName](API\Runtime\Core\UObject\FName) & TaskName )


code: [FHTNBuilder_PrimitiveTask](API\Plugins\HTNPlanner\FHTNBuilder_PrimitiveTask) * FindPrimitiveTask ( const [FName](API\Runtime\Core\UObject\FName) & TaskName )


code: void SetRootName ( const [FName](API\Runtime\Core\UObject\FName) InRootName )


code: FHTNBuilder_Domain ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FHTNDomain](API\Plugins\HTNPlanner\FHTNDomain) > & InDomain )


code: struct FHTNBuilder_Domain

CompositeTasks

type: TMap<FName,FH...

DomainInstance

type: TSharedPtr<FHT...

RootTaskName

type: FName


code: void AddTask ( const [FName](API\Runtime\Core\UObject\FName) & TaskName )


code: FHTNBuilder_Method ( const [FHTNCondition](API\Plugins\HTNPlanner\FHTNCondition) & InCondition )


code: FHTNBuilder_Method ( const [TArray](API\Runtime\Core\Containers\TArray)< [FHTNCondition](API\Plugins\HTNPlanner\FHTNCondition) > & InConditions )


code: struct FHTNBuilder_Method

Conditions

type: TArray<FHTNCon...

Tasks

type: TArray<FName>


code: void AddEffect ( const [FHTNEffect](API\Plugins\HTNPlanner\FHTNEffect) & Effect )


code: void SetOperator ( const uint32 InActionID, const uint32 InParameter )


code: template<typename A, typename B> void SetOperator ( const A InActionID, const B InParameter )


code: struct FHTNBuilder_PrimitiveTask

Effects

type: TArray<FHTNEff...


code: int32 FindSatisfiedMethod ( const [FHTNWorldState](API\Plugins\HTNPlanner\FHTNWorldState) & WorldState, const int32 StartIndex ) const


className: FHTNCompositeTask

code: struct FHTNCompositeTask

Methods

type: FHTNMethod*...


code: [FHTNPolicy::FTaskID](API\Plugins\HTNPlanner\FTaskID) FindTaskID ( const [FName](API\Runtime\Core\UObject\FName) & TaskName ) const


code: const [FHTNCompositeTask](API\Plugins\HTNPlanner\FHTNCompositeTask) & GetCompositeTask ( const [FHTNPolicy::FTaskID](API\Plugins\HTNPlanner\FTaskID) TaskID ) const


code: const [FHTNPrimitiveTask](API\Plugins\HTNPlanner\FHTNPrimitiveTask) & GetPrimitiveTask ( const [FHTNPolicy::FTaskID](API\Plugins\HTNPlanner\FTaskID) TaskID ) const


description: This information is available only if WITH_HTN_DEBUG

code: [FName](API\Runtime\Core\UObject\FName) GetTaskName ( const [FHTNPolicy::FTaskID](API\Plugins\HTNPlanner\FTaskID) TaskID ) const


code: bool IsCompositeTask ( const [FHTNPolicy::FTaskID](API\Plugins\HTNPlanner\FTaskID) TaskID ) const


code: bool IsPrimitiveTask ( const [FHTNPolicy::FTaskID](API\Plugins\HTNPlanner\FTaskID) TaskID ) const


className: FHTNDomain

code: struct FHTNDomain : public [TSharedFromThis< FHTNDomain >](API\Runtime\Core\Templates\TSharedFromThis)

RawData

type: uint8 *

description: TArrayTasks;.

RootTaskID

description: Root task is the default task we start planning from

TaskIDToName

type: TMap<FHTNPolic...


code: bool operator== ( const [FHTNExecutableAction](API\Plugins\HTNPlanner\FHTNExecutableAction) & Other ) const


className: FHTNExecutableAction

code: struct FHTNExecutableAction

ActionID

description: Operation ID (Move, Attack, Use, ...)

Parameter

description: Operand ID (Enemy, Table, CoverLocation, ...)


className: FHTNMethod

code: struct FHTNMethod

Conditions

type: FHTNCondition&...


code: void AddToPlan ( const [FHTNPolicy::FTaskID](API\Plugins\HTNPlanner\FTaskID) CurrentTask )


code: bool GeneratePlan ( const [FHTNDomain](API\Plugins\HTNPlanner\FHTNDomain) & Domain, const [FHTNWorldState](API\Plugins\HTNPlanner\FHTNWorldState) & InitialWorldState, [FHTNResult](API\Plugins\HTNPlanner\FHTNResult) & Result, const [FName](API\Runtime\Core\UObject\FName) & StartTaskName )


code: const [TArray](API\Runtime\Core\Containers\TArray)< [FHTNPolicy::FTaskID](API\Plugins\HTNPlanner\FTaskID) > GetPlan() const


code: const [FHTNWorldState](API\Plugins\HTNPlanner\FHTNWorldState) & GetWorldState() const


className: InitialResporePoints

code: enum { InitialResporePoints = 5 }


code: void RecordDecomposition ( const [FHTNPolicy::FTaskID](API\Plugins\HTNPlanner\FTaskID) CurrentTask, const int32 MethodIndex )


className: FHTNPlanner

code: struct FHTNPlanner

CurrentState

type: FHTNRestorePoin...

RestorePoints

type: TArray<FHTNRes...

description: The array where consecutive restore points are stored.

RestorePointsStored

description: Used for bookkeeping RestorePoints contents

TasksToProcess

type: TArray<FHTNPol...


className: FHTNPrimitiveTask

code: struct FHTNPrimitiveTask : public [FHTNExecutableAction](API\Plugins\HTNPlanner\FHTNExecutableAction)

Effects

type: FHTNEffect*...

description: Effect (applied to world state when this task is used)


className: InitialPlanSize

code: enum { InitialPlanSize = 5 }


code: FHTNRestorePoint ( const [FHTNWorldState](API\Plugins\HTNPlanner\FHTNWorldState) & InWorldState )


code: FHTNRestorePoint ( const [FHTNRestorePoint](API\Plugins\HTNPlanner\FHTNRestorePoint) & PreviousPoint, const [FHTNPolicy::FTaskID](API\Plugins\HTNPlanner\FTaskID) CurrentTask, const int32 InNextMethod )


className: FHTNRestorePoint

code: struct FHTNRestorePoint

WorldState

type: FHTNWorldState


code: void Set ( const [FHTNDomain](API\Plugins\HTNPlanner\FHTNDomain) & Domain, const [TArray](API\Runtime\Core\Containers\TArray)< [FHTNPolicy::FTaskID](API\Plugins\HTNPlanner\FTaskID) > & TasksSequence )


code: void ApplyEffects ( const [FHTNEffect](API\Plugins\HTNPlanner\FHTNEffect) * Effects, const int32 EffectsCount )


code: void ApplyEffect ( const [FHTNEffect](API\Plugins\HTNPlanner\FHTNEffect) & Effect )


className: FHTNResult

code: struct FHTNResult

ActionsSequence

type: TArray<FHTNExe...


code: bool CheckCondition ( const [FHTNCondition](API\Plugins\HTNPlanner\FHTNCondition) & Condition ) const


code: bool CheckConditions ( const [FHTNCondition](API\Plugins\HTNPlanner\FHTNCondition) * Conditions, const int32 ConditionsCount ) const


code: bool GetValue ( const [FHTNPolicy::FWSKey](API\Plugins\HTNPlanner\FWSKey) Key, [FHTNPolicy::FWSValue](API\Plugins\HTNPlanner\FWSValue) & OutValue ) const


code: [FHTNPolicy::FWSValue](API\Plugins\HTNPlanner\FWSValue) GetValueUnsafe ( const [FHTNPolicy::FWSKey](API\Plugins\HTNPlanner\FWSKey) Key ) const


code: void Reinit ( const uint32 NewWorldStateSize )


code: bool SetValue ( const [FHTNPolicy::FWSKey](API\Plugins\HTNPlanner\FWSKey) Key, const [FHTNPolicy::FWSValue](API\Plugins\HTNPlanner\FWSValue) InValue )


code: void SetValueUnsafe ( const [FHTNPolicy::FWSKey](API\Plugins\HTNPlanner\FWSKey) Key, const [FHTNPolicy::FWSValue](API\Plugins\HTNPlanner\FWSValue) InValue )


code: FHTNWorldState ( const uint32 WorldStateSize )


className: FHTNWorldState

code: struct FHTNWorldState


className: FMethodID

code: typedef uint16 FMethodID


className: FOperationFunctionPtr

code: typedef void(* FOperationFunctionPtr


className: FWSOperationID

code: typedef uint8 FWSOperationID


className: FWSValue

code: typedef int32 FWSValue


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

code: static [IHTNPlannerModule](API\Plugins\HTNPlanner\IHTNPlannerModule) & Get()


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

code: static bool IsAvailable()


className: IHTNPlannerModule

description: The public interface to this module

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


className: FOperationEnum

code: typedef TOperationEnum FOperationEnum


code: [THTNWorldStateOperation](API\Plugins\HTNPlanner\THTNWorldStateOperation)< TOperationEnum > & SetRHSAsValue ( const [FHTNPolicy::FWSValue](API\Plugins\HTNPlanner\FWSValue) InValue )


code: [THTNWorldStateOperation](API\Plugins\HTNPlanner\THTNWorldStateOperation)< TOperationEnum > & SetRHSAsWSKey ( const [FHTNPolicy::FWSKey](API\Plugins\HTNPlanner\FWSKey) InKeyRightHand )


code: template<typename TAlternativeKey> [THTNWorldStateOperation](API\Plugins\HTNPlanner\THTNWorldStateOperation)< TOperationEnum > & SetRHSAsWSKey ( const TAlternativeKey InKeyRightHand )


code: THTNWorldStateOperation ( const [FHTNPolicy::FWSKey](API\Plugins\HTNPlanner\FWSKey) InKeyLeftHand, const [FHTNPolicy::FWSOperationID](API\Plugins\HTNPlanner\FWSOperationID) InOperation )


code: THTNWorldStateOperation ( const [FHTNPolicy::FWSKey](API\Plugins\HTNPlanner\FWSKey) InKeyLeftHand, const [FOperationEnum](API\Plugins\HTNPlanner\THTNWorldStateOperation\FOperationEnum) InOperation )


code: template<typename TAlternativeKey> THTNWorldStateOperation ( const TAlternativeKey InKeyLeftHand, const [FOperationEnum](API\Plugins\HTNPlanner\THTNWorldStateOperation\FOperationEnum) InOperation )


className: THTNWorldStateOperation

code: template<typename TOperationEnum> struct THTNWorldStateOperation

KeyLeftHand

type: constFHTNPolic...


module: HTNTestSuite

code: static [IHTNTestSuiteModule](API\Plugins\HTNTestSuite\IHTNTestSuiteModule) & Get()


className: IHTNTestSuiteModule

description: The public interface to this module

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


className: EHttpVerbs

module: HttpBlueprint

code: enum EHttpVerbs { Post = 0, Put = 1, Delete = 2, Patch = 3, Get = 4, MAX = 255, }


className: ERequestPresets

code: enum ERequestPresets { Json, Http, Url, Custom, }


description: Convenience function to set all of the headers in the internal header map on the request object.

code: void AssignHeadersToRequest ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< class [IHttpRequest](API\Runtime\HTTP\Interfaces\IHttpRequest) > & Request )


description: Adds a new header key/value pair to the internal header map

code: void AddHeader ( TPair< [FString](API\Runtime\Core\Containers\FString), [FString](API\Runtime\Core\Containers\FString) > && NewHeader )


description: Returns the internal header map as an array

code: [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > GetAllHeaders() const


description: Returns a copy of the internal header map

code: const [TMap](API\Runtime\Core\Containers\TMap)< [FString](API\Runtime\Core\Containers\FString), [FString](API\Runtime\Core\Containers\FString) > & GetAllHeadersAsMap() const


description: Returns the header value associated with the Key

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


description: Returns if the header is valid or not. This is done by checking the map size

code: bool IsValid() const


description: Removes a header from the internal header map

code: bool RemoveHeader ( [FString](API\Runtime\Core\Containers\FString) && HeaderToRemove )


description: Sets the internal headers. Will overwrite any headers already in the map

code: [FHttpHeader](API\Plugins\HttpBlueprint\FHttpHeader) SetHeaders ( const [TMap](API\Runtime\Core\Containers\TMap)< [FString](API\Runtime\Core\Containers\FString), [FString](API\Runtime\Core\Containers\FString) > & NewHeaders )


className: FHttpHeader

description: Provides a way for blueprint to create and store a map of HTTP headers


className: operator&

code: constexpr [EHttpVerbs](API\Plugins\HttpBlueprint\EHttpVerbs) operator& ( [EHttpVerbs](API\Plugins\HttpBlueprint\EHttpVerbs) Lhs, [EHttpVerbs](API\Plugins\HttpBlueprint\EHttpVerbs) Rhs )


className: operator&=

code: [EHttpVerbs](API\Plugins\HttpBlueprint\EHttpVerbs) & operator&= ( [EHttpVerbs](API\Plugins\HttpBlueprint\EHttpVerbs) & Lhs, [EHttpVerbs](API\Plugins\HttpBlueprint\EHttpVerbs) Rhs )


className: operator^

code: constexpr [EHttpVerbs](API\Plugins\HttpBlueprint\EHttpVerbs) operator^ ( [EHttpVerbs](API\Plugins\HttpBlueprint\EHttpVerbs) Lhs, [EHttpVerbs](API\Plugins\HttpBlueprint\EHttpVerbs) Rhs )


className: operator~

code: constexpr [EHttpVerbs](API\Plugins\HttpBlueprint\EHttpVerbs) operator~ ( [EHttpVerbs](API\Plugins\HttpBlueprint\EHttpVerbs) E )


className: operator^=

code: [EHttpVerbs](API\Plugins\HttpBlueprint\EHttpVerbs) & operator^= ( [EHttpVerbs](API\Plugins\HttpBlueprint\EHttpVerbs) & Lhs, [EHttpVerbs](API\Plugins\HttpBlueprint\EHttpVerbs) Rhs )


className: operator!

code: constexpr bool operator! ( [EHttpVerbs](API\Plugins\HttpBlueprint\EHttpVerbs) E )


description: HeaderObject: The structure that contains all of the headers  NewHeader: The name of the header  NewHeaderValue: The value of the new header

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Http") static void AddHeader ( [FHttpHeader](API\Plugins\HttpBlueprint\FHttpHeader) & HeaderObject, [FString](API\Runtime\Core\Containers\FString) NewHeader, [FString](API\Runtime\Core\Containers\FString) NewHeaderValue )


description: Returns all of the headers and their values by value

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintPure, Category="Http") static [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > GetAllHeaders ( const [FHttpHeader](API\Plugins\HttpBlueprint\FHttpHeader) & HeaderObject )


description: Returns all of the headers and their values as a map by value

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintPure, Category="Http", Meta=(DisplayName="GetAllHeadersAsMap")) static [TMap](API\Runtime\Core\Containers\TMap)< [FString](API\Runtime\Core\Containers\FString), [FString](API\Runtime\Core\Containers\FString) > GetAllHeaders_Map ( const [FHttpHeader](API\Plugins\HttpBlueprint\FHttpHeader) & HeaderObject )


description: HeaderObject: The structure that contains all of the headers  HeaderName: The name of the Header  OutHeaderValue: The value of the Header. Empty if the Header could not be found  Whether the operation was successful

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintPure, Category="Http") static bool GetHeaderValue ( const [FHttpHeader](API\Plugins\HttpBlueprint\FHttpHeader) & HeaderObject, [FString](API\Runtime\Core\Containers\FString) HeaderName, [FString](API\Runtime\Core\Containers\FString) & OutHeaderValue )


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintPure, BlueprintInternalUseOnly, Category="Http") static void MakeRequestHeader ( const [TMap](API\Runtime\Core\Containers\TMap)< [FString](API\Runtime\Core\Containers\FString), [FString](API\Runtime\Core\Containers\FString) > & Headers, [FHttpHeader](API\Plugins\HttpBlueprint\FHttpHeader) & OutHeader )


description: HeaderObject: The structure that contains all of the headers  HeaderToRemove: The Key of the header to remove  Whether or not the operation was successful. A value of false most likely means the Key did not exist on the HeaderObject

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Http") static bool RemoveHeader ( [FHttpHeader](API\Plugins\HttpBlueprint\FHttpHeader) & HeaderObject, [FString](API\Runtime\Core\Containers\FString) HeaderToRemove )


className: UHttpBlueprintFunctionLibrary


description: the stringified version of the enum passed in

module: HTTPChunkInstaller

code: namespace ECloudAsyncTaskState { const TCHAR * ECloudAsyncTaskState::ToString ( [ECloudAsyncTaskState::Type](API\Plugins\HTTPChunkInstaller\ECloudAsyncTaskState__Type) EnumVal ) }


description: The state of an async task (read friends, read content, write cloud file, etc) request

code: namespace ECloudAsyncTaskState { enum Type { NotStarted, InProgress, Done, Failed, } }


code: static const TCHAR * Name()


description: Exit

code: virtual uint32 Run()


code: void SetupWork ( [FString](API\Runtime\Core\Containers\FString) InManifestPath, [FString](API\Runtime\Core\Containers\FString) InHoldingManifestPath, [FString](API\Runtime\Core\Containers\FString) InSrcDir, [FString](API\Runtime\Core\Containers\FString) InDestDir, [IBuildPatchServicesModule](API\Runtime\BuildPatchServices\Interfaces\IBuildPatchServicesModule) * InBPSModule, IBuildManifestRef InBuildManifest, const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & InCurrentMountedPaks, bool bInCopy )


className: FChunkInstallTask

code: class FChunkInstallTask : public [FRunnable](API\Runtime\Core\HAL\FRunnable)

bCopy

type: bool

BPSModule

type: IBuildPatchServ...

BuildManifest

type: IBuildManifestP...

CompleteEvent

type: FEvent*

CurrentMountPaks

type: constTArray<F...

DestDir

type: FString

ManifestPath

description: Input parameters

MountedPaks

type: TArray<FString...

description: Output


code: void SetupWork ( [IBuildPatchServicesModule](API\Runtime\BuildPatchServices\Interfaces\IBuildPatchServicesModule) * InBPSModule, [FString](API\Runtime\Core\Containers\FString) InContentDir, const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & InCurrentMountedPaks, const [TSet](API\Runtime\Core\Containers\TSet)< uint32 > & InExpectedChunks )


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

code: virtual bool Visit ( const TCHAR * FilenameOrDirectory, bool bIsDirectory )


className: FChunkMountTask

code: class FChunkMountTask : public [FRunnable](API\Runtime\Core\HAL\FRunnable), public [IPlatformFile::FDirectoryVisitor](API\Runtime\Core\GenericPlatform\IPlatformFile\FDirectoryVisitor)

BPSModule

description: Input parameters

CompleteEvent

description: Output

ExpectedChunks

type: constTSet< uin...

FoundPaks

description: Working

ManifestVisitor

type: FFileSearchVisi...


code: void SetupWork ( [IBuildPatchServicesModule](API\Runtime\BuildPatchServices\Interfaces\IBuildPatchServicesModule) * InBPSModule, [FString](API\Runtime\Core\Containers\FString) InInstallDir, [FString](API\Runtime\Core\Containers\FString) InContentDir, [FString](API\Runtime\Core\Containers\FString) InHoldingDir, const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & InCurrentMountedPaks )


code: virtual ~FChunkSetupTask()


className: FChunkSetupTask

code: class FChunkSetupTask : public [FRunnable](API\Runtime\Core\HAL\FRunnable), public [IPlatformFile::FDirectoryVisitor](API\Runtime\Core\GenericPlatform\IPlatformFile\FDirectoryVisitor)

BPSModule

description: Input parameters

CompleteEvent

description: Output

FoundPaks

description: Working

HoldingChunks

type: TMultiMap< uint...


description: Constructors

code: FCloudEntry()


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


code: virtual ~FCloudEntry()


className: FCloudEntry

description: Holds the data used in downloading a file asynchronously from the online service

code: struct FCloudEntry

AsyncState

type: ECloudAsyncTask...

description: The async state the file download is in

Data

type: TArray< uint8 >

description: The buffer of data for the file

FileName

description: The name of the file as requested


code: bool operator== ( const [FCloudHeader](API\Plugins\HTTPChunkInstaller\FCloudHeader) & Other ) const


code: bool operator< ( const [FCloudHeader](API\Plugins\HTTPChunkInstaller\FCloudHeader) & Other ) const


description: Constructors

code: FCloudHeader()


code: FCloudHeader ( const [FString](API\Runtime\Core\Containers\FString) & InFileName, const [FString](API\Runtime\Core\Containers\FString) & InDLName, int32 InFileSize )


className: FCloudHeader

description: Holds metadata about a given downloadable file

code: struct FCloudHeader

ChunkID

description: The chunk id this file represents

DLName

description: Filename as downloaded

description: Logical filename, maps to the downloaded filename

FileSize

description: File size

Hash

description: Hash value, if applicable, of the given file contents

HashType

type: FName

description: The hash algorithm used to sign this file

URL

description: The full URL to download the file if it is stored in a CDN or separate host site


description: true if valid range

code: bool IsValidRange() const


code: FCloudPagedQuery ( int32 InStart, int32 InCount )


code: FFileSearchVisitor ( [FString](API\Runtime\Core\Containers\FString) InFileWildcard, [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & InFoundFiles )


className: FFileSearchVisitor

description: Helper class to find all pak/mainfests files.

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


className: ChunkInstallState

code: enum ChunkInstallState { Setup, SetupWait, QueryRemoteManifests, EnterOfflineMode, MoveInstalledChunks, RequestingTitleFiles, SearchTitleFiles, ReadTitleFiles, WaitingOnRead, ReadComplete, PostSetup, Idle, Installing, CopyToContent, }


description:
For platforms that support emulation of the Chunk install. Starts transfer of the next chunk. Does nothing in a shipping build.
true if the operation succeeds.

code: virtual bool DebugStartNextChunk()


description:
Get the current install progress of a chunk. Let the user specify report type for platforms that support more than one.
A value whose meaning is dependent on the ReportType param.

code: virtual float GetChunkProgress ( uint32 ChunkID, [EChunkProgressReportingType::Type](API\Runtime\Core\GenericPlatform\EChunkProgressReportingType__Typ-) ReportType )


className: FCloudPagedQuery

description: Paging info needed for a request that can return paged results

code: class FCloudPagedQuery

Count

description: Total entries to fetch. -1 means ALL

Start

description: First entry to fetch


description:
Inquire about the priority of chunk installation vs. game IO.
Paused, low or high priority.


description:
Hint to the installer that we would like to prioritize a specific chunk
false if the operation is not allowed or the chunk doesn't exist, otherwise true.

code: virtual bool PrioritizeChunk ( uint32 ChunkID, [EChunkPriority::Type](API\Runtime\Core\GenericPlatform\EChunkPriority__Type) Priority )


description:
Check if a given reporting type is supported.
true if reporting type is supported on the current platform.

code: virtual bool GetProgressReportingTypeSupported ( [EChunkProgressReportingType::Type](API\Runtime\Core\GenericPlatform\EChunkProgressReportingType__Typ-) ReportType )


description:
Specify the priority of chunk installation vs. game IO.
false if the operation is not allowed, otherwise true.

code: virtual bool SetInstallSpeed ( [EChunkInstallSpeed::Type](API\Runtime\Core\GenericPlatform\EChunkInstallSpeed__Type) InstallSpeed )


description:
Pure virtual that must be overloaded by the inheriting class.
true if should continue ticking

code: virtual bool Tick ( float DeltaTime )


className: FHTTPChunkInstall

description: HTTP based implementation of chunk based install

code: class FHTTPChunkInstall : public [FGenericPlatformChunkInstall](API\Runtime\Core\GenericPlatform\FGenericPlatformChunkInstall), public [FTSTickerObjectBase](API\Runtime\Core\Containers\FTSTickerObjectBase)


description:
Empties the cached data for this file if it is not being downloaded currently
true if it could be deleted, false if it could not

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


description:
Empties the set of downloaded files if possible (no async tasks outstanding)
true if they could be deleted, false if they could not

code: virtual bool ClearFiles()


description: Delete cached files on disk

code: virtual void DeleteCachedFiles ( bool bSkipEnumerated )


description: Returns the list of files that was returned by the network store

code: virtual void GetFileList ( [TArray](API\Runtime\Core\Containers\TArray)< [FCloudHeader](API\Plugins\HTTPChunkInstaller\FCloudHeader) > & Files )


description:
Copies the file data into the specified buffer for the specified file
true if the data was copied, false otherwise

code: virtual bool GetFileContents ( const [FString](API\Runtime\Core\Containers\FString) & FileName, [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & FileContents )


description:
Requests a list of available files from the network store
true if the request has started, false if not

code: virtual bool EnumerateFiles ( const [FCloudPagedQuery](API\Plugins\HTTPChunkInstaller\FCloudPagedQuery) & Page )


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


description:
Starts an asynchronous read of the specified file from the network platform's file store
true if the calls starts successfully, false otherwise

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


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


className: FLocalTitleFile

code: class FLocalTitleFile : public [ICloudTitleFile](API\Plugins\HTTPChunkInstaller\ICloudTitleFile)


className: FOnEnumerateFilesComplete

description: Delegate fired when the list of files has been returned from the network store

code: typedef TMulticastDelegate_OneParam< void, bool > FOnEnumerateFilesComplete


className: FOnEnumerateFilesCompleteDelegate


className: FOnReadFileComplete

description: Delegate fired when a file read from the network platform's storage is complete

code: typedef TMulticastDelegate_TwoParams< void, bool, const [FString](API\Runtime\Core\Containers\FString) & > FOnReadFileComplete


className: FOnReadFileCompleteDelegate


className: FOnReadFileProgress

description: Delegate fired when as file read from the network platform's storage progresses

code: typedef TMulticastDelegate_TwoParams< void, const [FString](API\Runtime\Core\Containers\FString) &, uint64 > FOnReadFileProgress


className: FOnReadFileProgressDelegate


code: virtual [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) AddOnEnumerateFilesCompleteDelegate_Handle ( const [FOnEnumerateFilesCompleteDelegate](API\Plugins\OnlineSubsystem\Interfaces\FOnEnumerateFilesCompleteDelegat-) & Delegate )


code: virtual [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) AddOnReadFileCompleteDelegate_Handle ( const [FOnReadFileCompleteDelegate](API\Plugins\OnlineSubsystem\Interfaces\FOnReadFileCompleteDelegate) & Delegate )


code: virtual [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) AddOnReadFileProgressDelegate_Handle ( const [FOnReadFileProgressDelegate](API\Plugins\OnlineSubsystem\Interfaces\FOnReadFileProgressDelegate) & Delegate )


code: bool ClearFile ( const [FString](API\Runtime\Core\Containers\FString) & FileName )


code: bool ClearFiles()


code: virtual void ClearOnEnumerateFilesCompleteDelegate_Handle ( [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) & Handle )


code: virtual void ClearOnReadFileCompleteDelegate_Handle ( [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) & Handle )


code: virtual void ClearOnReadFileProgressDelegate_Handle ( [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) & Handle )


description: Delete cached files on disk

code: void DeleteCachedFiles ( bool bSkipEnumerated )


code: bool EnumerateFiles ( const [FCloudPagedQuery](API\Plugins\HTTPChunkInstaller\FCloudPagedQuery) & Page )


code: void GetFileList ( [TArray](API\Runtime\Core\Containers\TArray)< [FCloudHeader](API\Plugins\HTTPChunkInstaller\FCloudHeader) > & Files )


code: bool ReadFile ( const [FString](API\Runtime\Core\Containers\FString) & FileName )


code: bool GetFileContents ( const [FString](API\Runtime\Core\Containers\FString) & FileName, [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & FileContents )


code: virtual void TriggerOnEnumerateFilesCompleteDelegates ( bool Param1 )


code: virtual void TriggerOnReadFileProgressDelegates ( const [FString](API\Runtime\Core\Containers\FString) & Param1, uint64 Param2 )


code: virtual void TriggerOnReadFileCompleteDelegates ( bool Param1, const [FString](API\Runtime\Core\Containers\FString) & Param2 )


code: virtual ~ICloudTitleFile()


className: ICloudTitleFile

code: class ICloudTitleFile

OnEnumerateFilesCompleteDelegates

type: FOnEnumerateFil...

OnReadFileCompleteDelegates

type: FOnReadFileComp...

OnReadFileProgressDelegates

type: FOnReadFileProg...


className: ICloudTitleFilePtr

code: typedef [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [ICloudTitleFile](API\Plugins\HTTPChunkInstaller\ICloudTitleFile), ESPMode::ThreadSafe > ICloudTitleFilePtr


className: ICloudTitleFileRef

code: typedef [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [ICloudTitleFile](API\Plugins\HTTPChunkInstaller\ICloudTitleFile), ESPMode::ThreadSafe > ICloudTitleFileRef


className: AICVFXTestLocation

description: Actor used when running ICVFX perf tests. For every test location, the display cluster root actor will be moved to this location and perf data will be connected for a minute.

module: ICVFXTesting

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Blueprintable, BlueprintType, Category="ICVFX", DisplayName="ICVFXTestLocation") class AICVFXTestLocation : public [ACameraActor](API\Runtime\Engine\Camera\ACameraActor)


code: virtual void End ( const [EICVFXAutoTestState](API\Plugins\ICVFXTesting\EICVFXAutoTestState) NewState )


className: EICVFXAutoTestState

code: enum EICVFXAutoTestState { InitialLoad, Soak, TraverseTestLocations, Finished, Shutdown, MAX, }


code: double GetTestStateTime() const


code: virtual void Start ( const [EICVFXAutoTestState](API\Plugins\ICVFXTesting\EICVFXAutoTestState) PrevState )


code: virtual void Tick ( const float TimeDelta )


code: FICVFXAutoTestState ( class [UICVFXTestControllerAutoTest](API\Plugins\ICVFXTesting\UICVFXTestControllerAutoTest) *const TestController )


code: virtual ~FICVFXAutoTestState()


className: FICVFXAutoTestState

code: class FICVFXAutoTestState

Controller

type: UICVFXTestContr...


description: Called before destroying the object. This is called immediately upon deciding to destroy the object, to allow the object to begin an asynchronous cleanup process.

code: virtual void BeginDestroy()


code: virtual void EndICVFXTest ( const int32 ExitCode )


code: double GetCurrentStateTime() const


code: int32 GetInnerGPUIndex() const


code: [FString](API\Runtime\Core\Containers\FString) GetStateName ( const [EICVFXAutoTestState](API\Plugins\ICVFXTesting\EICVFXAutoTestState) State ) const


code: [FICVFXAutoTestState](API\Plugins\ICVFXTesting\FICVFXAutoTestState) & GetTestState() const


code: void GoToTestLocation ( int32 Index )


code: void InitializeLiveLink() const


code: int32 NumTestLocations() const


description: Called when the controller is first initialized

code: virtual void OnInit()


description: Called periodically to let the controller check and control state

code: virtual void OnTick ( float TimeDelta )


description: Called prior to a map change

code: virtual void OnPreMapChange()


code: void SetInnerGPUIndex ( int32 InGPUIndex )


code: void SetTestLocations ( const [TArray](API\Runtime\Core\Containers\TArray)< [AActor](API\Runtime\Engine\GameFramework\AActor) * > TestLocations )


code: [FICVFXAutoTestState](API\Plugins\ICVFXTesting\FICVFXAutoTestState) & SetTestState ( const [EICVFXAutoTestState](API\Plugins\ICVFXTesting\EICVFXAutoTestState) NewState )


className: UICVFXTestControllerAutoTest

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)() class UICVFXTestControllerAutoTest : public [UICVFXTestControllerBase](API\Plugins\ICVFXTesting\UICVFXTestControllerBase)

DisplayClusterActor

type: AActor*

TimeAtTestLocation

type: double

TimePerTestLocation

type: float


code: void ConsoleCommand ( const TCHAR * Cmd )


code: void ExecuteMemReport ( const [TOptional](API\Runtime\Core\IO\TOptional)< [FString](API\Runtime\Core\Containers\FString) > Args )


code: uint32 GetMaxRunCount() const


code: uint32 GetRunsRemaining() const


description: Called when a state change is applied to the module. States are game-driven.GetCurrentState()== OldState until this function returns

code: virtual void OnStateChange ( [FName](API\Runtime\Core\UObject\FName) OldState, [FName](API\Runtime\Core\UObject\FName) NewState )


code: void SetMemReportTimer ( const [TOptional](API\Runtime\Core\IO\TOptional)< float > Interval )


code: bool TryFinalizingVideoCapture ( const bool bStopAutoContinue )


code: bool TryStartingVideoCapture()


code: virtual void UnbindAllDelegates()


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


className: UICVFXTestControllerBase

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)() class UICVFXTestControllerBase : public [UGauntletTestController](API\Plugins\Gauntlet\UGauntletTestController)


description: Add your own goals to the OutGoals map (careful not to remove existing goals in the map!)

module: IKRig

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, BlueprintNativeEvent, Category=IKRigGoals) void AddIKGoals ( [TMap](API\Runtime\Core\Containers\TMap)< [FName](API\Runtime\Core\UObject\FName), [FIKRigGoal](API\Plugins\IKRig\Rig\FIKRigGoal) > & OutGoals )


className: IIKGoalCreatorInterface

code: class IIKGoalCreatorInterface


description: Called from the IK Rig Anim node to obtain all the goals that have been set on this actor.

code: virtual void AddIKGoals_Implementation ( [TMap](API\Runtime\Core\Containers\TMap)< [FName](API\Runtime\Core\UObject\FName), [FIKRigGoal](API\Plugins\IKRig\Rig\FIKRigGoal) > & OutGoals )


description: Remove all stored goals in this component.


description: Apply a IKRigGoal and store it on this rig. Goal transform assumed in Component Space of Skeletal Mesh.

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=IKRigGoals) void SetIKRigGoal ( const [FIKRigGoal](API\Plugins\IKRig\Rig\FIKRigGoal) & Goal )


description: Set an IK Rig Goal position and rotation (assumed in Component Space of Skeletal Mesh) with separate alpha values.

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=IKRigGoals) void SetIKRigGoalPositionAndRotation ( const [FName](API\Runtime\Core\UObject\FName) GoalName, const FVector Position, const FQuat Rotation, const float PositionAlpha, const float RotationAlpha )


description: Set an IK Rig Goal transform (assumed in Component Space of Skeletal Mesh) with separate alpha values.

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=IKRigGoals) void SetIKRigGoalTransform ( const [FName](API\Runtime\Core\UObject\FName) GoalName, const FTransform Transform, const float PositionAlpha, const float RotationAlpha )


className: UIKRigComponent

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(ClassGroup=IKRig, BlueprintType, Blueprintable, EditInlineNew, Meta=(BlueprintSpawnableComponent)) class UIKRigComponent : public [UActorComponent](API\Runtime\Engine\Components\UActorComponent), public [IIKGoalCreatorInterface](API\Plugins\IKRig\ActorComponents\IIKGoalCreatorInterface)


description: Called to evaluate local-space bones transforms according to the weights set up in Update(). You should implement either Evaluate or EvaluateComponentSpace, but not both of these. This can be called on any thread.

code: virtual void Evaluate_AnyThread ( [FPoseContext](API\Runtime\Engine\Animation\FPoseContext) & Output )


description: Called to cache any bones that this node needs to track (e.g. in aFBoneReference). This is usually called at startup when LOD switches occur. This can be called on any thread.

code: virtual void CacheBones_AnyThread ( const [FAnimationCacheBonesContext](API\Runtime\Engine\Animation\FAnimationCacheBonesContext) & Context )


description: Called to gather on-screen debug data. This is called on the game thread.

code: virtual void GatherDebugData ( [FNodeDebugData](API\Runtime\Engine\Animation\FNodeDebugData) & DebugData )


description: Get Target Class

code: virtual [UClass](API\Runtime\CoreUObject\UObject\UClass) * GetTargetClass() const


className: UIKGoalCreatorInterface

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


description: Override this to indicate thatPreUpdate()should be called on the game thread (usually to gather non-thread safe data) before Update() is called. Note that this is called at load on theUAnimInstanceCDO to avoid needing to call this at runtime. This is called on the game thread.

code: virtual bool HasPreUpdate() const


description: Initialize property links from the source instance, in this case AnimInstance Compiler creates those properties during compile time

code: virtual void InitializeProperties ( const [UObject](API\Runtime\CoreUObject\UObject\UObject) * InSourceInstance, [UClass](API\Runtime\CoreUObject\UObject\UClass) * InTargetClass )


description: Called when the node first runs. If the node is inside a state machine or cached pose branch then this can be called multiple times. This can be called on any thread.

code: virtual void Initialize_AnyThread ( const [FAnimationInitializeContext](API\Runtime\Engine\Animation\FAnimationInitializeContext) & Context )


description: For nodes that need some kind of initialization that is not dependent on node relevancy (i.e. it is insufficient or inefficient to use Initialize_AnyThread), return true here. Note that this is called at load on theUAnimInstanceCDO to avoid needing to call this at runtime.

code: virtual bool NeedsOnInitializeAnimInstance() const


description: We only subscribe to the OnInitializeAnimInstance path because we need to cache our source object, so we only override these methods in editor at the moment

code: virtual void OnInitializeAnimInstance ( const [FAnimInstanceProxy](API\Runtime\Engine\Animation\FAnimInstanceProxy) * InProxy, const [UAnimInstance](API\Runtime\Engine\Animation\UAnimInstance) * InAnimInstance )