Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

> Unreal Engine API Reference > Runtime > Core > HAL > IConsoleObject

Light Theme

Dark Theme

IConsoleObject

Interface for console objects (variables and commands)

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

IConsoleObject

	IConsoleCommand
	IConsoleVariable

References

Module	Core
Header	/Engine/Source/Runtime/Core/Public/HAL/IConsoleManager.h
Include	#include "HAL/IConsoleManager.h"

Syntax

class IConsoleObject

Remarks

Interface for console objects (variables and commands)

Constructors

	Name	Description
	IConsoleObject()

Destructors

	Name	Description
	~IConsoleObject()

Functions

		Name	Description
	IConsoleComm...	AsCommand()	Casts this object to an IConsoleCommand, verifying first that it is safe to do so
	IConsoleVari...	AsVariable()	Casts this object to an IConsoleVariable, returns 0 if it's not
	TConsoleVari...	AsVariableBool()
	TConsoleVari...	AsVariableFloat()
	TConsoleVari...	AsVariableInt()
	TConsoleVari...	AsVariableString()
	void	ClearFlags ( const EConsoleVariableFlags Value )	Removes the specified flags in the internal state.
	EConsoleVari...	GetFlags()	Get the internal state of the flags.
	const TCHAR ...	GetHelp()
	bool	IsVariableBool()
	bool	IsVariableFloat()
	bool	IsVariableInt()
	bool	IsVariableString()
	void	SetFlags ( const EConsoleVariableFlags Value )	Sets the internal flag state to the specified value.
	void	SetHelp ( const TCHAR* Value )
	bool	TestFlags ( const EConsoleVariableFlags Value )	Test is any of the specified flags is set in the internal state.