Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

> Unreal Engine API Reference > Editor > UnrealEd > Toolkits > FAssetEditorToolkit

Light Theme

Dark Theme

FAssetEditorToolkit

Base class for toolkits that are used for asset editing (abstract)

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

IAssetEditorInstance

FBaseToolkit

TSharedFromThis

FAssetEditorToolkit

FBaseAssetToolkit

	FExampleAssetToolkit
	FLevelEditorAssetToolkit
	FUVEditorToolkit

FSimpleAssetEditor

FWorkflowCentricApplication

ICascade

ICurveAssetEditor

ICurveTableEditor

IDataTableEditor

IEnvironmentQueryEditor

IFontEditor

IGroomCustomAssetEditorToolkit

FGroomCustomAssetEditorToolkit

ILevelSequenceEditorToolkit

IMassEntityEditor

IMassGameplayEditor

IMassMovementEditor

IMetasoundEditor

ISoundClassEditor

ISoundCueEditor

ISoundSubmixEditor

IStateTreeEditor

IStaticMeshEditor

IStringTableEditor

IStructUtilsEditor

ITextureEditorToolkit

ITranslationEditor

IUserDefinedEnumEditor

IUserDefinedStructureEditor

IZoneGraphEditor

References

Module	UnrealEd
Header	/Engine/Source/Editor/UnrealEd/Public/Toolkits/AssetEditorToolkit.h
Include	#include "Toolkits/AssetEditorToolkit.h"

Syntax

class FAssetEditorToolkit :
    public IAssetEditorInstance,
    public FBaseToolkit,
    public TSharedFromThis< FAssetEditorToolkit >

Remarks

Base class for toolkits that are used for asset editing (abstract)

Variables

	Name	Description
TSharedPtr< FWo...	AssetEditorTabsCategory	The base category that tabs are registered to, allows for child classes to register to the same point.
bool	bCheckDirtyOnAssetSave	Whether only dirty assets should be prompted about on save - otherwise all edited assets will be prompted to the user for save/check-out
TSharedPtr< FEd...	EditorModeManager	The editor mode manager
TArray< TShared...	LayoutExtenders	Array of layout extenders
TWeakPtr< ITool...	PreviousWorldCentricToolkitHost	For standalone asset editing tool-kits that were switched from world-centric mode on the fly, this stores the toolkit host (level editor) that hosted this toolkit last.
TSharedPtr< FTa...	TabManager	Controls our internal layout

Constructors

	Name	Description
	FAssetEditorToolkit()	Default constructor
	FAssetEditorToolkit ( const FAssetEditorToolkit& )

Destructors

	Name	Description
	~FAssetEditorToolkit()	Virtual destructor, so that we can clean up our app when destroyed

Functions

	Name	Description
