FConsoleCommandShadow Class Reference

Inheritance diagram for FConsoleCommandShadow:

Public Member Functions
	FConsoleCommandShadow (const TCHAR *CVarToShadow, EShadowCVarBehavior InLookupBehavior, EShadowCVarBehavior InUsageBehavior, bool bInIsDeprecated, const TCHAR *InDeprecatedVersion, const TCHAR *InDeprecationMessage)
virtual struct IConsoleCommand *	AsCommand () override
virtual bool	IsDeprecated () const override
virtual const TCHAR *	GetHelp () const override
virtual void	SetHelp (const TCHAR *InValue) override
virtual FText	GetDetailedHelp () const
virtual EConsoleVariableFlags	GetFlags () const override
virtual void	SetFlags (const EConsoleVariableFlags Value) override
virtual bool	Execute (const TArray< FString > &Args, UWorld *InWorld, class FOutputDevice &OutputDevice) override
virtual void	Release () override
Public Member Functions inherited from IConsoleObject
	IConsoleObject ()
virtual	~IConsoleObject ()
void	ClearFlags (const EConsoleVariableFlags Value)
bool	TestFlags (const EConsoleVariableFlags Value) const
bool	IsEnabled () const
virtual IConsoleObject *	GetParentObject () const
virtual class IConsoleVariable *	AsVariable ()
virtual bool	IsVariableBool () const
virtual bool	IsVariableInt () const
virtual bool	IsVariableFloat () const
virtual bool	IsVariableString () const
virtual class TConsoleVariableData< bool > *	AsVariableBool ()
virtual class TConsoleVariableData< int32 > *	AsVariableInt ()
virtual class TConsoleVariableData< float > *	AsVariableFloat ()
virtual class TConsoleVariableData< FString > *	AsVariableString ()
virtual bool	IsShadowObject () const
virtual IConsoleObject *	GetShadowedObject () const

Protected Member Functions
virtual IConsoleObject *	GetRealObject () const override
virtual void	SetRealObject (IConsoleObject *Object) const override
virtual FString	GetThisName () const override
Protected Member Functions inherited from FConsoleObjectShadowData
	FConsoleObjectShadowData (const TCHAR *CVarToShadow, EShadowCVarBehavior InLookupBehavior, EShadowCVarBehavior InUsageBehavior, bool bInIsDeprecated, const TCHAR *InDeprecatedVersion, const TCHAR *InDeprecationMessage=nullptr)
virtual	~FConsoleObjectShadowData ()
void	LogOrEditorMessage (const FText &Msg, bool bIsError) const
bool	Bind () const
bool	BindForUsage () const

Additional Inherited Members
Protected Attributes inherited from FConsoleObjectShadowData
FString	ShadowName
FString	DeprecatedVersion
FString	DeprecationMessage
EShadowCVarBehavior	LookupBehavior
EShadowCVarBehavior	UsageBehavior
uint8	bHasLooked: 1
uint8	bHasMessagedForUsage: 1
uint8	bHasMessagedEditorForUsage: 1
uint8	bIsDeprecated: 1

Constructor & Destructor Documentation

FConsoleCommandShadow()

FConsoleCommandShadow::FConsoleCommandShadow ( const TCHAR *  CVarToShadow, EShadowCVarBehavior  InLookupBehavior, EShadowCVarBehavior  InUsageBehavior, bool  bInIsDeprecated, const TCHAR *  InDeprecatedVersion, const TCHAR *  InDeprecationMessage  )

inline

Member Function Documentation

AsCommand()

virtual struct IConsoleCommand * FConsoleCommandShadow::AsCommand ( )

inlineoverridevirtual

Casts this object to an IConsoleCommand, verifying first that it is safe to do so

Reimplemented from IConsoleObject.

Execute()

virtual bool FConsoleCommandShadow::Execute ( const TArray< FString > &  Args, UWorld *  InWorld, class FOutputDevice &  OutputDevice  )

inlineoverridevirtual

Executes this command (optionally, with arguments)

Parameters

Args	Argument list for this command
InWorld	World context for this command

Returns

True if the delegate for this command was executed successfully

Implements IConsoleCommand.

GetDetailedHelp()

virtual FText FConsoleCommandShadow::GetDetailedHelp ( ) const

inlinevirtual

Returns

a (potentially) more detailed help than GetHelp (e.g. current value for console variables)

Reimplemented from IConsoleObject.

GetFlags()

virtual EConsoleVariableFlags FConsoleCommandShadow::GetFlags ( ) const

inlineoverridevirtual

Get the internal state of the flags.

Implements IConsoleObject.

GetHelp()

virtual const TCHAR * FConsoleCommandShadow::GetHelp ( ) const

inlineoverridevirtual

Returns

never 0, can be multi line ('
')

Implements IConsoleObject.

GetRealObject()

virtual IConsoleObject * FConsoleCommandShadow::GetRealObject ( ) const

inlineoverrideprotectedvirtual

Implements FConsoleObjectShadowData.

GetThisName()

virtual FString FConsoleCommandShadow::GetThisName ( ) const

inlineoverrideprotectedvirtual

Implements FConsoleObjectShadowData.

IsDeprecated()

virtual bool FConsoleCommandShadow::IsDeprecated ( ) const

inlineoverridevirtual

Reimplemented from IConsoleObject.

Release()

virtual void FConsoleCommandShadow::Release ( )

inlineoverridevirtual

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

Implements IConsoleObject.

SetFlags()

virtual void FConsoleCommandShadow::SetFlags ( const EConsoleVariableFlags  Value )

inlineoverridevirtual

Sets the internal flag state to the specified value.

Implements IConsoleObject.

SetHelp()

virtual void FConsoleCommandShadow::SetHelp ( const TCHAR *  Value )

inlineoverridevirtual

Returns

never 0, can be multi line ('
')

Implements IConsoleObject.

SetRealObject()

virtual void FConsoleCommandShadow::SetRealObject ( IConsoleObject *  Object ) const

inlineoverrideprotectedvirtual

Implements FConsoleObjectShadowData.

---

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

• Engine/Source/Runtime/Core/Private/HAL/ConsoleManager.cpp