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 > Developer > FunctionalTesting > AFunctionalAITestBase

Light Theme

Dark Theme

AFunctionalAITestBase

[AFunctionalAITestBase](API\Developer\FunctionalTesting\AFunctionalAITestBase)

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

AActor

AFunctionalTest

AFunctionalAITestBase

AFunctionalAITest

References

Module	FunctionalTesting
Header	/Engine/Source/Developer/FunctionalTesting/Classes/FunctionalAITest.h
Include	#include "FunctionalAITest.h"

Syntax

class AFunctionalAITestBase : public AFunctionalTest

Remarks

AFunctionalAITestBase

Base abstract class defining a Functional AI Test. You can derive from this base class to create a test with a different type of SpawnSets.

Variables

	Name	Description
uint32: 1	bDebugNavMeshOnTimeout	If set, ftest will postpone start until navmesh is fully generated
uint32: 1	bSingleSetRun
uint32: 1	bWaitForNavMesh	If set, ftest will postpone start until navmesh is fully generated
int32	CurrentSpawnSetIndex
FString	CurrentSpawnSetName
FVector	NavMeshDebugExtent	Navmesh debug: extent around NavMeshDebugOrigin
FVector	NavMeshDebugOrigin	Navmesh debug: log navoctree modifiers around this point
FTimerHandle	NavmeshDelayTimer
FFunctionalTest...	OnAISpawned	Called when a single AI finished spawning
FFunctionalTest...	OnAllAISPawned	Called when a all AI finished spawning
TArray< FPendin...	PendingDelayedSpawns
TArray< APawn &...	SpawnedPawns
float	SpawnLocationRandomizationRange

Constructors

	Name	Description
	AFunctionalAITestBase ( const FObjectInitializer& ObjectIn... )

Functions

	Name	Description
void	AddSpawnedPawn ( APawn& SpawnedPawn )
void	ClearPendingDelayedSpawns()
void	ForEachSpawnSet ( TFunctionRef< void... )	Iterate through the list of spawn sets and execute Predicate on each.
void	ForEachSpawnSet ( TFunctionRef< void... )	Iterate through the list of spawn sets and execute Predicate on each in a const-correct way.
FVector	GetRandomizedLocation ( const FVector& Location )
FAITestSpawn...	GetSpawnInfo ( const int32 SpawnSetIndex, const int32 SpawnInfoIndex )	Return the SpawnInfo at SpawnInfoIndexof the SpawnSet at SpawnSetIndex.
const FAITes...	GetSpawnInfo ( const int32 SpawnSetIndex, const int32 SpawnInfoIndex )	Return the SpawnInfo at SpawnInfoIndexof the SpawnSet at SpawnSetIndex. Const-correct version.
const FAITes...	GetSpawnSet ( const int32 SpawnSetIndex )	Return the SpawnSet at this index of the SpawnSets array. Const-correct version.
FAITestSpawn...	GetSpawnSet ( const int32 SpawnSetIndex )	Return the SpawnSet at this index of the SpawnSets array.
bool	IsNavMeshReady()
bool	IsOneOfSpawnedPawns ( AActor* Actor )
bool	IsValidSpawnSetIndex ( const int32 Index )	Return whether the index is valid in the SpawnSets array.
void	KillOffSpawnedPawns()
void	OnSpawningFailure()
void	RemoveSpawnSetIfPredicate ( TFunctionRef< bool... )	Iterate through the list of spawn sets and remove the spawn set if Predicate returns true.
bool	Spawn ( const int32 SpawnSetIndex, const int32 SpawnInfoIndex )	Spawn this AI at this SpawnInfoIndex of the SpawnSetIndex spawn set.
void	StartSpawning()

Overridden from AFunctionalTest

	Name	Description
void	CleanUp()	Called to clean up when tests is removed from the list of active tests after finishing execution.
void	GatherRelevantActors ( TArray< AActor* >& OutActors )
FString	GetAdditionalTestFinishedMessage ( EFunctionalTestResult TestResult )
FString	GetReproString()
bool	IsReady_Implementation()
void	OnTimeout()
bool	RunTest ( const TArray< FString >& Params )
void	StartTest()	Called once the IsReady() check for the test returns true.
bool	WantsToRunAgain()

Overridden from AActor

		Name	Description
	void	BeginPlay()	Overridable native event for when play begins for this actor.
	void	Tick ( float DeltaSeconds )	Function called every frame on this Actor.

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

Take our survey

Dismiss