UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | List of all members
IConsoleCommand Struct Referenceabstract

#include <IConsoleManager.h>

+ Inheritance diagram for IConsoleCommand:

Public Member Functions

virtual bool Execute (const TArray< FString > &Args, UWorld *InWorld, class FOutputDevice &OutputDevice)=0
 
- Public Member Functions inherited from IConsoleObject
 IConsoleObject ()
 
virtual ~IConsoleObject ()
 
virtual const TCHAR * GetHelp () const =0
 
virtual void SetHelp (const TCHAR *Value)=0
 
virtual EConsoleVariableFlags GetFlags () const =0
 
virtual void SetFlags (const EConsoleVariableFlags Value)=0
 
virtual FText GetDetailedHelp () const
 
void ClearFlags (const EConsoleVariableFlags Value)
 
bool TestFlags (const EConsoleVariableFlags Value) const
 
bool IsEnabled () const
 
virtual IConsoleObject * GetParentObject () const
 
virtual class IConsoleVariable * AsVariable ()
 
virtual bool IsVariableBool () const
 
virtual bool IsVariableInt () const
 
virtual bool IsVariableFloat () const
 
virtual bool IsVariableString () const
 
virtual class TConsoleVariableData< bool > * AsVariableBool ()
 
virtual class TConsoleVariableData< int32 > * AsVariableInt ()
 
virtual class TConsoleVariableData< float > * AsVariableFloat ()
 
virtual class TConsoleVariableData< FString > * AsVariableString ()
 
virtual struct IConsoleCommand * AsCommand ()
 
virtual bool IsShadowObject () const
 
virtual IConsoleObject * GetShadowedObject () const
 
virtual bool IsDeprecated () const
 

Detailed Description

Interface for console commands

Member Function Documentation

◆ Execute()

virtual bool IConsoleCommand::Execute ( const TArray< FString > &  Args,
UWorld *  InWorld,
class FOutputDevice &  OutputDevice 
)
pure virtual

Executes this command (optionally, with arguments)

Parameters
ArgsArgument list for this command
InWorldWorld context for this command
Returns
True if the delegate for this command was executed successfully

Implemented in FConsoleCommandExec, FConsoleCommandShadow, FConsoleCommand, FConsoleCommandWithArgs, FConsoleCommandWithWorld, FConsoleCommandWithWorldAndArgs, FConsoleCommanWithArgsAndOutputDevice, FConsoleCommandWithWorldArgsAndOutputDevice, and FConsoleCommandWithOutputDevice.

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