Navigation
API > API/Plugins > API/Plugins/SlateScriptingCommands
The list of commands and UI Command Lists associated with a context. This enables easier management of commands within registered contexts and their UI Command Lists.
| Name | FScriptingCommandsContext |
| Type | struct |
| Header File | /Engine/Plugins/Slate/SlateScripting/Source/SlateScriptingCommands/Public/UICommandsScriptingSubsystem.h |
| Include Path | #include "UICommandsScriptingSubsystem.h" |
Syntax
USTRUCT ()
struct FScriptingCommandsContext
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| UICommandsScriptingSubsystem.h | |||
FScriptingCommandsContext
(
const FName InContextName |
UICommandsScriptingSubsystem.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| CommandLists | TArray< TWeakPtr< FUICommandList > > | An array of command list associated to the given context | UICommandsScriptingSubsystem.h | |
| ContextName | FName | The context these command lists are bound to | UICommandsScriptingSubsystem.h | |
| ScriptingCommands | TArray< TSharedPtr< FScriptingCommand > > | The commands bound in these command lists | UICommandsScriptingSubsystem.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void MapAllCommands
(
TSharedRef< FUICommandList > CommandList |
Maps all commands existing within this context to the given command list | UICommandsScriptingSubsystem.h | |
bool MapCommand
(
const TSharedRef< FScriptingCommand > ScriptingCommand |
Maps the given command to all the command lists of this context | UICommandsScriptingSubsystem.h | |
bool RegisterCommandList
(
const TSharedRef< FUICommandList > CommandList |
Registers a command list in this context then map to it all commands existing within this context | UICommandsScriptingSubsystem.h | |
void UnmapAllCommands
(
TSharedRef< FUICommandList > CommandList |
Unmaps all commands existing within this context from the given command list | UICommandsScriptingSubsystem.h | |
bool UnmapCommand
(
const TSharedRef< FScriptingCommand > ScriptingCommand |
Unmaps the given command from all the command lists of this context | UICommandsScriptingSubsystem.h | |
bool UnregisterCommandList
(
const TSharedRef< FUICommandList > CommandList |
Unregisters command list from this context then unmap from it all commands existing within this context | UICommandsScriptingSubsystem.h |