1. Epic GamesDeveloper
  3. FTestConsoleVariable

FTestConsoleVariable

Utility for setting and restoring of a Console Variable (CVar).

API > API/Runtime > API/Runtime/Engine > API/Runtime/Engine/Tests

References

   
Module Engine
Header /Engine/Source/Runtime/Engine/Public/Tests/AutomationCommon.h
Include #include "Tests/AutomationCommon.h"

Syntax

struct FTestConsoleVariable

Remarks

Utility for setting and restoring of a Console Variable (CVar).

Note that race conditions are possible when multiple [FTestConsoleVariable](API\Runtime\Engine\Tests\FTestConsoleVariable)_ objects refer to the same Console Variable and get restored/destroyed in an order different than they were set. Please use FScopedTestEnvironment to manage multiple `FTestConsoleVariable objects.

Constructors

  Type Name Description
Public function  

FTestConsoleVariable ( const FString& InConsoleVariableName
)

  
Public function    

Destructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function FString

Get ()

 Returns the current value of the Console Variable
Public function void

Restore ()

 Returns the Console Variable to the original value
Public function void

Set ( const FString& Value
)

 Sets a Console Variable to the specified value.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page