FAutoConsoleVariableRef Class Reference

#include <IConsoleManager.h>

Inheritance diagram for FAutoConsoleVariableRef:

Public Member Functions
CORE_API	FAutoConsoleVariableRef (const TCHAR *Name, int32 &RefValue, const TCHAR *Help, uint32 Flags=ECVF_Default)
CORE_API	FAutoConsoleVariableRef (const TCHAR *Name, float &RefValue, const TCHAR *Help, uint32 Flags=ECVF_Default)
CORE_API	FAutoConsoleVariableRef (const TCHAR *Name, bool &RefValue, const TCHAR *Help, uint32 Flags=ECVF_Default)
CORE_API	FAutoConsoleVariableRef (const TCHAR *Name, FString &RefValue, const TCHAR *Help, uint32 Flags=ECVF_Default)
CORE_API	FAutoConsoleVariableRef (const TCHAR *Name, FName &RefValue, const TCHAR *Help, uint32 Flags=ECVF_Default)
CORE_API	FAutoConsoleVariableRef (const TCHAR *Name, int32 &RefValue, const TCHAR *Help, const FConsoleVariableDelegate &Callback, uint32 Flags=ECVF_Default)
CORE_API	FAutoConsoleVariableRef (const TCHAR *Name, float &RefValue, const TCHAR *Help, const FConsoleVariableDelegate &Callback, uint32 Flags=ECVF_Default)
CORE_API	FAutoConsoleVariableRef (const TCHAR *Name, bool &RefValue, const TCHAR *Help, const FConsoleVariableDelegate &Callback, uint32 Flags=ECVF_Default)
CORE_API	FAutoConsoleVariableRef (const TCHAR *Name, FString &RefValue, const TCHAR *Help, const FConsoleVariableDelegate &Callback, uint32 Flags=ECVF_Default)
virtual	~FAutoConsoleVariableRef ()
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, bool, FString REF variable class...this changes that value when the console variable is changed.

Constructor & Destructor Documentation

FAutoConsoleVariableRef() [1/9]

FAutoConsoleVariableRef::FAutoConsoleVariableRef	(	const TCHAR *	Name,
		int32 &	RefValue,
		const TCHAR *	Help,
		uint32	Flags = ECVF_Default
	)

Create a reference to a int console variable

Parameters

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

FAutoConsoleVariableRef() [2/9]

FAutoConsoleVariableRef::FAutoConsoleVariableRef	(	const TCHAR *	Name,
		float &	RefValue,
		const TCHAR *	Help,
		uint32	Flags = ECVF_Default
	)

Create a reference to a float console variable

Parameters

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

FAutoConsoleVariableRef() [3/9]

FAutoConsoleVariableRef::FAutoConsoleVariableRef	(	const TCHAR *	Name,
		bool &	RefValue,
		const TCHAR *	Help,
		uint32	Flags = ECVF_Default
	)

Create a reference to a bool console variable

Parameters

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

FAutoConsoleVariableRef() [4/9]

FAutoConsoleVariableRef::FAutoConsoleVariableRef	(	const TCHAR *	Name,
		FString &	RefValue,
		const TCHAR *	Help,
		uint32	Flags = ECVF_Default
	)

Create a reference to a FString console variable

Parameters

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

FAutoConsoleVariableRef() [5/9]

FAutoConsoleVariableRef::FAutoConsoleVariableRef	(	const TCHAR *	Name,
		FName &	RefValue,
		const TCHAR *	Help,
		uint32	Flags = ECVF_Default
	)

Create a reference to a FName console variable

Parameters

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

FAutoConsoleVariableRef() [6/9]

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

Create a reference to 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

FAutoConsoleVariableRef() [7/9]

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

Create a reference to 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

FAutoConsoleVariableRef() [8/9]

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

Create a reference to 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

FAutoConsoleVariableRef() [9/9]

FAutoConsoleVariableRef::FAutoConsoleVariableRef	(	const TCHAR *	Name,
		FString &	RefValue,
		const TCHAR *	Help,
		const FConsoleVariableDelegate &	Callback,
		uint32	Flags = ECVF_Default
	)

Create a reference to a FString 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

~FAutoConsoleVariableRef()

virtual FAutoConsoleVariableRef::~FAutoConsoleVariableRef ( )

inlinevirtual

Member Function Documentation

operator*() [1/2]

UE_FORCEINLINE_HINT IConsoleVariable & FAutoConsoleVariableRef::operator* ( )

inline

Dereference back to a variable

operator*() [2/2]

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

inline

operator->() [1/2]

UE_FORCEINLINE_HINT IConsoleVariable * FAutoConsoleVariableRef::operator-> ( )

inline

Dereference back to a variable

operator->() [2/2]

UE_FORCEINLINE_HINT const IConsoleVariable * FAutoConsoleVariableRef::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