Navigation
API > API/Runtime > API/Runtime/Core
Handles executing console commands
| Name | IConsoleCommandExecutor |
| Type | class |
| Header File | /Engine/Source/Runtime/Core/Public/HAL/IConsoleManager.h |
| Include Path | #include "HAL/IConsoleManager.h" |
Syntax
class IConsoleCommandExecutor : public IModularFeature
Derived Classes
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~IConsoleCommandExecutor() |
HAL/IConsoleManager.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool AllowHotKeyClose () |
True if we allow the console to be closed using the "open console" hot-key. | HAL/IConsoleManager.h | |
bool AllowMultiLine() |
True if we allow the console to create multi-line commands. | HAL/IConsoleManager.h | |
bool Exec
(
const TCHAR* Input |
Execute the given command using this executor. | HAL/IConsoleManager.h | |
| Get the list of auto-complete suggestions for the given command. | HAL/IConsoleManager.h | ||
FText GetDescription() |
Get the description of this executor. | HAL/IConsoleManager.h | |
FText GetDisplayName() |
Get the display name of this executor. | HAL/IConsoleManager.h | |
| Get the list of commands that this executor has recently processed. | HAL/IConsoleManager.h | ||
FText GetHintText() |
Get the hint text of this executor. | HAL/IConsoleManager.h | |
FInputChord GetHotKey() |
Returns the hotkey for this executor | HAL/IConsoleManager.h | |
FInputChord GetIterateExecutorHotKey () |
Returns the hotkey to switch to the next executor. | HAL/IConsoleManager.h | |
FName GetName() |
Get the name of this executor. | HAL/IConsoleManager.h | |
void GetSuggestedCompletions
(
const TCHAR* Input, |
Get the list of auto-complete suggestions for the given command. | HAL/IConsoleManager.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static FName ModularFeatureName() |
Get the name identifying this modular feature set. | HAL/IConsoleManager.h |