UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FAutoConsoleCommandDeprecated Class Reference

#include <IConsoleManager.h>

Public Member Functions

CORE_API FAutoConsoleCommandDeprecated (const TCHAR *Name, const TCHAR *CVarToShadow, const TCHAR *DeprecatedAtVersion, EShadowCVarBehavior UsageBehavior=EShadowCVarBehavior::Ensure, EShadowCVarBehavior LookupFailureBehavior=EShadowCVarBehavior::Ensure, const TCHAR *DeprecationMessage=TEXT(""))
 

Detailed Description

A class that can be used to deprecate a ConsoleCommand - use just like FAutoConsoleVariableDeprecated

Constructor & Destructor Documentation

◆ FAutoConsoleCommandDeprecated()

FAutoConsoleCommandDeprecated::FAutoConsoleCommandDeprecated ( const TCHAR Name,
const TCHAR CVarToShadow,
const TCHAR DeprecatedAtVersion,
EShadowCVarBehavior  UsageBehavior = EShadowCVarBehavior::Ensure,
EShadowCVarBehavior  LookupFailureBehavior = EShadowCVarBehavior::Ensure,
const TCHAR DeprecationMessage = TEXT("") 
)
Parameters
NameThe name of this cvar
CVarToShadowThe name of the existing cvar that this one will shadow
DeprecatedAtVersionTHe first UE version when this was deprecated
UsageBehaviorHow to handle uses of the shadowed cvar by the deprecated name - defaults to ensure
LookupFailureBehaviorHow to handle failure of looking up the CVarToShadow name - defaults to ensure
DeprecationMessageOptional deprecation message - defaults to empty, auto-generated.

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