Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Editor > Persona > FPersonaModule

Light Theme

Dark Theme

FPersonaModule

Persona module manages the lifetime of all instances of Persona editors.

Inheritance Hierarchy

IModuleInterface

IHasMenuExtensibility

FPersonaModule

References

Module	Persona
Header	/Engine/Source/Editor/Persona/Public/PersonaModule.h
Include	#include "PersonaModule.h"

Syntax

class FPersonaModule :
public IModuleInterface,
public IHasMenuExtensibility

Remarks

Persona module manages the lifetime of all instances of Persona editors.

Functions

	Name	Description
void	AddCommonMenuExtensions ( UToolMenu* InToolMenu, const FCommonToolMenuExtensionArgs ... )	Add common menu extensions
void	AddCommonToolbarExtensions ( FToolBarBuilder& InToolbarBuilder, TSharedRef< IPersonaToolkit > Perso..., const FCommonToolbarExtensionArgs&... )	Add common toobar extensions (legacy support) - DEPRECATED
void	AddCommonToolbarExtensions ( UToolMenu* InToolMenu, const FCommonToolMenuExtensionArgs ... )	Add common toolbar extensions
void	AddLoopingInterpolation ( TArray< TWeakObjectPtr< class UAnim... )	Add looping interpolation to the list of animations
void	ApplyCompression ( TArray< TWeakObjectPtr< class UAnim..., bool bPickBoneSettingsOverride )	Apply Compression to list of animations and optionally asks to pick an overrides to the bone compression settings
void	BroadcastAssetFamilyChange()	Broadcast event that all asset families need to change
TSharedRef< ...	CreateAdvancedPreviewSceneTabFactory ( const TSharedRef< class FWorkflowCe..., const TSharedRef< IPersonaPreviewSc... )	Create a tab factory used to configure preview scene settings
TSharedRef< ...	CreateAnimationAssetBrowserTabFactory ( const TSharedRef< class FWorkflowCe..., const TSharedRef< IPersonaToolkit >..., FOnOpenNewAsset InOnOpenNewAsset, FOnAnimationSequenceBrowserCreated ..., bool bInShowHistory )	Create a tab factory for the animation asset browser
TSharedRef< ...	CreateAnimBlueprintAssetOverridesTabFactory ( const TSharedRef< class FBlueprintE..., UAnimBlueprint* InAnimBlueprin..., FSimpleMulticastDelegate& InOnPost... )	Create a tab factory for editing anim blueprint parent overrides
TSharedRef< ...	CreateAnimBlueprintPreviewTabFactory ( const TSharedRef< class FBlueprintE..., const TSharedRef< IPersonaPreviewSc... )	Create a tab factory for editing anim blueprint preview & defaults
TSharedRef< ...	CreateAnimMontageSectionsTabFactory ( const TSharedRef< class FWorkflowCe..., const TSharedRef< IPersonaToolkit >..., FSimpleMulticastDelegate& InOnSect... )	Create a tab factory for editing montage sections
TSharedRef< ...	CreateAnimNotifiesTabFactory ( const TSharedRef< class FWorkflowCe..., const TSharedRef< class IEditableSk..., FOnObjectsSelected InOnObjectsSelec... )	Create an anim notifies tab factory
TSharedRef< ...	CreateAssetDetailsTabFactory ( const TSharedRef< class FWorkflowCe..., FOnGetAsset InOnGetAsset, FOnDetailsCreated InOnDetailsCreate... )	Create a tab factory for editing a single object (like an animation asset)
TSharedRef< ...	CreateAssetFamilyShortcutWidget ( const TSharedRef< class FWorkflowCe..., const TSharedRef< class IAssetFamil... )	Create a shortcut widget for an asset family
TSharedRef< ...	CreateBlendSpaceEditWidget ( UBlendSpace* InBlendSpace, const FBlendSpaceEditorArgs& InArg... )	Create a widget to edit a blendspace
TSharedRef< ...	CreateBlendSpacePreviewWidget ( const FBlendSpacePreviewArgs& InAr... )	Create a widget to preview a blendspace
TSharedRef< ...	CreateCurveViewerTabFactory ( const TSharedRef< class FWorkflowCe..., const TSharedRef< class IEditableSk..., const TSharedRef< class IPersonaPre..., FOnObjectsSelected InOnObjectsSelec... )	Create a skeleton curve viewer tab factory
TSharedRef< ...	CreateCurveWidgetForAnimDocument ( const TSharedRef< class FWorkflowCe..., const TSharedRef< IPersonaPreviewSc..., UAnimSequenceBase* InAnimSeque..., const TSharedPtr< ITimeSliderContro..., const TSharedPtr< FTabManager >& I... )	Create a widget that acts as a curve document for an animation asset
TSharedRef< ...	CreateDetailsTabFactory ( const TSharedRef< class FWorkflowCe..., FOnDetailsCreated InOnDetailsCreate... )	Create a details panel tab factory
TSharedRef< ...	CreateEditorWidgetForAnimDocument ( const TSharedRef< IAnimationEditor ..., UObject* InAnimAsset, const FAnimDocumentArgs& InArgs, FString& OutDocumentLink )	Create a widget that acts as a document for an animation asset
TSharedRef< ...	CreateMorphTargetTabFactory ( const TSharedRef< class FWorkflowCe..., const TSharedRef< IPersonaPreviewSc..., FSimpleMulticastDelegate& OnPostUn... )	Create a tab factory for for previewing morph targets
TSharedRef< ...	CreatePersonaAssetFamily ( const UObject* InAsset )	Create an asset family for the supplied persona asset
IPersonaEdit...	CreatePersonaEditorModeManager()	Create a Persona editor mode manager.
TSharedRef< ...	CreatePersonaToolkit ( UPhysicsAsset* InPhysicsAsset, const FPersonaToolkitArgs& Persona... )	Create a re-usable toolkit that multiple asset editors that are concerned with USkeleton-related data can use
TSharedRef< ...	CreatePersonaToolkit ( UAnimBlueprint* InAnimBlueprin..., const FPersonaToolkitArgs& Persona... )	Create a re-usable toolkit that multiple asset editors that are concerned with USkeleton-related data can use
TSharedRef< ...	CreatePersonaToolkit ( USkeletalMesh* InSkeletalMesh, const FPersonaToolkitArgs& Persona... )	Create a re-usable toolkit that multiple asset editors that are concerned with USkeleton-related data can use
TSharedRef< ...	CreatePersonaToolkit ( UAnimationAsset* InAnimationAs..., const FPersonaToolkitArgs& Persona... )	Create a re-usable toolkit that multiple asset editors that are concerned with USkeleton-related data can use
TSharedRef< ...	CreatePersonaToolkit ( USkeleton* InSkeleton, const FPersonaToolkitArgs& Persona... )	Create a re-usable toolkit that multiple asset editors that are concerned with USkeleton-related data can use
TSharedRef< ...	CreatePersonaToolkit ( UObject* InAsset, const FPersonaToolkitArgs& Persona..., USkeleton* InSkeleton )	Create a re-usable toolkit that multiple asset editors that are concerned with USkeleton-related data can use
TSharedRef< ...	CreatePersonaViewportTabFactory ( const TSharedRef< class FWorkflowCe..., const FPersonaViewportArgs& InArgs )	Create a persona viewport tab factory
TSharedRef< ...	CreatePoseWatchTabFactory ( const TSharedRef< class FBlueprintE... )	Create a tab factory for the pose watch manager
TSharedRef< ...	CreateRetargetSourcesTabFactory ( const TSharedRef< class FWorkflowCe..., const TSharedRef< class IEditableSk..., const TSharedRef< IPersonaPreviewSc..., FSimpleMulticastDelegate& InOnPost... )	Create a retarget sources tab factory
TSharedRef< ...	CreateSkeletonSlotNamesTabFactory ( const TSharedRef< class FWorkflowCe..., const TSharedRef< class IEditableSk..., FOnObjectSelected InOnObjectSelecte... )	Create a tab factory for editing slot names and groups
void	CustomizeBlueprintEditorDetails ( const TSharedRef< class IDetailsVie..., FOnInvokeTab InOnInvokeTab )	Customize the details of a slot node for the specified details view
void	CustomizeMeshDetails ( const TSharedRef< IDetailsView >& ..., const TSharedRef< IPersonaToolkit >... )	Customize a skeletal mesh details panel
bool	ExportToFBX ( TArray< TWeakObjectPtr< class UAnim..., USkeletalMesh* SkeletalMesh )	Export to FBX files of the list of animations
TSharedPtr< ...	GetToolBarExtensibilityManager()
void	ImportNewAsset ( USkeleton* InSkeleton, EFBXImportType DefaultImportType )	Import a new asset using the supplied skeleton
FGetCurrentR...	OnGetCurrentRecording()	Delegate used to get the currently recording animation
FGetCurrentR...	OnGetCurrentRecordingTime()	Delegate used to get the currently recording animation time
FIsRecording...	OnIsRecordingActive()	Delegate used to query whether recording is active
FOnPreviewSc...	OnPreviewSceneCreated()	Delegate broadcast when a preview scene is created
FRecord &	OnRecord()	Delegate used to start recording animation
FOnRegisterL...	OnRegisterLayoutExtensions()	Register common layout extensions
FOnRegisterT...	OnRegisterTabs()	Register common tabs
FStopRecordi...	OnStopRecording()	Delegate used to stop recording animation
void	RecordAssetOpened ( const FAssetData& InAssetData )	Record that an asset was opened (forward to relevant asset families)
void	RegisterPersonaViewportTabFactories ( FWorkflowAllowedTabSet& TabSet, const TSharedRef< class FWorkflowCe..., const FPersonaViewportArgs& InArgs )	Register 4 Persona viewport tab factories
void	TestSkeletonCurveNamesForUse ( const TSharedRef< IEditableSkeleton... )	Check all animations & skeletal meshes for curve usage

Overridden from IModuleInterface

		Name	Description
	void	ShutdownModule()	Called before the module is unloaded, right before the module object is destroyed.
	void	StartupModule()	Called right after the module's DLL has been loaded and the module object has been created

Overridden from IHasMenuExtensibility

		Name	Description
	TSharedPtr< ...	GetMenuExtensibilityManager()	Gets the extensibility managers for outside entities to extend persona editor's menus and toolbars

Classes

	Name	Description
	FCommonToolMenuExtensionArgs	Settings for AddCommonToolbarExtensions

Enums

	Name	Description
	EPoseSourceOption	Options for asset creation

Typedefs

Name	Description
FCommonToolbarExtensionArgs

Deprecated Functions

	Name	Description
TSharedRef< ...	CreateBlendSpacePreviewWidget ( TAttribute< const UBlendSpace*..., TAttribute< FVector > InBlendPositi..., TAttribute< FVector > InFilteredBle... )	Please use the overload that takes a FBlendSpacePreviewArgs struct
TSharedRef< ...	CreateCurveViewerTabFactory ( const TSharedRef< class FWorkflowCe..., const TSharedRef< class IEditableSk..., const TSharedRef< class IPersonaPre..., FSimpleMulticastDelegate& InOnPost..., FOnObjectsSelected InOnObjectsSelec... )	Please use the overload that does not take a post-undo delegate
TSharedRef< ...	CreateSkeletonSlotNamesTabFactory ( const TSharedRef< class FWorkflowCe..., const TSharedRef< class IEditableSk..., FSimpleMulticastDelegate& InOnPost..., FOnObjectSelected InOnObjectSelecte... )	Please use the overload that does not take a post-undo delegate
void	CustomizeSlotNodeDetails ( const TSharedRef< class IDetailsVie..., FOnInvokeTab InOnInvokeTab )	Function renamed, please use CustomizeBlueprintEditorDetails

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Cancel