FScopedTestEnvironment | Unreal Engine 5.7 Documentation

Utility for setting and management of temporary CVars Will handle restoring the Console Variables (CVars) back to the original state on destruction.


Name	FScopedTestEnvironment
Type	struct
Header File	/Engine/Source/Runtime/Engine/Public/Tests/AutomationCommon.h
Include Path	#include "Tests/AutomationCommon.h"

Syntax

struct FScopedTestEnvironment

Name	Remarks	Include Path	Unreal Specifiers
FScopedTestEnvironment ()		Tests/AutomationCommon.h
FScopedTestEnvironment ( FScopedTestEnvironment&& )		Tests/AutomationCommon.h
FScopedTestEnvironment ( const FScopedTestEnvironment& )		Tests/AutomationCommon.h

Name	Remarks	Include Path	Unreal Specifiers
~FScopedTestEnvironment()	Restores all set Console Variables back to the original value	Tests/AutomationCommon.h

Name	Type	Remarks	Include Path
EnvironmentInstance	TWeakPtr< struct FScopedTestEnvironment >		Tests/AutomationCommon.h

Name	Type	Remarks	Include Path	Unreal Specifiers
Variables	TMap< FString, FTestConsoleVariable >		Tests/AutomationCommon.h

Name	Remarks	Include Path
void Restore()	Restores all set Console Variables back to the original value	Tests/AutomationCommon.h
void SetConsoleVariableValue ( const FString& ConsoleVariableName, const FString& Value )	Sets a Console Variable to the specified value.	Tests/AutomationCommon.h
bool TryGetConsoleVariableValue ( const FString& ConsoleVariableName, FString* OutValue )	Gets the current overridden value for the specified Console Variable	Tests/AutomationCommon.h

Name	Remarks	Include Path	Unreal Specifiers
static TSharedPtr< FScopedTestEnvironment > Get ()	Returns a shared pointer to current instance of the scoped test environment.	Tests/AutomationCommon.h

Name	Remarks	Include Path	Unreal Specifiers
FScopedTestEnvironment & operator= ( FScopedTestEnvironment&& )		Tests/AutomationCommon.h
FScopedTestEnvironment & operator= ( const FScopedTestEnvironment& )		Tests/AutomationCommon.h