UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FConsoleCommandBase Class Reference
+ Inheritance diagram for FConsoleCommandBase:

Public Member Functions

 FConsoleCommandBase (const TCHAR *InHelp, EConsoleVariableFlags InFlags)
 
void ApplyPreviewIfScalability ()
 
virtual const TCHARGetHelp () const
 
virtual void SetHelp (const TCHAR *InValue)
 
virtual EConsoleVariableFlags GetFlags () const
 
virtual void SetFlags (const EConsoleVariableFlags Value)
 
virtual struct IConsoleCommandAsCommand ()
 
- Public Member Functions inherited from IConsoleCommand
virtual bool Execute (const TArray< FString > &Args, UWorld *InWorld, class FOutputDevice &OutputDevice)=0
 
- Public Member Functions inherited from IConsoleObject
 IConsoleObject ()
 
virtual ~IConsoleObject ()
 
virtual FText GetDetailedHelp () const
 
void ClearFlags (const EConsoleVariableFlags Value)
 
bool TestFlags (const EConsoleVariableFlags Value) const
 
bool IsEnabled () const
 
virtual IConsoleObjectGetParentObject () const
 
virtual class IConsoleVariableAsVariable ()
 
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 bool IsShadowObject () const
 
virtual IConsoleObjectGetShadowedObject () const
 
virtual bool IsDeprecated () const
 

Constructor & Destructor Documentation

◆ FConsoleCommandBase()

FConsoleCommandBase::FConsoleCommandBase ( const TCHAR InHelp,
EConsoleVariableFlags  InFlags 
)
inline

Constructor

Parameters
InHelpmust not be 0, must not be empty

Member Function Documentation

◆ ApplyPreviewIfScalability()

void FConsoleCommandBase::ApplyPreviewIfScalability ( )
inline

◆ AsCommand()

virtual struct IConsoleCommand * FConsoleCommandBase::AsCommand ( )
inlinevirtual

Casts this object to an IConsoleCommand, verifying first that it is safe to do so

Reimplemented from IConsoleObject.

◆ GetFlags()

virtual EConsoleVariableFlags FConsoleCommandBase::GetFlags ( ) const
inlinevirtual

Get the internal state of the flags.

Implements IConsoleObject.

◆ GetHelp()

virtual const TCHAR * FConsoleCommandBase::GetHelp ( ) const
inlinevirtual
Returns
never 0, can be multi line ('
')

Implements IConsoleObject.

◆ SetFlags()

virtual void FConsoleCommandBase::SetFlags ( const EConsoleVariableFlags  Value)
inlinevirtual

Sets the internal flag state to the specified value.

Implements IConsoleObject.

◆ SetHelp()

virtual void FConsoleCommandBase::SetHelp ( const TCHAR Value)
inlinevirtual
Returns
never 0, can be multi line ('
')

Implements IConsoleObject.


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