1. Epic GamesDeveloper
  3. UEditorUtilityTest

UEditorUtilityTest

API > API/Plugins > API/Plugins/EditorTests

   
Name UEditorUtilityTest
Type class
Header File /Engine/Plugins/Tests/EditorTests/Source/EditorTests/Classes/EditorUtilityTest.h
Include Path #include "EditorUtilityTest.h"

Syntax

UCLASS (Blueprintable, Meta=(ShowWorldContextPin))  
class UEditorUtilityTest : public UObject

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UEditorUtilityTest ( const FObjectInitializer& ObjectInitializer
)

   EditorUtilityTest.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
Description FString A description of the test, like what is this test trying to determine. EditorUtilityTest.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="Context"
  • Meta=(MultiLine="true")
OnTestFinished FEditorUtilityTestFinishedSignature Called when the test is finished. Use it to clean up EditorUtilityTest.h
  • BlueprintAssignable
OnTestPrepare FEditorUtilityTestEventSignature Called when the test is ready to prepare EditorUtilityTest.h
  • BlueprintAssignable
OnTestStart FEditorUtilityTestEventSignature Called when the test is started EditorUtilityTest.h
  • BlueprintAssignable
Owner FString The owner is the group or person responsible for the test. EditorUtilityTest.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="Context"
  • Meta=(MultiLine="true")
PreparationTimeLimit float The Test's time limit for preparation, this is the time it has to trigger IsReadyToStart(). EditorUtilityTest.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="Timeout"
TimeLimit float Test's total run time limit. '0' means no limit EditorUtilityTest.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="Timeout"

Protected

Name Type Remarks Include Path Unreal Specifiers
StartTime FDateTime   EditorUtilityTest.h  
TickDelegate FTickerDelegate Delegate for callbacks to Tick EditorUtilityTest.h  
TickDelegateHandle FTSTicker::FDelegateHandle Handle to various registered delegates EditorUtilityTest.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual EEditorUtilityTestResult GetState()

 Get test state EditorUtilityTest.h
  • BlueprintCallable
  • Category="Editor Utility Test"

virtual bool IsRunning()

 Is test ruuning EditorUtilityTest.h
  • BlueprintCallable
  • Category="Editor Utility Test"

Protected

Name Remarks Include Path Unreal Specifiers

virtual void AddError ( const FString& Message
)

 Add Error EditorUtilityTest.h
  • BlueprintCallable
  • Category="Editor Utility Test"

virtual void AddInfo ( const FString& Message
)

 Add Info EditorUtilityTest.h
  • BlueprintCallable
  • Category="Editor Utility Test"

virtual void AddWarning ( const FString& Message
)

 Add Warning EditorUtilityTest.h
  • BlueprintCallable
  • Category="Editor Utility Test"

virtual void ExpectFalse ( bool Condition,
const FString& ErrorMessage
)

 Add error if expected condition is true EditorUtilityTest.h
  • BlueprintCallable
  • Category="Editor Utility Test"
  • Meta=(AdvancedDisplay="ErrorMessage")

virtual void ExpectTrue ( bool Condition,
const FString& ErrorMessage
)

 Add error if expected condition is false EditorUtilityTest.h
  • BlueprintCallable
  • Category="Editor Utility Test"
  • Meta=(AdvancedDisplay="ErrorMessage")

virtual void FinishPrepareTest()

 Tell the blueprint VM to start the test (to use at the end of Prepare Test event). EditorUtilityTest.h
  • BlueprintCallable
  • Category="Editor Utility Test"

virtual void FinishTest ( EEditorUtilityTestResult TestState,
const FString& Message
)

 Tell the VM the test is finished with specify state. EditorUtilityTest.h
  • BlueprintCallable
  • Category="Editor Utility Test"
  • Meta=(AdvancedDisplay="Message")

void PrepareTest()

 Use to setup test before running, must call FinishPrepareTest at the end to actual start the test. EditorUtilityTest.h
  • BlueprintNativeEvent
  • Category="Editor Utility Test"

void ReceiveFinishedTest ( EEditorUtilityTestResult TestState,
EEditorUtilityTestResult& FinalState
)

 Use to add clean up steps, the call is blocking. EditorUtilityTest.h
  • BlueprintImplementableEvent
  • Category="Editor Utility Test"
  • Meta=(DisplayName="Finished Test")

void Run()

 Blueprint Utility Editor entry point EditorUtilityTest.h
  • BlueprintCallable
  • Category="Editor Utility Test"

void StartTest()

 Actual run the test, must call FinishTest at then end of test with a state to signify the test is done. EditorUtilityTest.h
  • BlueprintNativeEvent
  • Category="Editor Utility Test"

virtual bool Tick ( float DeltaSeconds
)

   EditorUtilityTest.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page