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 > UnrealEd > Toolkits > FModeToolkit

Light Theme

Dark Theme

FModeToolkit

This [FModeToolkit](API\Editor\UnrealEd\Toolkits\FModeToolkit) just creates a basic UI panel that allows various InteractiveTools to be initialized, and a DetailsView used to show properties of the active Tool.

Windows

MacOS

Linux

Inheritance Hierarchy

FBaseToolkit

TSharedFromThis

FModeToolkit

	FFractureEditorModeToolkit
	FModelingToolsEditorModeToolkit
	FMotionTrailEditorModeToolkit
	FSampleToolsEditorModeToolkit
	FTextureAlignMode

References

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

Syntax

class FModeToolkit :
public FBaseToolkit,
public TSharedFromThis< FModeToolkit >

Remarks

This FModeToolkit just creates a basic UI panel that allows various InteractiveTools to be initialized, and a DetailsView used to show properties of the active Tool.

Variables

		Name	Description
	TSharedPtr< IDe...	DetailsView
	TSharedPtr< IDe...	ModeDetailsView
	TSharedPtr< SWi...	ToolkitWidget

Destructors

	Name	Description
	~FModeToolkit()

Functions

	Name	Description
void	BuildToolPalette ( FName Palette, FToolBarBuilder& ToolbarBuilder )
bool	CanAcceptActiveTool()
bool	CanCancelActiveTool()
bool	CanCompleteActiveTool()
bool	CanStartTool ( const FString& ToolTypeIdentifier )
FText	GetActiveToolDisplayName()
FText	GetActiveToolMessage()
FText	GetToolPaletteDisplayName ( FName Palette )
void	GetToolPaletteNames ( TArray< FName >& PaletteNames )	Returns the number of Mode specific tabs in the mode toolbar
void	Init ( const TSharedPtr< IToolkitHost >& ... )	Initializes the mode toolkit
void	OnToolEnded ( UInteractiveToolManager* Manag..., UInteractiveTool* Tool )
void	OnToolPaletteChanged ( FName PaletteName )
void	OnToolStarted ( UInteractiveToolManager* Manag..., UInteractiveTool* Tool )
void	SetModeSettingsObject ( UObject* InSettingsObject )

Overridden from IToolkit

	Name	Description
FText	GetBaseToolkitName()	Returns the localized name of this toolkit type (typically just " editor")
FEdMode *...	GetEditorMode()
FText	GetEditorModeDisplayName()
FSlateIcon	GetEditorModeIcon()
TSharedPtr< ...	GetInlineContent()
const TArray...	GetObjectsCurrentlyBeingEdited()	For asset editor toolkits, returns the UObjects for the assets currently being edited
UEdMode *...	GetScriptableEditorMode()
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
FLinearColor	GetWorldCentricTabColorScale()
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... )	Register tabs that this toolkit can spawn with the TabManager
void	UnregisterTabSpawners ( const TSharedRef< FTabManager >& T... )	Unregister tabs that this toolkit can spawn

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

Take our survey

Dismiss