Class FunctionalTest

Functional Test

Inheritance
System.Object
UObject
Actor
FunctionalTest
FunctionalAITest
ScreenshotFunctionalTestBase
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: UE4.FunctionalTesting
Assembly: UE4DotNet.dll
Syntax
public class FunctionalTest : Actor

Properties

| Improve this Doc View Source

AutoDestroyActors

Auto Destroy Actors

Declaration
public ObjectArrayField<Actor> AutoDestroyActors { get; }
Property Value
Type Description
ObjectArrayField<Actor>
| Improve this Doc View Source

bIsEnabled

Declaration
public bool bIsEnabled { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

bIsRunning

Declaration
public bool bIsRunning { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

bWarningsAsErrors

Declaration
public bool bWarningsAsErrors { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

DefaultObject

Get UE4 Default Object for this Class

Declaration
public static FunctionalTest DefaultObject { get; }
Property Value
Type Description
FunctionalTest
| Improve this Doc View Source

ObservationPoint

Allows you to specify another actor to view the test from.

Declaration
public Actor ObservationPoint { get; set; }
Property Value
Type Description
Actor
Remarks

Usually this is a camera you place in the map to observe the test. Not useful when running on a build farm, but provides a handy way to observe the test from a different location than you place the functional test actor.

| Improve this Doc View Source

PreparationTimeLimit

The Test's time limit for preparation, this is the time it has to return true when checking IsReady(). '0' means no limit.

Declaration
public float PreparationTimeLimit { get; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

RandomNumbersStream

A random number stream that you can use during testing.

Declaration
public RandomStream RandomNumbersStream { get; set; }
Property Value
Type Description
RandomStream
Remarks

This number stream will be consistent every time the test is run.

| Improve this Doc View Source

RenderComp

Render Comp

Declaration
public FuncTestRenderingComponent RenderComp { get; set; }
Property Value
Type Description
FuncTestRenderingComponent
| Improve this Doc View Source

SpriteComponent

Sprite Component

Declaration
public BillboardComponent SpriteComponent { get; set; }
Property Value
Type Description
BillboardComponent
| Improve this Doc View Source

StaticClass

Get UE4 Class

Declaration
public static Class StaticClass { get; }
Property Value
Type Description
Class
| Improve this Doc View Source

TestName

Test Name

Declaration
public TextRenderComponent TestName { get; set; }
Property Value
Type Description
TextRenderComponent
| Improve this Doc View Source

TimeLimit

Test's time limit. '0' means no limit

Declaration
public float TimeLimit { get; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

TotalTime

Total Time

Declaration
public float TotalTime { get; }
Property Value
Type Description
System.Single

Methods

| Improve this Doc View Source

AddError(String)

Add Error

Declaration
public void AddError(string Message)
Parameters
Type Name Description
System.String Message
| Improve this Doc View Source

AddRerun(Name)

Causes the test to be rerun for a specific named reason.

Declaration
public void AddRerun(Name Reason)
Parameters
Type Name Description
Name Reason
| Improve this Doc View Source

AddWarning(String)

Add Warning

Declaration
public void AddWarning(string Message)
Parameters
Type Name Description
System.String Message
| Improve this Doc View Source

AssertEqual_Bool(Boolean, Boolean, String, UObject)

Assert that two bools are equal @

Declaration
public bool AssertEqual_Bool(bool Actual, bool Expected, string What, UObject ContextObject)
Parameters
Type Name Description
System.Boolean Actual
System.Boolean Expected
System.String What
UObject ContextObject
Returns
Type Description
System.Boolean
Remarks

param What A name to use in the message if the assert fails (What: expected {Actual} to be Equal To {Expected} for context '')

| Improve this Doc View Source

AssertEqual_Float(Single, Single, String, Single, UObject)

Assert that two floats are equal within tolerance between two floats.

Declaration
public bool AssertEqual_Float(float Actual, float Expected, string What, float Tolerance, UObject ContextObject)
Parameters
Type Name Description
System.Single Actual
System.Single Expected
System.String What
System.Single Tolerance
UObject ContextObject
Returns
Type Description
System.Boolean
Remarks

@param What A name to use in the message if the assert fails (What: expected {Actual} to be Equal To {Expected} within Tolerance for context '')

| Improve this Doc View Source

AssertEqual_Int(Int32, Int32, String, UObject)

Assert that two ints are equal @

Declaration
public bool AssertEqual_Int(int Actual, int Expected, string What, UObject ContextObject)
Parameters
Type Name Description
System.Int32 Actual
System.Int32 Expected
System.String What
UObject ContextObject
Returns
Type Description
System.Boolean
Remarks

param What A name to use in the message if the assert fails (What: expected {Actual} to be Equal To {Expected} for context '')

| Improve this Doc View Source

AssertEqual_Name(Name, Name, String, UObject)

Assert that two FNames are equal @

Declaration
public bool AssertEqual_Name(Name Actual, Name Expected, string What, UObject ContextObject)
Parameters
Type Name Description
Name Actual
Name Expected
System.String What
UObject ContextObject
Returns
Type Description
System.Boolean
Remarks

param What A name to use in the message if the assert fails (What: expected {Actual} to be Equal To {Expected} for context '')

| Improve this Doc View Source

AssertEqual_Rotator(Rotator, Rotator, String, Single, UObject)

Assert that the component angles of two rotators are all equal within a small tolerance.

Declaration
public bool AssertEqual_Rotator(Rotator Actual, Rotator Expected, string What, float Tolerance, UObject ContextObject)
Parameters
Type Name Description
Rotator Actual
Rotator Expected
System.String What
System.Single Tolerance
UObject ContextObject
Returns
Type Description
System.Boolean
Remarks

@param What A name to use in the message if the assert fails ("Expected 'What' to be {Expected} but it was {Actual} for context ''")

| Improve this Doc View Source

AssertEqual_String(String, String, String, UObject)

Assert that two Strings are equal.

Declaration
public bool AssertEqual_String(string Actual, string Expected, string What, UObject ContextObject)
Parameters
Type Name Description
System.String Actual
System.String Expected
System.String What
UObject ContextObject
Returns
Type Description
System.Boolean
Remarks

@param What A name to use in the message if the assert fails ("Expected 'What' to be {Expected} but it was {Actual} for context ''")

| Improve this Doc View Source

AssertEqual_TraceQueryResults(TraceQueryTestResults, TraceQueryTestResults, String, UObject)

Assert that two TraceQueryResults are equal.

Declaration
public bool AssertEqual_TraceQueryResults(TraceQueryTestResults Actual, TraceQueryTestResults Expected, string What, UObject ContextObject)
Parameters
Type Name Description
TraceQueryTestResults Actual
TraceQueryTestResults Expected
System.String What
UObject ContextObject
Returns
Type Description
System.Boolean
Remarks

@param What A name to use in the message if the assert fails ("Expected 'What' not to be {Expected} but it was {Actual} for context ''")

| Improve this Doc View Source

AssertEqual_Transform(Transform, Transform, String, Single, UObject)

Assert that two transforms are (components memberwise - translation, rotation, scale) equal within a small tolerance.

Declaration
public bool AssertEqual_Transform(Transform Actual, Transform Expected, string What, float Tolerance, UObject ContextObject)
Parameters
Type Name Description
Transform Actual
Transform Expected
System.String What
System.Single Tolerance
UObject ContextObject
Returns
Type Description
System.Boolean
Remarks

@param What A name to use in the message if the assert fails ("Expected 'What' to be {Expected} but it was {Actual} for context ''")

| Improve this Doc View Source

AssertEqual_Vector(Vector, Vector, String, Single, UObject)

Assert that two vectors are (memberwise) equal within a small tolerance.

Declaration
public bool AssertEqual_Vector(Vector Actual, Vector Expected, string What, float Tolerance, UObject ContextObject)
Parameters
Type Name Description
Vector Actual
Vector Expected
System.String What
System.Single Tolerance
UObject ContextObject
Returns
Type Description
System.Boolean
Remarks

@param What A name to use in the message if the assert fails ("Expected 'What' to be {Expected} but it was {Actual} for context ''")

| Improve this Doc View Source

AssertFalse(Boolean, String, UObject)

Assert that a boolean value is false.

Declaration
public bool AssertFalse(bool Condition, string Message, UObject ContextObject)
Parameters
Type Name Description
System.Boolean Condition
System.String Message
UObject ContextObject
Returns
Type Description
System.Boolean
Remarks

@param Message The message to display if the assert fails ("Assertion Failed: 'Message' for context ''")

| Improve this Doc View Source

AssertIsValid(UObject, String, UObject)

Assert that a UObject is valid @

Declaration
public bool AssertIsValid(UObject UObject, string Message, UObject ContextObject)
Parameters
Type Name Description
UObject UObject
System.String Message
UObject ContextObject
Returns
Type Description
System.Boolean
Remarks

param Message The message to display if the object is invalid ("Invalid object: 'Message' for context ''")

| Improve this Doc View Source

AssertNotEqual_Rotator(Rotator, Rotator, String, UObject)

Assert that the component angles of two rotators are all not equal within a small tolerance.

Declaration
public bool AssertNotEqual_Rotator(Rotator Actual, Rotator NotExpected, string What, UObject ContextObject)
Parameters
Type Name Description
Rotator Actual
Rotator NotExpected
System.String What
UObject ContextObject
Returns
Type Description
System.Boolean
Remarks

@param What A name to use in the message if the assert fails ("Expected 'What' not to be {Expected} but it was {Actual} for context ''")

| Improve this Doc View Source

AssertNotEqual_String(String, String, String, UObject)

Assert that two Strings are not equal.

Declaration
public bool AssertNotEqual_String(string Actual, string NotExpected, string What, UObject ContextObject)
Parameters
Type Name Description
System.String Actual
System.String NotExpected
System.String What
UObject ContextObject
Returns
Type Description
System.Boolean
Remarks

@param What A name to use in the message if the assert fails ("Expected 'What' not to be {Expected} but it was {Actual} for context ''")

| Improve this Doc View Source

AssertNotEqual_Transform(Transform, Transform, String, UObject)

Assert that two transforms are (components memberwise - translation, rotation, scale) not equal within a small tolerance.

Declaration
public bool AssertNotEqual_Transform(Transform Actual, Transform NotExpected, string What, UObject ContextObject)
Parameters
Type Name Description
Transform Actual
Transform NotExpected
System.String What
UObject ContextObject
Returns
Type Description
System.Boolean
Remarks

@param What A name to use in the message if the assert fails ("Expected 'What' not to be {Expected} but it was {Actual} for context ''")

| Improve this Doc View Source

AssertNotEqual_Vector(Vector, Vector, String, UObject)

Assert that two vectors are (memberwise) not equal within a small tolerance.

Declaration
public bool AssertNotEqual_Vector(Vector Actual, Vector NotExpected, string What, UObject ContextObject)
Parameters
Type Name Description
Vector Actual
Vector NotExpected
System.String What
UObject ContextObject
Returns
Type Description
System.Boolean
Remarks

@param What A name to use in the message if the assert fails ("Expected 'What' not to be {Expected} but it was {Actual} for context ''")

| Improve this Doc View Source

AssertTrue(Boolean, String, UObject)

Assert that a boolean value is true.

Declaration
public bool AssertTrue(bool Condition, string Message, UObject ContextObject)
Parameters
Type Name Description
System.Boolean Condition
System.String Message
UObject ContextObject
Returns
Type Description
System.Boolean
Remarks

@param Message The message to display if the assert fails ("Assertion Failed: 'Message' for context ''")

| Improve this Doc View Source

AssertValue_DateTime(FDateTime, EComparisonMethod, FDateTime, String, UObject)

Declaration
public bool AssertValue_DateTime(FDateTime Actual, EComparisonMethod ShouldBe, FDateTime Expected, string What, UObject ContextObject)
Parameters
Type Name Description
FDateTime Actual
EComparisonMethod ShouldBe
FDateTime Expected
System.String What
UObject ContextObject
Returns
Type Description
System.Boolean
| Improve this Doc View Source

AssertValue_Float(Single, EComparisonMethod, Single, String, UObject)

Declaration
public bool AssertValue_Float(float Actual, EComparisonMethod ShouldBe, float Expected, string What, UObject ContextObject)
Parameters
Type Name Description
System.Single Actual
EComparisonMethod ShouldBe
System.Single Expected
System.String What
UObject ContextObject
Returns
Type Description
System.Boolean
| Improve this Doc View Source

AssertValue_Int(Int32, EComparisonMethod, Int32, String, UObject)

Declaration
public bool AssertValue_Int(int Actual, EComparisonMethod ShouldBe, int Expected, string What, UObject ContextObject)
Parameters
Type Name Description
System.Int32 Actual
EComparisonMethod ShouldBe
System.Int32 Expected
System.String What
UObject ContextObject
Returns
Type Description
System.Boolean
| Improve this Doc View Source

FinishTest(EFunctionalTestResult, String)

Finish Test

Declaration
public void FinishTest(EFunctionalTestResult TestResult, string Message)
Parameters
Type Name Description
EFunctionalTestResult TestResult
System.String Message
| Improve this Doc View Source

GetCurrentRerunReason()

Returns the current re-run reason if we're in a named re-run.

Declaration
public Name GetCurrentRerunReason()
Returns
Type Description
Name
| Improve this Doc View Source

IsEnabled()

Is Enabled

Declaration
public bool IsEnabled()
Returns
Type Description
System.Boolean
| Improve this Doc View Source

IsRunning()

AActor interface end

Declaration
public bool IsRunning()
Returns
Type Description
System.Boolean
| Improve this Doc View Source

LogMessage(String)

Log Message

Declaration
public void LogMessage(string Message)
Parameters
Type Name Description
System.String Message
| Improve this Doc View Source

New(UObject, Name)

Spawn an object of this class

Declaration
public static FunctionalTest New(UObject obj = null, Name name = default(Name))
Parameters
Type Name Description
UObject obj
Name name
Returns
Type Description
FunctionalTest
| Improve this Doc View Source

RegisterAutoDestroyActor(Actor)

ACtors registered this way will be automatically destroyed (by limiting their lifespan)

Declaration
public void RegisterAutoDestroyActor(Actor ActorToAutoDestroy)
Parameters
Type Name Description
Actor ActorToAutoDestroy
Remarks

on test finish

| Improve this Doc View Source

SetTimeLimit(Single, EFunctionalTestResult)

Set Time Limit

Declaration
public void SetTimeLimit(float NewTimeLimit, EFunctionalTestResult ResultWhenTimeRunsOut)
Parameters
Type Name Description
System.Single NewTimeLimit
EFunctionalTestResult ResultWhenTimeRunsOut

Events

| Improve this Doc View Source

IsReady

IsReady() is called once per frame after a test is run, until it returns true.

Declaration
public event FunctionalTest.IsReady_delegate IsReady
Event Type
Type Description
FunctionalTest.IsReady_delegate
Remarks

You should use this function to delay Start being called on the test until preconditions are met.

| Improve this Doc View Source

OnAdditionalTestFinishedMessageRequest

On Additional Test Finished Message Request

Declaration
public event FunctionalTest.OnAdditionalTestFinishedMessageRequest_delegate OnAdditionalTestFinishedMessageRequest
Event Type
Type Description
FunctionalTest.OnAdditionalTestFinishedMessageRequest_delegate
| Improve this Doc View Source

OnWantsReRunCheck

retrieves information whether test wants to have another run just after finishing

Declaration
public event FunctionalTest.OnWantsReRunCheck_delegate OnWantsReRunCheck
Event Type
Type Description
FunctionalTest.OnWantsReRunCheck_delegate
| Improve this Doc View Source

ReceivePrepareTest

Prepare Test is fired once the test starts up, before the test IsReady() and thus before Start Test is called.

Declaration
public event FunctionalTest.ReceivePrepareTest_delegate ReceivePrepareTest
Event Type
Type Description
FunctionalTest.ReceivePrepareTest_delegate
Remarks

So if there's some initial conditions or setup that you might need for your IsReady() check, you might want to do that here.

| Improve this Doc View Source

ReceiveStartTest

Called once the IsReady() check for the test returns true.

Declaration
public event FunctionalTest.ReceiveStartTest_delegate ReceiveStartTest
Event Type
Type Description
FunctionalTest.ReceiveStartTest_delegate
Remarks

After that happens the test has Officially started, and it will begin receiving Ticks in the blueprint.

Operators

| Improve this Doc View Source

Implicit(IntPtr to FunctionalTest)

Convert from IntPtr to UObject

Declaration
public static implicit operator FunctionalTest(IntPtr p)
Parameters
Type Name Description
System.IntPtr p
Returns
Type Description
FunctionalTest