FAutoConsoleVariable Class Reference

#include <IConsoleManager.h>

Inheritance diagram for FAutoConsoleVariable:

Public Member Functions
CORE_API	FAutoConsoleVariable (const TCHAR *Name, bool DefaultValue, const TCHAR *Help, uint32 Flags=ECVF_Default)
CORE_API	FAutoConsoleVariable (const TCHAR *Name, int32 DefaultValue, const TCHAR *Help, uint32 Flags=ECVF_Default)
CORE_API	FAutoConsoleVariable (const TCHAR *Name, float DefaultValue, const TCHAR *Help, uint32 Flags=ECVF_Default)
CORE_API	FAutoConsoleVariable (const TCHAR *Name, const TCHAR *DefaultValue, const TCHAR *Help, uint32 Flags=ECVF_Default)
CORE_API	FAutoConsoleVariable (const TCHAR *Name, bool DefaultValue, const TCHAR *Help, const FConsoleVariableDelegate &Callback, uint32 Flags=ECVF_Default)
CORE_API	FAutoConsoleVariable (const TCHAR *Name, int32 DefaultValue, const TCHAR *Help, const FConsoleVariableDelegate &Callback, uint32 Flags=ECVF_Default)
CORE_API	FAutoConsoleVariable (const TCHAR *Name, float DefaultValue, const TCHAR *Help, const FConsoleVariableDelegate &Callback, uint32 Flags=ECVF_Default)
CORE_API	FAutoConsoleVariable (const TCHAR *Name, const TCHAR *DefaultValue, const TCHAR *Help, const FConsoleVariableDelegate &Callback, uint32 Flags=ECVF_Default)
UE_FORCEINLINE_HINT IConsoleVariable &	operator* ()
UE_FORCEINLINE_HINT const IConsoleVariable &	operator* () const
UE_FORCEINLINE_HINT IConsoleVariable *	operator-> ()
UE_FORCEINLINE_HINT const IConsoleVariable *	operator-> () const

Detailed Description

Autoregistering float, int or string console variable

Constructor & Destructor Documentation

FAutoConsoleVariable() [1/8]

FAutoConsoleVariable::FAutoConsoleVariable	(	const TCHAR *	Name,
		bool	DefaultValue,
		const TCHAR *	Help,
		uint32	Flags = ECVF_Default
	)

Create a bool console variable

Parameters

Name	must not be 0
Help	must not be 0
Flags	bitmask combined from EConsoleVariableFlags

FAutoConsoleVariable() [2/8]

FAutoConsoleVariable::FAutoConsoleVariable	(	const TCHAR *	Name,
		int32	DefaultValue,
		const TCHAR *	Help,
		uint32	Flags = ECVF_Default
	)

Create a int console variable

Parameters

Name	must not be 0
Help	must not be 0
Flags	bitmask combined from EConsoleVariableFlags

FAutoConsoleVariable() [3/8]

FAutoConsoleVariable::FAutoConsoleVariable	(	const TCHAR *	Name,
		float	DefaultValue,
		const TCHAR *	Help,
		uint32	Flags = ECVF_Default
	)

Create a float console variable

Parameters

Name	must not be 0
Help	must not be 0
Flags	bitmask combined from EConsoleVariableFlags

FAutoConsoleVariable() [4/8]

FAutoConsoleVariable::FAutoConsoleVariable	(	const TCHAR *	Name,
		const TCHAR *	DefaultValue,
		const TCHAR *	Help,
		uint32	Flags = ECVF_Default
	)

Create a string console variable

Parameters

Name	must not be 0
Help	must not be 0
Flags	bitmask combined from EConsoleVariableFlags

FAutoConsoleVariable() [5/8]

FAutoConsoleVariable::FAutoConsoleVariable	(	const TCHAR *	Name,
		bool	DefaultValue,
		const TCHAR *	Help,
		const FConsoleVariableDelegate &	Callback,
		uint32	Flags = ECVF_Default
	)

Create a bool console variable

Parameters

Name	must not be 0
Help	must not be 0
Callback	Delegate called when the variable changes.

See also

IConsoleVariable::SetOnChangedCallback

Parameters

Flags

bitmask combined from EConsoleVariableFlags

FAutoConsoleVariable() [6/8]

FAutoConsoleVariable::FAutoConsoleVariable	(	const TCHAR *	Name,
		int32	DefaultValue,
		const TCHAR *	Help,
		const FConsoleVariableDelegate &	Callback,
		uint32	Flags = ECVF_Default
	)

Create a int console variable

Parameters

Name	must not be 0
Help	must not be 0
Callback	Delegate called when the variable changes.

See also

IConsoleVariable::SetOnChangedCallback

Parameters

Flags

bitmask combined from EConsoleVariableFlags

FAutoConsoleVariable() [7/8]

FAutoConsoleVariable::FAutoConsoleVariable	(	const TCHAR *	Name,
		float	DefaultValue,
		const TCHAR *	Help,
		const FConsoleVariableDelegate &	Callback,
		uint32	Flags = ECVF_Default
	)

Create a float console variable

Parameters

Name	must not be 0
Help	must not be 0
Callback	Delegate called when the variable changes.

See also

IConsoleVariable::SetOnChangedCallback

Parameters

Flags

bitmask combined from EConsoleVariableFlags

FAutoConsoleVariable() [8/8]

FAutoConsoleVariable::FAutoConsoleVariable	(	const TCHAR *	Name,
		const TCHAR *	DefaultValue,
		const TCHAR *	Help,
		const FConsoleVariableDelegate &	Callback,
		uint32	Flags = ECVF_Default
	)

Create a string console variable

Parameters

Name	must not be 0
Help	must not be 0
Callback	Delegate called when the variable changes.

See also

IConsoleVariable::SetOnChangedCallback

Parameters

Flags

bitmask combined from EConsoleVariableFlags

Member Function Documentation

operator*() [1/2]

UE_FORCEINLINE_HINT IConsoleVariable & FAutoConsoleVariable::operator* ( )

inline

Dereference back to a console variable

operator*() [2/2]

UE_FORCEINLINE_HINT const IConsoleVariable & FAutoConsoleVariable::operator* ( ) const

inline

operator->() [1/2]

UE_FORCEINLINE_HINT IConsoleVariable * FAutoConsoleVariable::operator-> ( )

inline

Dereference back to a console variable

operator->() [2/2]

UE_FORCEINLINE_HINT const IConsoleVariable * FAutoConsoleVariable::operator-> ( ) const

inline

---

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

• Engine/Source/Runtime/Core/Public/HAL/IConsoleManager.h
• Engine/Source/Runtime/Core/Private/HAL/ConsoleManager.cpp