1. Epic GamesDeveloper
  3. UEditorUtilityTest

UEditorUtilityTest

API > API/Plugins > API/Plugins/EditorTests

Inheritance Hierarchy

References

   
Module EditorTests
Header /Engine/Plugins/Tests/EditorTests/Source/EditorTests/Classes/EditorUtilityTest.h
Include #include "EditorUtilityTest.h"

Syntax

UCLASS&40;Blueprintable, Meta&61;&40;ShowWorldContextPin&41;&41;  
class UEditorUtilityTest : public UObject

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly FString Description A description of the test, like what is this test trying to determine.
Public variable UProperty BlueprintAssignable FEditorUtilityTestFinishedSignature OnTestFinished Called when the test is finished. Use it to clean up
Public variable UProperty BlueprintAssignable FEditorUtilityTestEventSignature OnTestPrepare Called when the test is ready to prepare
Public variable UProperty BlueprintAssignable FEditorUtilityTestEventSignature OnTestStart Called when the test is started
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly FString Owner The owner is the group or person responsible for the test.
Public variable UProperty Category, EditAnywhere BlueprintReadOnly float PreparationTimeLimit The Test's time limit for preparation, this is the time it has to trigger IsReadyToStart().
Protected variable EEditorUtilityTestResult State  
Public variable UProperty Category, EditAnywhere BlueprintReadOnly float TimeLimit Test's total run time limit. '0' means no limit

Constructors

  Type Name Description
Public function  

UEditorUtilityTest ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Protected function Virtual UFunction BlueprintCallable, Category void

AddError ( const FString& Message
)

 Add Error
Protected function Virtual UFunction BlueprintCallable, Category void

AddInfo ( const FString& Message
)

 Add Info
Protected function Virtual UFunction BlueprintCallable, Category void

AddWarning ( const FString& Message
)

 Add Warning
Protected function Virtual UFunction BlueprintCallable, Category, Meta void

ExpectFalse ( bool Condition,
const FString& ErrorMessage
)

 Add error if expected condition is true
Protected function Virtual UFunction BlueprintCallable, Category, Meta void

ExpectTrue ( bool Condition,
const FString& ErrorMessage
)

 Add error if expected condition is false
Protected function Virtual UFunction BlueprintCallable, Category void Tell the blueprint VM to start the test (to use at the end of Prepare Test event).
Protected function Virtual UFunction BlueprintCallable, Category, Meta void

FinishTest ( EEditorUtilityTestResult TestState,
const FString& Message
)

 Tell the VM the test is finished with specify state.
Public function Virtual UFunction BlueprintCallable, Category EEditorUtilityTestResult Get test state
Public function Virtual UFunction BlueprintCallable, Category bool Is test ruuning
Protected function UFunction Category blueprintnativeevent void Use to setup test before running, must call FinishPrepareTest at the end to actual start the test.
Protected function UFunction Category, Meta, BlueprintImplementableEvent void Use to add clean up steps, the call is blocking.
Protected function UFunction BlueprintCallable, Category void

Run ()

 Blueprint Utility Editor entry point
Protected function UFunction Category blueprintnativeevent void Actual run the test, must call FinishTest at then end of test with a state to signify the test is done.
Protected function Virtual bool

Tick ( float DeltaSeconds
)

  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page