Arma Reforger Script API
Loading...
Searching...
No Matches
SCR_AutotestResult Interface Reference

Game test result. More...

Inheritance diagram for SCR_AutotestResult:

Public Member Functions

string GetFailureReason ()
 Plain failure text.
 
override bool Failure ()
 Is failure.
 
override string FailureText ()
 Text used for xml report output.
 
void SCR_AutotestResult (bool isSuccess, string reason="")
 

Static Public Member Functions

static SCR_AutotestResult AsSuccess ()
 Create new result indicating that the test succeeded.
 
static SCR_AutotestResult AsFailure (string reason, string param1="", string param2="", string param3="")
 Create new result indicating that the test failed.
 

Protected Attributes

bool m_bIsSuccess
 
string m_sFailureReason
 

Detailed Description

Game test result.

Constructor & Destructor Documentation

◆ SCR_AutotestResult()

void SCR_AutotestResult.SCR_AutotestResult ( bool isSuccess,
string reason = "" )

Member Function Documentation

◆ AsFailure()

static SCR_AutotestResult SCR_AutotestResult.AsFailure ( string reason,
string param1 = "",
string param2 = "",
string param3 = "" )
static

Create new result indicating that the test failed.

Parameters
[in]reasonReason for the failure, supports string interpolation.
[in]param1String param
[in]param2String param
[in]param3String param
Returns
Failure result

◆ AsSuccess()

static SCR_AutotestResult SCR_AutotestResult.AsSuccess ( )
static

Create new result indicating that the test succeeded.

Returns
Success result

◆ Failure()

override bool SCR_AutotestResult.Failure ( )

Is failure.

Returns
true means failure

◆ FailureText()

override string SCR_AutotestResult.FailureText ( )

Text used for xml report output.

◆ GetFailureReason()

string SCR_AutotestResult.GetFailureReason ( )

Plain failure text.

Member Data Documentation

◆ m_bIsSuccess

bool SCR_AutotestResult.m_bIsSuccess
protected

◆ m_sFailureReason

string SCR_AutotestResult.m_sFailureReason
protected

The documentation for this interface was generated from the following file: