Navigation
API > API/Developer > API/Developer/FunctionalTesting
| Name | AFunctionalTest |
| Type | class |
| Header File | /Engine/Source/Developer/FunctionalTesting/Classes/FunctionalTest.h |
| Include Path | #include "FunctionalTest.h" |
Syntax
UCLASS (MinimalAPI, HideCategories=(Actor, Input, Rendering, HLOD), Blueprintable)
class AFunctionalTest : public AActor
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → AActor → AFunctionalTest
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
AFunctionalTest
(
const FObjectInitializer& ObjectInitializer |
FunctionalTest.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| Author | FString | The owner is the group or person responsible for the test. | FunctionalTest.h |
|
| AutoDestroyActors | TArray< TObjectPtr< AActor > > | FunctionalTest.h |
|
|
| bIsRunning | bool | AG TEMP - solving a compile issue in a temp way to unblock the build. | FunctionalTest.h |
|
| CurrentRerunCause | FName | Cause of the current rerun if we're in a named rerun. | FunctionalTest.h | |
| Description | FString | A description of the test, like what is this test trying to determine. | FunctionalTest.h |
|
| FailureMessage | FString | FunctionalTest.h | ||
| OnTestFinished | FFunctionalTestEventSignature | Called when the test is finished. Use it to clean up | FunctionalTest.h |
|
| OnTestPrepare | FFunctionalTestEventSignature | Called when the test is ready to prepare | FunctionalTest.h |
|
| OnTestStart | FFunctionalTestEventSignature | Called when the test is started | FunctionalTest.h |
|
| PreparationTimeLimit | float | The Test's time limit for preparation, this is the time it has to return true when checking IsReady(). | FunctionalTest.h |
|
| RenderComp | TObjectPtr< class UFuncTestRenderingComponent > | FunctionalTest.h | ||
| RerunCauses | TArray< FName > | List of causes we need a re-run. | FunctionalTest.h | |
| Result | EFunctionalTestResult | FunctionalTest.h |
|
|
| RunFrame | uint32 | FunctionalTest.h | ||
| RunTime | float | FunctionalTest.h | ||
| StartFrame | uint32 | FunctionalTest.h | ||
| StartTime | float | FunctionalTest.h | ||
| Steps | TArray< FString > | FunctionalTest.h | ||
| TestFinishedObserver | FFunctionalTestDoneSignature | FunctionalTest.h | ||
| TestLabel | FString | FunctionalTest.h |
|
|
| TestName | TObjectPtr< class UTextRenderComponent > | FunctionalTest.h | ||
| TestTags | FString | Tags describing this test separated by square brackets, such as '[dog]' or '[cat]' or '[Graphics][prio0][unstable]'. | FunctionalTest.h |
|
| TimeLimit | float | Test's time limit. '0' means no limit | FunctionalTest.h |
|
| TimesUpMessage | FText | FunctionalTest.h |
|
|
| TimesUpResult | EFunctionalTestResult | If test is limited by time this is the result that will be returned when time runs out | FunctionalTest.h |
|
| TotalTime | float | FunctionalTest.h |
|
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bIsReady | bool | FunctionalTest.h | ||
| EnvSetup | TSharedPtr< FScopedTestEnvironment > | FunctionalTest.h | ||
| SpriteComponent | TObjectPtr< UBillboardComponent > | FunctionalTest.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool ActorTypeSupportsDataLayer() |
FunctionalTest.h | ||
virtual bool ActorTypeSupportsExternalDataLayer() |
FunctionalTest.h | ||
virtual void AddError
(
const FString& Message |
FunctionalTest.h |
|
|
virtual void AddInfo
(
const FString& Message |
FunctionalTest.h |
|
|
void AddRerun
(
FName Reason |
Causes the test to be rerun for a specific named reason. | FunctionalTest.h |
|
void AddWarning
(
const FString& Message |
FunctionalTest.h |
|
|
virtual bool AssertEqual_Bool
(
bool Actual, |
Assert that two bools are equal | FunctionalTest.h |
|
virtual bool AssertEqual_Box2D
(
FBox2D Actual, |
Assert that two two-component boxes are (memberwise) equal within a small tolerance. | FunctionalTest.h |
|
bool AssertEqual_Double
(
double Actual, |
Assert that two double are equal within tolerance between two doubles. | FunctionalTest.h |
|
virtual bool AssertEqual_Float
(
float Actual, |
Assert that two floats are equal within tolerance between two floats. | FunctionalTest.h |
|
virtual bool AssertEqual_Int
(
int Actual, |
Assert that two ints are equal | FunctionalTest.h |
|
virtual bool AssertEqual_Matrix
(
FMatrix Actual, |
Assert that two 4x4 matrices are (memberwise) equal within a small tolerance. | FunctionalTest.h |
|
virtual bool AssertEqual_Name
(
FName Actual, |
Assert that two FNames are equal | FunctionalTest.h |
|
virtual bool AssertEqual_Object
(
UObject* Actual, |
Assert that two Objects are equal | FunctionalTest.h |
|
virtual bool AssertEqual_Plane
(
FPlane Actual, |
Assert that two planes are (memberwise) equal within a small tolerance. | FunctionalTest.h |
|
virtual bool AssertEqual_Quat
(
FQuat Actual, |
Assert that two quats are (memberwise) equal within a small tolerance. | FunctionalTest.h |
|
virtual bool AssertEqual_Rotator
(
FRotator Actual, |
Assert that the component angles of two rotators are all equal within a small tolerance. | FunctionalTest.h |
|
virtual bool AssertEqual_RotatorOrientation
(
FRotator Actual, |
Assert that the orientation of two rotators is the same within a small tolerance. | FunctionalTest.h |
|
virtual bool AssertEqual_String
(
FString Actual, |
Assert that two Strings are equal. | FunctionalTest.h |
|
virtual bool AssertEqual_TraceQueryResults
(
const UTraceQueryTestResults* Actual, |
Assert that two TraceQueryResults are equal. | FunctionalTest.h |
|
virtual bool AssertEqual_Transform
(
const FTransform& Actual, |
Assert that two transforms are (components memberwise - translation, rotation, scale) equal within a small tolerance. | FunctionalTest.h |
|
virtual bool AssertEqual_Vector
(
FVector Actual, |
Assert that two vectors are (memberwise) equal within a small tolerance. | FunctionalTest.h |
|
virtual bool AssertEqual_Vector2D
(
FVector2D Actual, |
Assert that two two-component vectors are (memberwise) equal within a small tolerance. | FunctionalTest.h |
|
virtual bool AssertEqual_Vector4
(
FVector4 Actual, |
Assert that two four-component vectors are (memberwise) equal within a small tolerance. | FunctionalTest.h |
|
virtual bool AssertFalse
(
bool Condition, |
Assert that a boolean value is false. | FunctionalTest.h |
|
virtual bool AssertIsValid
(
UObject* Object, |
Assert that a UObject is valid | FunctionalTest.h |
|
virtual bool AssertNotEqual_Box2D
(
FBox2D Actual, |
Assert that two two-component boxes are (memberwise) not equal within a small tolerance. | FunctionalTest.h |
|
virtual bool AssertNotEqual_Matrix
(
FMatrix Actual, |
Assert that two 4x4 matrices are (memberwise) not equal within a small tolerance. | FunctionalTest.h |
|
virtual bool AssertNotEqual_Plane
(
FPlane Actual, |
Assert that two planes are (memberwise) not equal within a small tolerance. | FunctionalTest.h |
|
virtual bool AssertNotEqual_Quat
(
FQuat Actual, |
Assert that two quats are (memberwise) not equal within a small tolerance. | FunctionalTest.h |
|
virtual bool AssertNotEqual_Rotator
(
FRotator Actual, |
Assert that the component angles of two rotators are all not equal within a small tolerance. | FunctionalTest.h |
|
virtual bool AssertNotEqual_String
(
FString Actual, |
Assert that two Strings are not equal. | FunctionalTest.h |
|
virtual bool AssertNotEqual_Transform
(
const FTransform& Actual, |
Assert that two transforms are (components memberwise - translation, rotation, scale) not equal within a small tolerance. | FunctionalTest.h |
|
virtual bool AssertNotEqual_Vector
(
FVector Actual, |
Assert that two vectors are (memberwise) not equal within a small tolerance. | FunctionalTest.h |
|
virtual bool AssertNotEqual_Vector2D
(
FVector2D Actual, |
Assert that two two-component vectors are (memberwise) not equal within a small tolerance. | FunctionalTest.h |
|
virtual bool AssertNotEqual_Vector4
(
FVector4 Actual, |
Assert that two four-component vectors are (memberwise) not equal within a small tolerance. | FunctionalTest.h |
|
virtual bool AssertTrue
(
bool Condition, |
Assert that a boolean value is true. | FunctionalTest.h |
|
virtual bool AssertValue_DateTime
(
FDateTime Actual, |
Assert on a relationship between two DateTimes. | FunctionalTest.h |
|
bool AssertValue_Double
(
double Actual, |
Assert on a relationship between two doubles. | FunctionalTest.h |
|
virtual bool AssertValue_Float
(
float Actual, |
Assert on a relationship between two floats. | FunctionalTest.h |
|
virtual bool AssertValue_Int
(
int32 Actual, |
Assert on a relationship between two integers. | FunctionalTest.h |
|
virtual bool CanChangeIsSpatiallyLoadedFlag() |
FunctionalTest.h | ||
virtual void CleanUp () |
Called to clean up when tests is removed from the list of active tests after finishing execution. | FunctionalTest.h | |
TArray< AActor * > DebugGatherRelevantActors() |
Used by debug drawing to gather actors this test is using and point at them on the level to better understand test's setup | FunctionalTest.h |
|
virtual void EndPlay
(
const EEndPlayReason::Type EndPlayReason |
FunctionalTest.h | ||
void FinishStep() |
FunctionalTest.h | ||
virtual void FinishTest
(
EFunctionalTestResult TestResult, |
FunctionalTest.h |
|
|
virtual void GatherRelevantActors
(
TArray< AActor* >& OutActors |
FunctionalTest.h | ||
virtual FString GetAdditionalTestFinishedMessage
(
EFunctionalTestResult TestResult |
FunctionalTest.h | ||
virtual void GetAssetRegistryTags
(
FAssetRegistryTagsContext Context |
FunctionalTest.h | ||
virtual void GetAssetRegistryTags
(
TArray< FAssetRegistryTag >& OutTags |
FunctionalTest.h | ||
FName GetCurrentRerunReason() |
Returns the current re-run reason if we're in a named re-run. | FunctionalTest.h |
|
FString GetCurrentStepName() |
FunctionalTest.h | ||
virtual FString GetReproString() |
FunctionalTest.h | ||
UBillboardComponent * GetSpriteComponent() |
Returns SpriteComponent subobject | FunctionalTest.h | |
bool IsEnabled() |
FunctionalTest.h |
|
|
bool IsEnabledInWorld
(
const UWorld* World |
FunctionalTest.h |
|
|
bool IsInStep() |
FunctionalTest.h | ||
bool IsRunning() |
FunctionalTest.h |
|
|
virtual void LogMessage
(
const FString& Message |
FunctionalTest.h |
|
|
void LogStep
(
ELogVerbosity::Type Verbosity, |
Protected: | FunctionalTest.h | |
FString OnAdditionalTestFinishedMessageRequest
(
EFunctionalTestResult TestResult |
FunctionalTest.h |
|
|
virtual void OnConstruction
(
const FTransform& Transform |
FunctionalTest.h | ||
bool OnWantsReRunCheck() |
Retrieves information whether test wants to have another run just after finishing | FunctionalTest.h |
|
void PostEditChangeProperty
(
FPropertyChangedEvent& PropertyChangedEvent |
FunctionalTest.h | ||
virtual void RegisterAutoDestroyActor
(
AActor* ActorToAutoDestroy |
Actors registered this way will be automatically destroyed (by limiting their lifespan) on test finish | FunctionalTest.h |
|
virtual bool RunTest
(
const TArray< FString >& Params |
FunctionalTest.h | ||
void SetConsoleVariable
(
const FString& Name, |
Sets the CVar from the given input. Variable gets reset after the test. | FunctionalTest.h |
|
void SetConsoleVariableFromBoolean
(
const FString& Name, |
Sets the CVar from the given input. Variable gets reset after the test. | FunctionalTest.h |
|
void SetConsoleVariableFromFloat
(
const FString& Name, |
Sets the CVar from the given input. Variable gets reset after the test. | FunctionalTest.h |
|
void SetConsoleVariableFromInteger
(
const FString& Name, |
Sets the CVar from the given input. Variable gets reset after the test. | FunctionalTest.h |
|
virtual void SetTimeLimit
(
float NewTimeLimit, |
FunctionalTest.h |
|
|
void StartStep
(
const FString& StepName |
FunctionalTest.h | ||
virtual void Tick
(
float DeltaSeconds |
FunctionalTest.h | ||
virtual bool WantsToRunAgain() |
FunctionalTest.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void GoToObservationPoint() |
Goto an observation location. | FunctionalTest.h | |
bool IsReady () |
IsReady() is called once per frame after a test is run, until it returns true. | FunctionalTest.h |
|
virtual bool IsReady_Implementation() |
FunctionalTest.h | ||
virtual void OnTimeout() |
FunctionalTest.h | ||
virtual void PrepareTest () |
Prepare Test is fired once the test starts up, before the test IsReady() and thus before Start Test is called. | FunctionalTest.h | |
void ReceivePrepareTest () |
Prepare Test is fired once the test starts up, before the test IsReady() and thus before Start Test is called. | FunctionalTest.h |
|
void ReceiveStartTest () |
Called once the IsReady() check for the test returns true. | FunctionalTest.h |
|
void ReceiveTestFinished () |
Called during FinishTest(). | FunctionalTest.h |
|
virtual void StartTest () |
Called once the IsReady() check for the test returns true. | FunctionalTest.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static void OnSelectObject
(
UObject* NewSelection |
FunctionalTest.h |