FConsoleCommandExecutor

Executor for Unreal console commands

Windows
MacOS
Linux

Inheritance Hierarchy

IModularFeature

IConsoleCommandExecutor

FConsoleCommandExecutor

References

Module

UnrealEd

Header

/Engine/Source/Editor/UnrealEd/Public/Toolkits/FConsoleCommandExecutor.h

Include

#include "Toolkits/FConsoleCommandExecutor.h"

Syntax

class FConsoleCommandExecutor : public IConsoleCommandExecutor

Remarks

Executor for Unreal console commands

Functions

Name Description

Public function Static

FName

 

StaticName()

Overridden from IConsoleCommandExecutor

Name Description

Public function Virtual Const

bool

 

AllowHotKeyClose()

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

Public function Virtual Const

bool

 

AllowMultiLine()

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

Public function Virtual

bool

 

Exec

(
    const TCHAR* Input
)

Execute the given command using this executor.

Public function Virtual

void

 

GetAutoCompleteSuggestions

(
    const TCHAR* Input,
    TArray< FString >& Out
)

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

Public function Virtual Const

FText

 

GetDescription()

Get the description of this executor.

Public function Virtual Const

FText

 

GetDisplayName()

Get the display name of this executor.

Public function Virtual

void

 

GetExecHistory

(
    TArray< FString >& Out
)

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

Public function Virtual Const

FText

 

GetHintText()

Get the hint text of this executor.

Public function Virtual Const

FInputChord

 

GetHotKey()

Returns the hotkey for this executor

Public function Virtual Const

FName

 

GetName()

Get the name of this executor.

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback