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 5.3 Documentation

> Unreal Engine API Reference > Plugins > Gauntlet > UGauntletTestController

Light Theme

Dark Theme

UGauntletTestController

Base class for games to implement test controllers that use the Gauntlet native framework.

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UGauntletTestController

	UGauntletTestControllerBootTest
	UGauntletTestControllerErrorTest

References

Module	Gauntlet
Header	/Engine/Plugins/Experimental/Gauntlet/Source/Gauntlet/Public/GauntletTestController.h
Include	#include "GauntletTestController.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)()
class UGauntletTestController : public UObject

Remarks

Base class for games to implement test controllers that use the Gauntlet native framework. This is a very thin class that is created automatically based on command line params (-gauntlet=MyControllerName) and provides easily overridden functions that represent state changes and ticking

In essence your derived class should implement logic that starts and monitors a test, then calls EndTest(Result) when the desired criteria are met (or not!)

Constructors

	Name	Description
	UGauntletTestController ( const FObjectInitializer& ObjectIn... )	Default constructur

Destructors

	Name	Description
	~UGauntletTestController()

Functions

	Name	Description
void	EndTest ( int32 ExitCode )	Called to end testing and exit the app with provided code, static to avoid test instance state/lifetime dependency
FString	GetCurrentMap()	Return the name of the current persistent map
FName	GetCurrentState()	Returns the current state applied to Gauntlet
APlayerContr...	GetFirstPlayerController()	Helper function that returns the first player controller in the world (may be null depending on when called).
FGauntletMod...	GetGauntlet()	Returns the gauntlet module running this test
double	GetTimeInCurrentState()	Return the time since OnStateChange was called with the current state
UWorld *	GetWorld()	Return the current world
void	MarkHeartbeatActive ( const FString& OptionalStatusMessa... )	Marks the next heartbeat as active and immediately forces a heartbeat with the given status message if one is specified.
void	OnInit()	Called when the controller is first initialized
void	OnPostMapChange ( UWorld* World )	Called after a map change.
void	OnPreMapChange()	Called prior to a map change
void	OnStateChange ( FName OldState, FName NewState )	Called when a state change is applied to the module.
void	OnTick ( float TimeDelta )	Called periodically to let the controller check and control state

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss