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

#include <IConsoleManager.h>

+ Inheritance diagram for IConsoleObject:

Public Member Functions

 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
 

Friends

class FConsoleManager
 

Detailed Description

Interface for console objects (variables and commands)

Constructor & Destructor Documentation

◆ IConsoleObject()

IConsoleObject::IConsoleObject ( )
inline

◆ ~IConsoleObject()

virtual IConsoleObject::~IConsoleObject ( )
inlinevirtual

Member Function Documentation

◆ AsCommand()

virtual struct IConsoleCommand * IConsoleObject::AsCommand ( )
inlinevirtual

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

Reimplemented in FConsoleCommandBase, and FConsoleCommandShadow.

◆ AsVariable()

virtual class IConsoleVariable * IConsoleObject::AsVariable ( )
inlinevirtual

Casts this object to an IConsoleVariable, returns 0 if it's not

Reimplemented in FConsoleVariableBase, and FConsoleVariableShadow.

◆ AsVariableBool()

virtual class TConsoleVariableData< bool > * IConsoleObject::AsVariableBool ( )
inlinevirtual

Reimplemented in FConsoleVariable< T >, FConsoleVariable< T >, and FConsoleVariableShadow.

◆ AsVariableFloat()

virtual class TConsoleVariableData< float > * IConsoleObject::AsVariableFloat ( )
inlinevirtual

Reimplemented in FConsoleVariable< T >, FConsoleVariable< T >, and FConsoleVariableShadow.

◆ AsVariableInt()

virtual class TConsoleVariableData< int32 > * IConsoleObject::AsVariableInt ( )
inlinevirtual

Reimplemented in FConsoleVariable< T >, FConsoleVariable< T >, and FConsoleVariableShadow.

◆ AsVariableString()

virtual class TConsoleVariableData< FString > * IConsoleObject::AsVariableString ( )
inlinevirtual

Reimplemented in FConsoleVariable< T >, FConsoleVariable< T >, and FConsoleVariableShadow.

◆ ClearFlags()

void IConsoleObject::ClearFlags ( const EConsoleVariableFlags  Value)
inline

Removes the specified flags in the internal state.

◆ GetDetailedHelp()

virtual FText IConsoleObject::GetDetailedHelp ( ) const
inlinevirtual
Returns
a (potentially) more detailed help than GetHelp (e.g. current value for console variables)

Reimplemented in FConsoleCommandShadow, FConsoleVariableBase, and FConsoleVariableShadow.

◆ GetFlags()

virtual EConsoleVariableFlags IConsoleObject::GetFlags ( ) const
pure virtual

Get the internal state of the flags.

Implemented in FConsoleVariableBase, FConsoleCommandBase, FConsoleVariableShadow, and FConsoleCommandShadow.

◆ GetHelp()

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

Implemented in FConsoleVariableBase, FConsoleCommandBase, FConsoleVariableShadow, and FConsoleCommandShadow.

◆ GetParentObject()

virtual IConsoleObject * IConsoleObject::GetParentObject ( ) const
inlinevirtual

If the object has a parent (for instance the main cvar that owns an other-platform cvar), return it

◆ GetShadowedObject()

virtual IConsoleObject * IConsoleObject::GetShadowedObject ( ) const
inlinevirtual

If IsShadowObject() returns true, this function will return the "real" variable the shadow cvar is shadowing. Generally not needed, as most functions (like GetInt, Set, etc) will operate on the real variable already

Reimplemented in FConsoleVariableShadow.

◆ IsDeprecated()

virtual bool IConsoleObject::IsDeprecated ( ) const
inlinevirtual

Reimplemented in FConsoleVariableShadow, and FConsoleCommandShadow.

◆ IsEnabled()

bool IConsoleObject::IsEnabled ( ) const
inline

Test the validity of the variable wrt its flags and current build type (e.g. ECVF_Cheat variables are disabled on some targets)

◆ IsShadowObject()

virtual bool IConsoleObject::IsShadowObject ( ) const
inlinevirtual

A shadow ConsoleObject is one that exists and can be used, but shouldn't be iterated over in anything that walks over every object and acts on it

Reimplemented in FConsoleVariableShadow.

◆ IsVariableBool()

virtual bool IConsoleObject::IsVariableBool ( ) const
inlinevirtual

Reimplemented in FConsoleVariable< T >, FConsoleVariableRef< T >, FConsoleVariable< T >, FConsoleVariableRef< T >, and FConsoleVariableShadow.

◆ IsVariableFloat()

virtual bool IConsoleObject::IsVariableFloat ( ) const
inlinevirtual

Reimplemented in FConsoleVariable< T >, FConsoleVariableRef< T >, FConsoleVariable< T >, FConsoleVariableRef< T >, and FConsoleVariableShadow.

◆ IsVariableInt()

virtual bool IConsoleObject::IsVariableInt ( ) const
inlinevirtual

Reimplemented in FConsoleVariable< T >, FConsoleVariableRef< T >, FConsoleVariable< T >, FConsoleVariableRef< T >, and FConsoleVariableShadow.

◆ IsVariableString()

virtual bool IConsoleObject::IsVariableString ( ) const
inlinevirtual

Reimplemented in FConsoleVariable< T >, FConsoleVariable< T >, FConsoleVariableRef< T >, FConsoleVariableStringRef, FConsoleVariableNameRef, and FConsoleVariableShadow.

◆ SetFlags()

virtual void IConsoleObject::SetFlags ( const EConsoleVariableFlags  Value)
pure virtual

Sets the internal flag state to the specified value.

Implemented in FConsoleVariableBase, FConsoleCommandBase, FConsoleVariableShadow, and FConsoleCommandShadow.

◆ SetHelp()

virtual void IConsoleObject::SetHelp ( const TCHAR *  Value)
pure virtual
Returns
never 0, can be multi line ('
')

Implemented in FConsoleCommandBase, FConsoleCommandShadow, FConsoleVariableShadow, and FConsoleVariableBase.

◆ TestFlags()

bool IConsoleObject::TestFlags ( const EConsoleVariableFlags  Value) const
inline

Test is any of the specified flags is set in the internal state.

Friends And Related Symbol Documentation

◆ FConsoleManager

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