1. Epic GamesDeveloper
  3. UUICommandsScriptingSubsystem

UUICommandsScriptingSubsystem

UEditorInputSubsystem Subsystem for dynamically registering editor commands through scripting

API > API/Plugins > API/Plugins/SlateScriptingCommands

Inheritance Hierarchy

References

   
Module SlateScriptingCommands
Header /Engine/Plugins/Slate/SlateScripting/Source/SlateScriptingCommands/Public/UICommandsScriptingSubsystem.h
Include #include "UICommandsScriptingSubsystem.h"

Syntax

UCLASS&40;&41;  
class UUICommandsScriptingSubsystem : public UEngineSubsystem

Remarks

UEditorInputSubsystem Subsystem for dynamically registering editor commands through scripting

Functions

  Type Name Description
Public function Const UFunction BlueprintCallable, Category bool Checks whether commands registered in the subsystem can be executed
Public function Const UFunction BlueprintCallable, Category, Meta bool

CanSetExecuteCommands ( const FName SetName
)

 Checks whether commands in the given set can be executed.
Public function Const UFunction BlueprintCallable, Category TArray< FName > Retrieves the list of names for all contexts currently registered in the subsystem.
Public function UFunction BlueprintCallable, Category int Retrieves the number of UI Command Lists registered within this context through the subsystem.
Public function Const UFunction BlueprintCallable, Category TArray< FScriptingCommandInfo > Retrieves the list of command info for all commands currently registered in the subsystem
Public function Const UFunction BlueprintCallable, Category bool

IsCommandRegistered ( FScriptingCommandInfo CommandInfo,
bool bCheckInputChord
)

 Checks whether the given command is registered within the subsystem.
Public function Const UFunction BlueprintCallable, Category bool Checks whether the given set is currently registered in the subsystem
Public function Const UFunction BlueprintCallable, Category bool

IsContextRegistered ( FName ContextName
)

 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.
Public function Const UFunction BlueprintCallable, Category bool

IsInputChordMapped ( FName ContextName,
FInputChord InputChord
)

 Checks whether the given input chord is already mapped to a command in the given context.
Public function UFunction BlueprintCallable, Category bool

RegisterCommand ( FScriptingCommandInfo CommandInfo,
FExecuteCommand OnExecuteCommand,
bool bOverrideExisting
)

 Registers a command within the given context and set. The set must be registered beforehand.
Public function UFunction BlueprintCallable, Category 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.
Public function void

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

 Registers a command list in the given context.
Public function UFunction BlueprintCallable, Category bool Registers a new command set
Public function UFunction BlueprintCallable, Category void

SetCanExecuteCommands ( bool bShouldExecuteCommands
)

 Sets whether commands registered in the subsystem can be executed
Public function UFunction BlueprintCallable, Category, Meta void

SetCanSetExecuteCommands ( FName SetName,
bool bShouldExecuteCommands
)

 Enables or disables execution of commands registered within the given set
Public function UFunction BlueprintCallable, Category void Unregisters all commands dynamically registered within all contexts and sets.
Public function UFunction BlueprintCallable, Category bool Unregisters a command previously registered.
Public function void

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

 Unregisters a command list from the given context.
Public function UFunction BlueprintCallable, Category bool Unregisters the corresponding command set with all commands registered within it
Public function bool

UnregisterContext ( const FName ContextName
)

 Unregisters all command lists from the given context.

Overridden from USubsystem

  Type Name Description
Public function Virtual void USubsystem Interface: handles deinitialization of instances of the system
Public function Virtual void USubsystem Interface: handles initialization of instances of the system This is where the subsystem binds to the CommandListRegistered delegate of the InputBindingManager

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page