void	AddEditingObject ( UObject* Object )	Adds an item to the Editing Objects list
void	AddGraphEditorPinActionsToContextMenu ( FToolMenuSection& InSection )
void	AddMenuExtender ( TSharedPtr< FExtender > Extender )	Adds or removes extenders to the default menu or the toolbar menu this asset editor
void	AddToolbarExtender ( TSharedPtr< FExtender > Extender )
void	AddToolbarWidget ( TSharedRef< SWidget > Widget )	Adds or removes widgets from the default toolbar in this asset editor
void	AddViewportOverlayWidget ( TSharedRef< SWidget > InViewportOve... )	Called when a toolkit requests an overlay widget to be added to the viewport.
void	BrowseDocumentation_Execute()	Called when "Browse Documentation" is clicked for this asset
bool	CanFindInContentBrowser()	Called to test if "Find in Content Browser" should be enabled for this asset
bool	CanReimport ( UObject* EditingObject )	Called to check to see if there's an asset capable of being reimported
bool	CanReimport()	Called to check to see if there's an asset capable of being reimported
bool	CanSaveAsset()	Called to test if "Save" should be enabled for this asset
bool	CanSaveAssetAs()	Called to test if "Save As" should be enabled for this asset
void	FillDefaultAssetMenuCommands ( FToolMenuSection& InSection )	Fills in the supplied menu with commands for modifying this asset that are generally common to most asset editors
void	FillDefaultFileMenuCommands ( FToolMenuSection& InSection )	Fills in the supplied menu with commands for working with this asset file
void	FillDefaultHelpMenuCommands ( FToolMenuSection& InSection )	Fills in the supplied menu with commands for the help menu
void	FindInContentBrowser_Execute()	Called when "Find in Content Browser" is clicked for this asset
void	GenerateToolbar()	Makes a default asset editing toolbar
FLinearColor	GetDefaultTabColor()
const FSlate...	GetDefaultTabIcon()
FString	GetDocumentationLink()
UObject *...	GetEditingObject()	Returns the single object currently being edited.
const TArray...	GetEditingObjects()	Returns an array of all the objects currently being edited. Asserts if editing no objects
FText	GetLabelForObject ( const UObject* InObject )	Gets the text to display in a toolkit titlebar for an object
TSharedPtr< ...	GetPreviousWorldCentricToolkitHost()
void	GetSaveableObjects ( TArray< UObject* >& OutObject... )	Get the collection of edited objects that can be saved.
TSharedPtr< ...	GetSharedMenuExtensibilityManager()	Returns the default extensibility managers, these are applied for all asset types
TSharedPtr< ...	GetSharedToolBarExtensibilityManager()
TSharedPtr< ...	GetTabManager()
FName	GetToolMenuAppName()
FName	GetToolMenuName()
FName	GetToolMenuToolbarName ( FName& OutParentName )	Get name used by tool menu
FName	GetToolMenuToolbarName()
FText	GetToolTipTextForObject ( const UObject* InObject )	Gets the text to display in a toolkit tooltip for an object
bool	HasEditingObject()	Returns true if this toolkit has any objects being edited
void	InitAssetEditor ( const EToolkitMode::Type Mode, const TSharedPtr< IToolkitHost >& ..., const FName AppIdentifier, const TSharedRef< FTabManager::FLay..., const bool bCreateDefaultStandalone..., const bool bCreateDefaultToolbar, const TArray< UObject* >& Obj..., const bool bInIsToolbarFocusable, const bool bInUseSmallToolbarIcons )	Initializes this asset editor.
void	InitAssetEditor ( const EToolkitMode::Type Mode, const TSharedPtr< IToolkitHost >& ..., const FName AppIdentifier, const TSharedRef< FTabManager::FLay..., const bool bCreateDefaultStandalone..., const bool bCreateDefaultToolbar, UObject* ObjectToEdit, const bool bInIsToolbarFocusable, const bool bInUseSmallToolbarIcons )	Initializes this asset editor.
void	InitToolMenuContext ( FToolMenuContext& MenuContext )
void	InvokeTab ( const FTabId& TabId )
bool	IsActuallyAnAsset()	True if this actually is editing an asset
void	OnClose()	Called when this toolkit is being closed
bool	OnRequestClose()	Called when this toolkit is requested to close. Returns false if closing should be prevented.
void	OnToolkitHostingFinished ( const TSharedRef< IToolkit >& Tool... )	Called when another toolkit (such as a ed mode toolkit) is no longer being hosted in this asset editor toolkit.
void	OnToolkitHostingStarted ( const TSharedRef< IToolkit >& Tool... )	Called when another toolkit (such as a ed mode toolkit) is being hosted in this asset editor toolkit.
void	PostInitAssetEditor()	Perform any initialization that should happen after the basic toolkit needs are created for the asset editor.
void	PostRegenerateMenusAndToolbars()	Called at the end of RegenerateMenusAndToolbars()
void	RegenerateMenusAndToolbars()	Regenerates the menubar and toolbar widgets
void	RegisterDefaultToolBar()	Registers default tool bar
void	RegisterDrawer ( FStatusBarDrawer&& Drawer, int32 SlotIndex )	Registers a drawer for the asset editor status bar
void	Reimport_Execute()	Called when "Reimport" is clicked for this asset
void	Reimport_Execute ( UObject* EditingObject )	Called when "Reimport" is clicked for this asset
void	RemoveAllToolbarWidgets()
void	RemoveEditingObject ( UObject* Object )	Removes an item from the Editing Objects list
void	RemoveMenuExtender ( TSharedPtr< FExtender > Extender )
void	RemoveToolbarExtender ( TSharedPtr< FExtender > Extender )
void	RemoveViewportOverlayWidget ( TSharedRef< SWidget > InViewportOve... )	Called when a toolkit requests the overlay widget to be removed.
void	RestoreFromLayout ( const TSharedRef< FTabManager::FLay... )	Applies the passed in layout (or the saved user-modified version if available).
void	SaveAsset_Execute()	Called when "Save" is clicked for this asset
void	SaveAssetAs_Execute()	Called when "Save As" is clicked for this asset
void	SetMenuOverlay ( TSharedRef< SWidget > Widget )	Allows the caller to set a menu overlay, displayed to the far right of the editor's menu bar
void	SetPreviousWorldCentricToolkitHostForNewAssetEditor ( TSharedRef< IToolkitHost > ToolkitH... )	Static: Used internally to set the world-centric toolkit host for a newly-created standalone asset editing toolkit
bool	ShouldPromptForNewFilesOnReload ( const UObject& object )	Called to determine if the user should be prompted for a new file if one is missing during an asset reload
void	SwitchToStandaloneEditor_Execute ( TWeakPtr< FAssetEditorToolkit > Thi... )	Static: Called when "Switch to Standalone Editor" is clicked for the asset editor
void	SwitchToWorldCentricEditor_Execute ( TWeakPtr< FAssetEditorToolkit > Thi... )	Static: Called when "Switch to World-Centric Editor" is clicked for the asset editor

