Navigation
API > API/Runtime > API/Runtime/Slate
A base class for a set of commands. Inherit from it to make a set of commands. See MainFrameActions for an example.
| Name | TCommands |
| Type | class |
| Header File | /Engine/Source/Runtime/Slate/Public/Framework/Commands/Commands.h |
| Include Path | #include "Framework/Commands/Commands.h" |
Syntax
template<typename CommandContextType>
class TCommands : public FBindingContext
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → FBindingContext → TCommands
Derived Classes
TCommands derived class hierarchy
- FAnimGraphCommands
- FAssetSearchCommands
- FAvaInteractiveToolsCommands
- FAvaLevelViewportCommands
- FBoneGroupsListWidgetCommands
- FBoneListWidgetCommands
- FCachingEditorCommands
- FContextualAnimAssetEditorCommands
- FCustomizableObjectPopulationClassEditorCommands
- FCustomizableObjectPopulationEditorCommands
- FDatabaseEditorCommands
- FDialogCommands
- FDMXEditorCommands
- FEditorCommands
- FEditorViewportCommands
- FEditPivotCommands
- FGenericCommands
- FGeometryCollectionSelectionCommands
- FGlobalEditorCommonCommands
- FGPUSkinCacheVisualizationMenuCommands
- FHairModelingToolCommands
- FLogWidgetCommands
- FMeshPaintEditorModeCommands
- FMetaHumanToolkitCommands
- FMLDeformerInputBonesWidgetCommands
- FMLDeformerInputCurvesWidgetCommands
- FMotionTrailCommands
- FMVVMEditorCommands
- FNiagaraEditorCommands
- FNiagaraParameterPanelCommands
- FPCGEditorCommands
- FPCGEditorSpawnNodeCommands
- FPerformanceCaptureCommands
- FPlayWorldCommands
- FRayTracingDebugVisualizationMenuCommands
- FRigVMEditorGraphExplorerCommands
- FRigVMExecutionStackCommands
- FScriptableToolsEditorModeManagerCommands
- FSkeletalMeshMorphTargetEditingToolsCommands
- FSoundClassEditorCommands
- FSoundCueGraphEditorCommands
- FStandardToolModeCommands
- FTabCommands
- FTG_ExporterCommands
- FTranslationEditorCommands
- FTweeningUtilsCommands
- FUVEditorCommands
- FViewportNavigationCommands
- FWaveformEditorCommands
- TInteractiveToolCommands
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| Construct a set of commands; call this from your custom commands class. | Framework/Commands/Commands.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~TCommands() |
Framework/Commands/Commands.h |
Functions
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
TWeakPtr< FGenericCommands > & GetInstance () |
|||
SLATE_APITWeakPtr< class FGenericCommands > & GetInstance () |
Framework/Commands/GenericCommands.h | ||
void RegisterCommands() |
Pure virtual to override; describe and instantiate the commands in here by using the UI COMMAND macro. | Framework/Commands/Commands.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static CommandContextType & Get() |
Get the singleton instance of this set of commands. | Framework/Commands/Commands.h | |
static const FBindingContext & GetContext() |
Get the BindingContext for this set of commands. | Framework/Commands/Commands.h | |
static TWeakPtr< CommandContextType > & GetInstance () |
A static instance of the command set. | Framework/Commands/Commands.h | |
static bool IsRegistered() |
Framework/Commands/Commands.h | ||
static void Register() |
Use this method to register commands. Usually done in StartupModule(). | Framework/Commands/Commands.h | |
static void Unregister() |
Use this method to clean up any resources used by the command set. Usually done in ShutdownModule() | Framework/Commands/Commands.h |