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

Light Theme

Dark Theme

TInteractiveToolCommands

[TInteractiveToolCommands](API\Editor\UnrealEd\Tools\TInteractiveToolCommands) is a base class that handles connecting up Tool Actions (ie the [FInteractiveToolAction](API\Runtime\InteractiveToolsFramework\FInteractiveToolAction) provided by a [UInteractiveTool](API\Runtime\InteractiveToolsFramework\UInteractiveTool)) to the UnrealEditor Command system, which allows for remappable hotkeys, etc

Windows

MacOS

Linux

Inheritance Hierarchy

TSharedFromThis

FBindingContext

TCommands

TInteractiveToolCommands

	FDrawPolygonToolActionCommands
	FEditMeshPolygonsToolActionCommands
	FMeshPaintingToolActionCommands
	FMeshPlaneCutToolActionCommands
	FMeshSelectionToolActionCommands
	FModelingToolActionCommands
	FSculptToolActionCommands
	FTransformToolActionCommands

References

Module	UnrealEd
Header	/Engine/Source/Editor/UnrealEd/Public/Tools/InteractiveToolsCommands.h
Include	#include "Tools/InteractiveToolsCommands.h"

Syntax

template<typename CommandContextType>
class TInteractiveToolCommands : public TCommands< CommandContextType >

Remarks

TInteractiveToolCommands is a base class that handles connecting up Tool Actions (ie the FInteractiveToolAction provided by a UInteractiveTool) to the UnrealEditor Command system, which allows for remappable hotkeys, etc

Usage is as follows:

in your EdMode Module, create a subclass-instance of this, say FMyToolCommands and call FMyToolCommands::Register() in your ::StartupModule() function
subclass must implement ::GetToolDefaultObjectList(), here you just add GetMutableDefault<MyToolX> to the input list for all your Tools
add a member TSharedPtr<FUICommandList> UICommandList; to your EdMode impl
when you start a new Tool, call FMyToolCommands::Get().BindCommandsForCurrentTool(UICommandList, NewTool)
when you end a Tool, call FMyToolCommands::Get().UnbindActiveCommands()
in your EdModeImpl::InputKey override, call UICommandList->ProcessCommandBindings()

Variables

		Name	Description
	TArray< FToolAc...	ActionCommands
	TMap< EStandard...	SharedActionCommands	Support for sharing common commands between Tools where the commands are not shared across Tool Modes (and hence not in FStandardToolModeCommands)List FToolActionCommands for standard Tool Actions

Constructors

	Name	Description
	TInteractiveToolCommands ( const FName InContextName, const FText& InContextDesc, const FName InContextParent, const FName InStyleSetName )	Forwarding constructor

Functions

	Name	Description
void	BindCommandsForCurrentTool ( TSharedPtr< FUICommandList > UIComm..., UInteractiveTool* Tool )	Bind any of the registered UICommands to the given Tool, if they are compatible.
bool	FindOrCreateSharedCommand ( EStandardToolActions ActionID, FToolActionCommand& FoundOut )	Find or Create a UICommand for a standard Tool Action, that will be shared across Tools
TSharedPtr< ...	FindStandardCommand ( EStandardToolActions ToolActionID )	Query FStandardToolModeCommands to find an existing command/hotkey for this standard tool action
void	GetToolDefaultObjectList ( TArray< UInteractiveTool* >& ... )	Interface that subclasses need to implement RegisterCommands() needs actual UInteractiveTool instances for all the Tools that want to provide Actions which will be connected to hotkeys.
bool	IntializeStandardToolAction ( EStandardToolActions ActionID, FInteractiveToolAction& ToolAction... )	Create a suitable FInteractiveToolAction for the standard Tool Action, ie with suitable command name and description strings and hotkeys.
void	RegisterUIToolCommand ( const FInteractiveToolAction& Tool..., TSharedPtr< FUICommandInfo >& UICo... )	Utility function that registeres a Tool Aciton as a UICommand
void	UnbindActiveCommands ( TSharedPtr< FUICommandList > UIComm... )	Unbind all of the currently-registered commands

Overridden from TCommands

		Name	Description
	void	RegisterCommands()	Initialize commands.

Classes

	Name	Description
	FToolActionCommand	List of pairs of known Tool Actions and their associated UICommands.

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

Take our survey

Dismiss