UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FRangedConsoleVariable< T > Class Template Reference
+ Inheritance diagram for FRangedConsoleVariable< T >:

Public Member Functions

 FRangedConsoleVariable (const FString &Name, T DefaultValue, T MinValue, T MaxValue, const TCHAR *Help, EConsoleVariableFlags Flags, IConsoleVariable *Parent)
 
virtual bool GetBool () const override
 
virtual int32 GetInt () const override
 
virtual float GetFloat () const override
 
virtual FString GetString () const override
 
- Public Member Functions inherited from FConsoleVariable< T >
 FConsoleVariable (T DefaultValue, const TCHAR *Help, EConsoleVariableFlags Flags, IConsoleVariable *Parent=nullptr)
 
virtual void Release ()
 
virtual void Set (const TCHAR *Value, const FConsoleVariableBase::FResolvedContext &Context) override
 
virtual bool IsVariableBool () const override
 
virtual bool IsVariableInt () const override
 
virtual bool IsVariableFloat () const override
 
virtual bool IsVariableString () const override
 
virtual class TConsoleVariableData< bool > * AsVariableBool () override
 
virtual class TConsoleVariableData< int32 > * AsVariableInt () override
 
virtual class TConsoleVariableData< float > * AsVariableFloat () override
 
virtual class TConsoleVariableData< FString > * AsVariableString () override
 
bool IsVariableBool () const
 
bool IsVariableInt () const
 
bool IsVariableFloat () const
 
bool IsVariableString () const
 
TConsoleVariableData< bool > * AsVariableBool ()
 
TConsoleVariableData< int32 > * AsVariableInt ()
 
TConsoleVariableData< float > * AsVariableFloat ()
 
void Set (const TCHAR *Value, const FConsoleVariableBase::FResolvedContext &Context)
 
TConsoleVariableData< FString > * AsVariableString ()
 
- Public Member Functions inherited from FConsoleVariableExtendedData< T >
 FConsoleVariableExtendedData (const T &DefaultValue, const TCHAR *Help, EConsoleVariableFlags Flags)
 
virtual ~FConsoleVariableExtendedData ()
 
virtual FResolvedContext ResolveContext (const FSetContext &Context) override
 
void SetInternalAndUpdateState (const T &TypedValue, EConsoleVariableFlags SetBy)
 
virtual FString GetDefaultValue () override
 
GetDefaultTypedValue ()
 
- Public Member Functions inherited from FConsoleVariableBase
 FConsoleVariableBase (const TCHAR *InHelp, EConsoleVariableFlags InFlags)
 
void ApplyPreviewIfScalability ()
 
virtual const TCHARGetHelp () const
 
virtual void SetHelp (const TCHAR *Value) override final
 
virtual FText GetDetailedHelp () const override
 
virtual EConsoleVariableFlags GetFlags () const
 
virtual void SetFlags (const EConsoleVariableFlags Value)
 
virtual class IConsoleVariableAsVariable ()
 
virtual void SetOnChangedCallback (const FConsoleVariableDelegate &Callback)
 
virtual FConsoleVariableMulticastDelegateOnChangedDelegate ()
 
bool CanChange (EConsoleVariableFlags SetBy) const
 
- Public Member Functions inherited from IConsoleVariable
void GetValue (int32 &OutIntValue) const
 
void GetValue (bool &OutBoolValue) const
 
void GetValue (float &OutFloatValue) const
 
void GetValue (FString &OutStringValue) const
 
virtual IConsoleVariableGetDefaultValueVariable ()
 
void Set (const TCHAR *InValue, const FSetContext &Context)
 
void Set (bool InValue, const FSetContext &Context)
 
void Set (int32 InValue, const FSetContext &Context)
 
void Set (float InValue, const FSetContext &Context)
 
template<typename T >
void Set (T Value, EConsoleVariableFlags Flags=ECVF_SetByCode, FName Tag=NAME_None)
 
template<typename T >
void SetWithCurrentPriority (T Value, FName Tag=NAME_None, EConsoleVariableFlags MaxPriority=ECVF_SetByConsole, EConsoleVariableFlags MinPriority=SETBY_ERROR)
 
template<typename T >
void ReplaceCurrentPriorityAndTag (T InValue, EConsoleVariableFlags MaxPriority=ECVF_SetByConsole, EConsoleVariableFlags MinPriority=SETBY_ERROR)
 
- Public Member Functions inherited from IConsoleObject
 IConsoleObject ()
 
virtual ~IConsoleObject ()
 
void ClearFlags (const EConsoleVariableFlags Value)
 
bool TestFlags (const EConsoleVariableFlags Value) const
 
bool IsEnabled () const
 
virtual IConsoleObjectGetParentObject () const
 
virtual struct IConsoleCommandAsCommand ()
 
virtual bool IsShadowObject () const
 
virtual IConsoleObjectGetShadowedObject () const
 
virtual bool IsDeprecated () const
 

Public Attributes

IConsoleVariableMin
 
IConsoleVariableMax
 

Additional Inherited Members

- Protected Member Functions inherited from FConsoleVariableExtendedData< T >
bool TrackHistory (const TCHAR *InValue, EConsoleVariableFlags SetBy, FName Tag)
 
virtual SIZE_T GetHistorySize () override
 
void LogHistory (FOutputDevice &Ar)
 
bool PreprocessSet (const TCHAR *InValue, EConsoleVariableFlags SetBy, FName Tag)
 
virtual void Unset (EConsoleVariableFlags SetBy, FName Tag) override
 
- Protected Member Functions inherited from FConsoleVariableBase
uint32 GetShadowIndex () const
 
- Protected Attributes inherited from FConsoleVariableExtendedData< T >
FConsoleVariableHistory< T > * PriorityHistory = nullptr
 
- Protected Attributes inherited from FConsoleVariableBase
FString Help
 
EConsoleVariableFlags Flags
 
FConsoleVariableMulticastDelegate OnChangedCallback
 
FDelegateHandle LegacyDelegateHandle
 
bool bWarnedAboutThreadSafety
 

Constructor & Destructor Documentation

◆ FRangedConsoleVariable()

template<typename T >
FRangedConsoleVariable< T >::FRangedConsoleVariable ( const FString &  Name,
DefaultValue,
MinValue,
MaxValue,
const TCHAR Help,
EConsoleVariableFlags  Flags,
IConsoleVariable Parent 
)
inline

Member Function Documentation

◆ GetBool()

template<typename T >
virtual bool FRangedConsoleVariable< T >::GetBool ( ) const
inlineoverridevirtual

Get the internal value as a bool, works on bools, ints and floats.

Reimplemented from FConsoleVariable< T >.

◆ GetFloat()

template<typename T >
virtual float FRangedConsoleVariable< T >::GetFloat ( ) const
inlineoverridevirtual

Get the internal value as float (works on all types).

Reimplemented from FConsoleVariable< T >.

◆ GetInt()

template<typename T >
virtual int32 FRangedConsoleVariable< T >::GetInt ( ) const
inlineoverridevirtual

Get the internal value as int (should not be used on strings).

Returns
value is not rounded (simple cast)

Reimplemented from FConsoleVariable< T >.

◆ GetString()

template<typename T >
virtual FString FRangedConsoleVariable< T >::GetString ( ) const
inlineoverridevirtual

Get the internal value as string (works on all types).

Reimplemented from FConsoleVariable< T >.

Member Data Documentation

◆ Max

◆ Min


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