Navigation
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
- UObjectBase → UObjectBaseUtility → UObject → UEditorUtilityTest
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 |
|
| OnTestFinished | FEditorUtilityTestFinishedSignature | Called when the test is finished. Use it to clean up | EditorUtilityTest.h |
|
| OnTestPrepare | FEditorUtilityTestEventSignature | Called when the test is ready to prepare | EditorUtilityTest.h |
|
| OnTestStart | FEditorUtilityTestEventSignature | Called when the test is started | EditorUtilityTest.h |
|
| Owner | FString | The owner is the group or person responsible for the test. | EditorUtilityTest.h |
|
| PreparationTimeLimit | float | The Test's time limit for preparation, this is the time it has to trigger IsReadyToStart(). | EditorUtilityTest.h |
|
| TimeLimit | float | Test's total run time limit. '0' means no limit | EditorUtilityTest.h |
|
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 |
|
virtual bool IsRunning() |
Is test ruuning | EditorUtilityTest.h |
|
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void AddError
(
const FString& Message |
Add Error | EditorUtilityTest.h |
|
virtual void AddInfo
(
const FString& Message |
Add Info | EditorUtilityTest.h |
|
virtual void AddWarning
(
const FString& Message |
Add Warning | EditorUtilityTest.h |
|
virtual void ExpectFalse
(
bool Condition, |
Add error if expected condition is true | EditorUtilityTest.h |
|
virtual void ExpectTrue
(
bool Condition, |
Add error if expected condition is false | EditorUtilityTest.h |
|
virtual void FinishPrepareTest() |
Tell the blueprint VM to start the test (to use at the end of Prepare Test event). | EditorUtilityTest.h |
|
virtual void FinishTest
(
EEditorUtilityTestResult TestState, |
Tell the VM the test is finished with specify state. | EditorUtilityTest.h |
|
void PrepareTest() |
Use to setup test before running, must call FinishPrepareTest at the end to actual start the test. | EditorUtilityTest.h |
|
void ReceiveFinishedTest
(
EEditorUtilityTestResult TestState, |
Use to add clean up steps, the call is blocking. | EditorUtilityTest.h |
|
void Run() |
Blueprint Utility Editor entry point | EditorUtilityTest.h |
|
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 |
|
virtual bool Tick
(
float DeltaSeconds |
EditorUtilityTest.h |