UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FConsoleVariableStringRef Class Reference
+ Inheritance diagram for FConsoleVariableStringRef:

Public Member Functions

 FConsoleVariableStringRef (FString &InRefValue, const TCHAR *Help, EConsoleVariableFlags Flags)
 
virtual void Release ()
 
virtual void Set (const TCHAR *Value, const FConsoleVariableBase::FResolvedContext &Context) override
 
virtual bool GetBool () const
 
virtual int32 GetInt () const
 
virtual float GetFloat () const
 
virtual FString GetString () const
 
virtual bool IsVariableString () const override
 
- Public Member Functions inherited from FConsoleVariableExtendedData< FString >
 FConsoleVariableExtendedData (const FString &DefaultValue, const TCHAR *Help, EConsoleVariableFlags Flags)
 
virtual ~FConsoleVariableExtendedData ()
 
virtual FResolvedContext ResolveContext (const FSetContext &Context) override
 
void SetInternalAndUpdateState (const FString &TypedValue, EConsoleVariableFlags SetBy)
 
virtual FString GetDefaultValue () override
 
FString 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 bool IsVariableBool () const
 
virtual bool IsVariableInt () const
 
virtual bool IsVariableFloat () const
 
virtual class TConsoleVariableData< bool > * AsVariableBool ()
 
virtual class TConsoleVariableData< int32 > * AsVariableInt ()
 
virtual class TConsoleVariableData< float > * AsVariableFloat ()
 
virtual class TConsoleVariableData< FString > * AsVariableString ()
 
virtual struct IConsoleCommandAsCommand ()
 
virtual bool IsShadowObject () const
 
virtual IConsoleObjectGetShadowedObject () const
 
virtual bool IsDeprecated () const
 

Additional Inherited Members

- Protected Member Functions inherited from FConsoleVariableExtendedData< FString >
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< FString >
FConsoleVariableHistory< FString > * PriorityHistory
 
- Protected Attributes inherited from FConsoleVariableBase
FString Help
 
EConsoleVariableFlags Flags
 
FConsoleVariableMulticastDelegate OnChangedCallback
 
FDelegateHandle LegacyDelegateHandle
 
bool bWarnedAboutThreadSafety
 

Constructor & Destructor Documentation

◆ FConsoleVariableStringRef()

FConsoleVariableStringRef::FConsoleVariableStringRef ( FString &  InRefValue,
const TCHAR Help,
EConsoleVariableFlags  Flags 
)
inline

Member Function Documentation

◆ GetBool()

virtual bool FConsoleVariableStringRef::GetBool ( ) const
inlinevirtual

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

Implements IConsoleVariable.

◆ GetFloat()

virtual float FConsoleVariableStringRef::GetFloat ( ) const
inlinevirtual

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

Implements IConsoleVariable.

◆ GetInt()

virtual int32 FConsoleVariableStringRef::GetInt ( ) const
inlinevirtual

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

Returns
value is not rounded (simple cast)

Implements IConsoleVariable.

◆ GetString()

virtual FString FConsoleVariableStringRef::GetString ( ) const
inlinevirtual

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

Implements IConsoleVariable.

◆ IsVariableString()

virtual bool FConsoleVariableStringRef::IsVariableString ( ) const
inlineoverridevirtual

Reimplemented from IConsoleObject.

◆ Release()

virtual void FConsoleVariableStringRef::Release ( )
inlinevirtual

should only be called by the manager, needs to be implemented for each instance

Implements IConsoleObject.

◆ Set()

virtual void FConsoleVariableStringRef::Set ( const TCHAR InValue,
const FConsoleVariableBase::FResolvedContext Context 
)
inlineoverridevirtual

Set the internal value from the specified string.

Parameters
InValueInternal Value to Set
ContextThe ResolvedContext of the FSetContext

Implements IConsoleVariable.


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