UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | List of all members
FConsoleCommandWithWorldAndArgs Class Reference
+ Inheritance diagram for FConsoleCommandWithWorldAndArgs:

Public Member Functions

 FConsoleCommandWithWorldAndArgs (const FConsoleCommandWithWorldAndArgsDelegate &InitDelegate, const TCHAR *InitHelp, const EConsoleVariableFlags InitFlags)
 
virtual void Release () override
 
virtual bool Execute (const TArray< FString > &Args, UWorld *InWorld, FOutputDevice &OutputDevice) override
 
- Public Member Functions inherited from FConsoleCommandBase
 FConsoleCommandBase (const TCHAR *InHelp, EConsoleVariableFlags InFlags)
 
void ApplyPreviewIfScalability ()
 
virtual const TCHAR * GetHelp () const
 
virtual void SetHelp (const TCHAR *InValue)
 
virtual EConsoleVariableFlags GetFlags () const
 
virtual void SetFlags (const EConsoleVariableFlags Value)
 
virtual struct IConsoleCommand * AsCommand ()
 
- Public Member Functions inherited from IConsoleObject
 IConsoleObject ()
 
virtual ~IConsoleObject ()
 
virtual FText GetDetailedHelp () const
 
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
 
virtual bool IsDeprecated () const
 

Constructor & Destructor Documentation

◆ FConsoleCommandWithWorldAndArgs()

FConsoleCommandWithWorldAndArgs::FConsoleCommandWithWorldAndArgs ( const FConsoleCommandWithWorldAndArgsDelegate &  InitDelegate,
const TCHAR *  InitHelp,
const EConsoleVariableFlags  InitFlags 
)
inline

Member Function Documentation

◆ Execute()

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

Executes this command (optionally, with arguments)

Parameters
ArgsArgument list for this command
InWorldWorld context for this command
Returns
True if the delegate for this command was executed successfully

Implements IConsoleCommand.

◆ Release()

virtual void FConsoleCommandWithWorldAndArgs::Release ( )
inlineoverridevirtual

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

Implements IConsoleObject.

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