Overridden from IAssetEditorInstance

	Name	Description
bool	CloseWindow()
void	FocusWindow ( UObject* ObjectToFocusOn )
TSharedPtr< ...	GetAssociatedTabManager()
FName	GetEditorName()	IAssetEditorInstance interface
double	GetLastActivationTime()
bool	IsPrimaryEditor()
void	RemoveEditingAsset ( UObject* Asset )

Overridden from FBaseToolkit

		Name	Description
	void	CreateEditorModeManager()	Creates the Editor mode manager for your class. Default is to create none, for legacy reasons.

Overridden from IToolkit

	Name	Description
FText	GetBaseToolkitName()	Returns the localized name of this toolkit type (typically just " editor")
FEditorModeT...	GetEditorModeManager()	Gets the mode manager for this toolkit
const TArray...	GetObjectsCurrentlyBeingEdited()	For asset editor toolkits, returns the UObjects for the assets currently being edited
FText	GetTabSuffix()	Returns the localized tab suffix
FName	GetToolkitFName()	Returns the invariant name of this toolkit type
FText	GetToolkitName()	Returns the localized name of this toolkit
FText	GetToolkitToolTipText()	Returns the localized tooltip text of this toolkit
FString	GetWorldCentricTabPrefix()	Returns the localize prefix string to use for tab labels in world-centric mode.
bool	IsAssetEditor()	Returns true if this toolkit is used to edit assets (even if it's not necessarily editing one right now.)
void	RegisterTabSpawners ( const TSharedRef< FTabManager >& T... )	IToolkit interface
void	UnregisterTabSpawners ( const TSharedRef< FTabManager >& T... )	Unregister tabs that this toolkit can spawn

Operators

		Name	Description
	FAssetEditor...	operator= ( const FAssetEditorToolkit& )

Constants

Name	Description
DefaultAssetEditorToolBarName
PreviousWorldCentricToolkitHostForNewAssetEditor	Static: World centric toolkit host to use for the next created asset editing toolkit
SharedMenuExtensibilityManager	The extensibility managers shared by all asset types
SharedToolBarExtensibilityManager

Deprecated Variables

		Name	Description
	FAssetEditorMod...	AssetEditorModeManager	Use EditorModeManager instead.

Deprecated Functions

		Name	Description
	FAssetEditor...	GetAssetEditorModeManager()	Use GetEditorModeManager instead.
	void	SetAssetEditorModeManager ( FAssetEditorModeManager* InMod... )	Override CreateEditorModeManager on the toolkit class instead.

This API reference document refers to UE 5.1 or earlier. API docs for 5.2 or later are currently being finalized and will be available at a later date.