FEngineConsoleCommandExecutor Class Reference

#include <EngineConsoleCommandExecutor.h>

Inheritance diagram for FEngineConsoleCommandExecutor:

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

Static Public Member Functions
static FName	StaticName ()
Static Public Member Functions inherited from IConsoleCommandExecutor
static FName	ModularFeatureName ()

Constructor & Destructor Documentation

FEngineConsoleCommandExecutor()

FEngineConsoleCommandExecutor::FEngineConsoleCommandExecutor ( UGameEngine *  GameEngine )

explicit

~FEngineConsoleCommandExecutor()

FEngineConsoleCommandExecutor::~FEngineConsoleCommandExecutor

(

)

Member Function Documentation

AllowHotKeyClose()

bool FEngineConsoleCommandExecutor::AllowHotKeyClose ( ) const

finalvirtual

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.

Implements IConsoleCommandExecutor.

AllowMultiLine()

bool FEngineConsoleCommandExecutor::AllowMultiLine ( ) const

finalvirtual

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

Implements IConsoleCommandExecutor.

Exec()

bool FEngineConsoleCommandExecutor::Exec ( const TCHAR *  Input )

finalvirtual

Execute the given command using this executor.

Returns

true if the command was recognized.

Implements IConsoleCommandExecutor.

GetDescription()

FText FEngineConsoleCommandExecutor::GetDescription ( ) const

finalvirtual

Get the description of this executor.

Implements IConsoleCommandExecutor.

GetDisplayName()

FText FEngineConsoleCommandExecutor::GetDisplayName ( ) const

finalvirtual

Get the display name of this executor.

Implements IConsoleCommandExecutor.

GetExecHistory()

void FEngineConsoleCommandExecutor::GetExecHistory ( TArray< FString > &  Out )

finalvirtual

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

Implements IConsoleCommandExecutor.

GetHintText()

FText FEngineConsoleCommandExecutor::GetHintText ( ) const

finalvirtual

Get the hint text of this executor.

Implements IConsoleCommandExecutor.

GetHotKey()

FInputChord FEngineConsoleCommandExecutor::GetHotKey ( ) const

finalvirtual

Returns the hotkey for this executor

Implements IConsoleCommandExecutor.

GetIterateExecutorHotKey()

FInputChord FEngineConsoleCommandExecutor::GetIterateExecutorHotKey ( ) const

finalvirtual

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 + `".

Implements IConsoleCommandExecutor.

GetName()

FName FEngineConsoleCommandExecutor::GetName ( ) const

finalvirtual

Get the name of this executor.

Implements IConsoleCommandExecutor.

GetSuggestedCompletions()

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

finalvirtual

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

Implements IConsoleCommandExecutor.

StaticName()

FName FEngineConsoleCommandExecutor::StaticName ( )

static

---

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

• Engine/Source/Runtime/Engine/Private/Engine/EngineConsoleCommandExecutor.h
• Engine/Source/Runtime/Engine/Private/Engine/EngineConsoleCommandExecutor.cpp