IConsoleCommandExecutor Class Reference

#include <IConsoleManager.h>

Inheritance diagram for IConsoleCommandExecutor:

Public Member Functions
virtual	~IConsoleCommandExecutor ()=default
virtual FName	GetName () const =0
virtual FText	GetDisplayName () const =0
virtual FText	GetDescription () const =0
virtual FText	GetHintText () const =0
virtual void	GetSuggestedCompletions (const TCHAR *Input, TArray< FConsoleSuggestion > &Out)=0
virtual void	GetAutoCompleteSuggestions (const TCHAR *Input, TArray< FString > &Out)
virtual void	GetExecHistory (TArray< FString > &Out)=0
virtual bool	Exec (const TCHAR *Input)=0
virtual bool	AllowHotKeyClose () const =0
virtual bool	AllowMultiLine () const =0
virtual struct FInputChord	GetHotKey () const =0
virtual struct FInputChord	GetIterateExecutorHotKey () const =0

Static Public Member Functions
static FName	ModularFeatureName ()

Detailed Description

Handles executing console commands

Constructor & Destructor Documentation

~IConsoleCommandExecutor()

virtual IConsoleCommandExecutor::~IConsoleCommandExecutor ( )

virtualdefault

Member Function Documentation

AllowHotKeyClose()

virtual bool IConsoleCommandExecutor::AllowHotKeyClose ( ) const

pure virtual

True if we allow the console to be closed using the "open console" hot-key.

Note

Some scripting languages use the default "open console" hot-key (~) in their code, so these should return false.

Implemented in FEngineConsoleCommandExecutor.

AllowMultiLine()

virtual bool IConsoleCommandExecutor::AllowMultiLine ( ) const

pure virtual

True if we allow the console to create multi-line commands.

Implemented in FEngineConsoleCommandExecutor.

Exec()

virtual bool IConsoleCommandExecutor::Exec ( const TCHAR *  Input )

pure virtual

Execute the given command using this executor.

Returns

true if the command was recognized.

Implemented in FEngineConsoleCommandExecutor.

GetAutoCompleteSuggestions()

virtual void IConsoleCommandExecutor::GetAutoCompleteSuggestions ( const TCHAR *  Input, TArray< FString > &  Out  )

inlinevirtual

Get the list of auto-complete suggestions for the given command.

GetDescription()

virtual FText IConsoleCommandExecutor::GetDescription ( ) const

pure virtual

Get the description of this executor.

Implemented in FEngineConsoleCommandExecutor.

GetDisplayName()

virtual FText IConsoleCommandExecutor::GetDisplayName ( ) const

pure virtual

Get the display name of this executor.

Implemented in FEngineConsoleCommandExecutor.

GetExecHistory()

virtual void IConsoleCommandExecutor::GetExecHistory ( TArray< FString > &  Out )

pure virtual

Get the list of commands that this executor has recently processed.

Implemented in FEngineConsoleCommandExecutor.

GetHintText()

virtual FText IConsoleCommandExecutor::GetHintText ( ) const

pure virtual

Get the hint text of this executor.

Implemented in FEngineConsoleCommandExecutor.

GetHotKey()

virtual struct FInputChord IConsoleCommandExecutor::GetHotKey ( ) const

pure virtual

Returns the hotkey for this executor

Implemented in FEngineConsoleCommandExecutor.

GetIterateExecutorHotKey()

virtual struct FInputChord IConsoleCommandExecutor::GetIterateExecutorHotKey ( ) const

pure virtual

Returns the hotkey to switch to the next executor. This is usually the same hotkey as GetHotKey but with a modifier, such as "`" turning into "Ctrl + `".

Implemented in FEngineConsoleCommandExecutor.

GetName()

virtual FName IConsoleCommandExecutor::GetName ( ) const

pure virtual

Get the name of this executor.

Implemented in FEngineConsoleCommandExecutor.

GetSuggestedCompletions()

virtual void IConsoleCommandExecutor::GetSuggestedCompletions ( const TCHAR *  Input, TArray< FConsoleSuggestion > &  Out  )

pure virtual

Get the list of auto-complete suggestions for the given command.

Implemented in FEngineConsoleCommandExecutor.

ModularFeatureName()

static FName IConsoleCommandExecutor::ModularFeatureName ( )

inlinestatic

Get the name identifying this modular feature set.

---

The documentation for this class was generated from the following file:

• Engine/Source/Runtime/Core/Public/HAL/IConsoleManager.h