FScriptingCommandsContext

The list of commands and UI Command Lists associated with a context.

Choose your operating system:

Windows

macOS

Linux

References

Module

SlateScriptingCommands

Header

/Engine/Plugins/Slate/SlateScripting/Source/SlateScriptingCommands/Public/UICommandsScriptingSubsystem.h

Include

#include "UICommandsScriptingSubsystem.h"

Syntax

USTRUCT()
struct FScriptingCommandsContext

Remarks

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.

Variables

Name Description

Public variable

TArray< TWeakPt...

 

CommandLists

An array of command list associated to the given context

Public variable

FName

 

ContextName

The context these command lists are bound to

Public variable

TArray< TShared...

 

ScriptingCommands

The commands bound in these command lists

Constructors

Name Description

Public function

FScriptingCommandsContext()

Public function

FScriptingCommandsContext

(
    const FName InContextName
)

Functions

Name Description

Public function

void

 

MapAllCommands

(
    TSharedRef< FUICommandList > Comman...
)

Maps all commands existing within this context to the given command list

Public function

bool

 

MapCommand

(
    const TSharedRef< FScriptingCommand...
)

Maps the given command to all the command lists of this context

Public function

bool

 

RegisterCommandList

(
    const TSharedRef< FUICommandList > ...
)

Registers a command list in this context then map to it all commands existing within this context

Public function

void

 

UnmapAllCommands

(
    TSharedRef< FUICommandList > Comman...
)

Unmaps all commands existing within this context from the given command list

Public function

bool

 

UnmapCommand

(
    const TSharedRef< FScriptingCommand...
)

Unmaps the given command from all the command lists of this context

Public function

bool

 

UnregisterCommandList

(
    const TSharedRef< FUICommandList > ...
)

Unregisters command list from this context then unmap from it all commands existing within this context