Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

> Unreal Engine API Reference > Plugins > NetcodeUnitTest > FUnitTestEnvironment

Light Theme

Dark Theme

FUnitTestEnvironment

Class for handling per-game implementation of unit test environmental defaults

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

FUnitTestEnvironment

	FQAGameEnvironment
	FShooterGameEnvironment
	FUTEnvironment

References

Module	NetcodeUnitTest
Header	/Engine/Plugins/NetcodeUnitTest/NetcodeUnitTest/Source/NetcodeUnitTest/Public/UnitTestEnvironment.h
Include	#include "UnitTestEnvironment.h"

Syntax

class FUnitTestEnvironment

Remarks

Class for handling per-game implementation of unit test environmental defaults

Variables

		Name	Description
	UUnitTest *	UnitTest	The unit test being initialized using the current environment (WARNING: Will be nullptr for legacy unit tests)

Constructors

	Name	Description
	FUnitTestEnvironment()

Destructors

	Name	Description
	~FUnitTestEnvironment()

Functions

	Name	Description
void	AddUnitTestEnvironment ( FString Game, FUnitTestEnvironment* Env )	Adds a new environment to the unit test environment list
void	GetClientProgressLogs ( const TArray< FString >*& OutT... )	Returns client log messages, for the current game, that indicate progress logs for resetting unit test timeout
FString	GetDefaultClientConnectURL()	Returns the default URL that minimal clients should use, when connecting to a server, for the current game
FString	GetDefaultClientParameters()	Returns the default parameters for launched clients
FString	GetDefaultMap ( EUnitTestFlags UnitTestFlags )	Returns the default map name, that should be used with unit tests, for the current game
FString	GetDefaultServerParameters ( FString InLogCmds, FString InExecCmds )	Returns the default parameters for launched servers
uint32	GetDefaultUnitTestTimeout()	Returns the default/minimum timeout that unit tests should use, for the current game
void	GetProgressBlockingProcesses ( const TArray< FString >*& OutB... )	Returns child process names, that indicate progress blockers in starting up (e.g. shader compiler) All child processes, including server/client child processes (and their children) are checked.
void	GetServerProgressLogs ( const TArray< FString >& OutS..., const TArray< FString >& OutR..., const TArray< FString >*& OutT... )	Returns server log messages, for the current game, that indicate progress in starting up
void	HandleClientPlayer ( EUnitTestFlags UnitTestFlags, APlayerController* PC )	Executes game-specific handling, upon client unit tests initializing the client PlayerController
void	InitializeClientProgressLogs ( TArray< FString >& TimeoutResetLog... )	Called when initializing the static arrays, containing the client progress logs
void	InitializeProgressBlockingProcesses ( TArray< FString >& BlockingProcess... )	Called when initializing the static arrays, containing the progress blocking processes
void	InitializeServerProgressLogs ( TArray< FString >& StartProgressLo..., TArray< FString >& ReadyLogs, TArray< FString >& TimeoutResetLog... )	Called when initializing the static arrays, containing the server progress logs
void	InitializeUnitTasks()	If the game environment requires special/complex setup (e.g. player auth before join), then UnitTask's for handling complex setup, are added here.
void	Register()	Registers the unit test environment, with the environment list IMPORTANT: This MUST be implemented in every subclass, and the subclass version MUST called, within your modules 'StartupModule'
void	SetupDefaultClientParameters ( FString& OutCommandline )	Sets up the default client parameters, specifying a (potentially already modified) commandline for modification
void	SetupDefaultServerParameters ( FString& OutCommandline, FString& OutLogCmds, FString& OutExecCmds )	Sets up the default server parameters, specifying commandline and '-*Cmds=x' separately (combined within parent function above)