1. Epic GamesDeveloper
  3. UUICommandsScriptingSubsystem

UUICommandsScriptingSubsystem

UEditorInputSubsystem Subsystem for dynamically registering editor commands through scripting

API > API/Plugins > API/Plugins/SlateScriptingCommands

UEditorInputSubsystem Subsystem for dynamically registering editor commands through scripting

   
Name UUICommandsScriptingSubsystem
Type class
Header File /Engine/Plugins/Slate/SlateScripting/Source/SlateScriptingCommands/Public/UICommandsScriptingSubsystem.h
Include Path #include "UICommandsScriptingSubsystem.h"

Syntax

UCLASS (MinimalAPI)  
class UUICommandsScriptingSubsystem : public UEngineSubsystem

Inheritance Hierarchy

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bCanExecuteCommands bool Whether the commands for all the sets of the subsystem can be executed UICommandsScriptingSubsystem.h  
CommandSets TMap< FName, FScriptingCommandSet > The list of command sets. Each set contains its own list of registered commands UICommandsScriptingSubsystem.h  
CommandsInContext TMap< FName, FScriptingCommandsContext > The list of commands contexts. UICommandsScriptingSubsystem.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool CanExecuteCommands()

 Checks whether commands registered in the subsystem can be executed UICommandsScriptingSubsystem.h
  • BlueprintCallable
  • Category="Editor Scripting | Commands | Global"

bool CanSetExecuteCommands ( const FName SetName
) const

 Checks whether commands in the given set can be executed. UICommandsScriptingSubsystem.h
  • BlueprintCallable
  • Category="Editor Scripting | Commands | Sets"
  • Meta=(DisplayName="Can Execute Commands")
Retrieves the list of names for all contexts currently registered in the subsystem. UICommandsScriptingSubsystem.h
  • BlueprintCallable
  • Category="Editor Scripting | Commands | Contexts"

int GetBindingCountForContext ( FName ContextName
)

 Retrieves the number of UI Command Lists registered within this context through the subsystem. UICommandsScriptingSubsystem.h
  • BlueprintCallable
  • Category="Editor Scripting | Commands | Contexts"

TArray< FScriptingCommandInfo > GetRegisteredCommands()

 Retrieves the list of command info for all commands currently registered in the subsystem UICommandsScriptingSubsystem.h
  • BlueprintCallable
  • Category="Editor Scripting | Commands | Global"

bool IsCommandRegistered ( FScriptingCommandInfo CommandInfo,
bool bCheckInputChord
) const

 Checks whether the given command is registered within the subsystem. UICommandsScriptingSubsystem.h
  • BlueprintCallable
  • Category="Editor Scripting | Commands |"

bool IsCommandSetRegistered ( FName SetName
) const

 Checks whether the given set is currently registered in the subsystem UICommandsScriptingSubsystem.h
  • BlueprintCallable
  • Category="Editor Scripting | Commands | Sets"

bool IsContextRegistered ( FName ContextName
) const

 Checks whether the context with the given name is currently registered in the subsystem This does not check whether the context is bound to any UI Command List. UICommandsScriptingSubsystem.h
  • BlueprintCallable
  • Category="Editor Scripting | Commands | Contexts"

bool IsInputChordMapped ( FName ContextName,
FInputChord InputChord
) const

 Checks whether the given input chord is already mapped to a command in the given context. UICommandsScriptingSubsystem.h
  • BlueprintCallable
  • Category="Editor Scripting | Commands | Contexts"

bool RegisterCommand ( FScriptingCommandInfo CommandInfo,
FExecuteCommand OnExecuteCommand,
bool bOverrideExisting
)

 Registers a command within the given context and set. The set must be registered beforehand. UICommandsScriptingSubsystem.h
  • BlueprintCallable
  • Category="Editor Scripting | Commands |"

bool RegisterCommandChecked ( FScriptingCommandInfo CommandInfo,
FExecuteCommand OnExecuteCommand,
FCanExecuteCommand OnCanExecuteCommand,
bool bOverrideExisting
)

 Registers a command within the given context and set. The set must be registered beforehand. UICommandsScriptingSubsystem.h
  • BlueprintCallable
  • Category="Editor Scripting | Commands |"

void RegisterCommandListForContext ( const FName ContextName,
TSharedRef< FUICommandList > CommandList
)

 Registers a command list in the given context. UICommandsScriptingSubsystem.h  

bool RegisterCommandSet ( FName SetName
)

 Registers a new command set UICommandsScriptingSubsystem.h
  • BlueprintCallable
  • Category="Editor Scripting | Commands | Sets"

void SetCanExecuteCommands ( bool bShouldExecuteCommands
)

 Sets whether commands registered in the subsystem can be executed UICommandsScriptingSubsystem.h
  • BlueprintCallable
  • Category="Editor Scripting | Commands | Global"

void SetCanSetExecuteCommands ( FName SetName,
bool bShouldExecuteCommands
)

 Enables or disables execution of commands registered within the given set UICommandsScriptingSubsystem.h
  • BlueprintCallable
  • Category="Editor Scripting | Commands | Sets"
  • Meta=(DisplayName="Set Can Execute Commands")
Unregisters all commands dynamically registered within all contexts and sets. UICommandsScriptingSubsystem.h
  • BlueprintCallable
  • Category="Editor Scripting | Commands | Global"
Unregisters a command previously registered. UICommandsScriptingSubsystem.h
  • BlueprintCallable
  • Category="Editor Scripting | Commands |"

void UnregisterCommandListForContext ( const FName ContextName,
TSharedRef< FUICommandList > CommandList
)

 Unregisters a command list from the given context. UICommandsScriptingSubsystem.h  

bool UnregisterCommandSet ( FName SetName
)

 Unregisters the corresponding command set with all commands registered within it UICommandsScriptingSubsystem.h
  • BlueprintCallable
  • Category="Editor Scripting | Commands | Sets"

bool UnregisterContext ( const FName ContextName
)

 Unregisters all command lists from the given context. UICommandsScriptingSubsystem.h  

Overridden from USubsystem

Name Remarks Include Path Unreal Specifiers

virtual void Deinitialize()

 USubsystem Interface: handles deinitialization of instances of the system UICommandsScriptingSubsystem.h  

virtual void Initialize ( FSubsystemCollectionBase& Collection
)

 USubsystem Interface: handles initialization of instances of the system This is where the subsystem binds to the CommandListRegistered delegate of the InputBindingManager UICommandsScriptingSubsystem.h  

Static

Name Remarks Include Path Unreal Specifiers

static void HandleExecuteAction ( FExecuteCommand OnExecuteAction,
const FScriptingCommandInfo CommandInfo
)

 The delegate bound to registered commands. It will broadcast back to the given dynamic delegate UICommandsScriptingSubsystem.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page