assert: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "_{10,} " to "")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|Game|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments \("local" or "global"\)|Multiplayer Effects \("local" or "global"\)|Multiplayer Execution \("serv...)
Line 1: Line 1:
{{Command|Comments=
{{Command


| arma1 |Game name=
| arma1


|gr1= Program Flow |GROUP1=
|gr1= Program Flow






|1.00|Game version=
|1.00


| Tests a condition and if the condition is false, displays error on screen (if -showscripterrors enabled) and logs error into .rpt file. It does not interrupt the script execution.
| Tests a condition and if the condition is false, displays error on screen (if -showscripterrors enabled) and logs error into .rpt file. It does not interrupt the script execution.
Line 13: Line 13:
If script was pre-processed with [[preprocessFileLineNumbers]], it will also show/log the error line number and the file name.
If script was pre-processed with [[preprocessFileLineNumbers]], it will also show/log the error line number and the file name.


|DESCRIPTION=


| '''assert''' condition |SYNTAX=


|p1= condition: [[Boolean]] |PARAMETER1=
| '''assert''' condition


| [[Boolean]] - mirrors condition |RETURNVALUE=
|p1= condition: [[Boolean]]
 
| [[Boolean]] - mirrors condition
   
   
|x1= <code>[[assert]] (1>2);</code>  
|x1= <code>[[assert]] (1>2);</code>  
Line 25: Line 25:
[[Image:PreprocessFile.jpg]]
[[Image:PreprocessFile.jpg]]


|EXAMPLE1=
 


|x2= Check function params (Faster alternative to [[BIS_fnc_param]])<code>some_func = {
|x2= Check function params (Faster alternative to [[BIS_fnc_param]])<code>some_func = {
Line 39: Line 39:
};
};
[1,2,3] [[call]] some_func; //assert error
[1,2,3] [[call]] some_func; //assert error
<nowiki>[</nowiki>[1],"2",3] [[call]] some_func; //Alright!</code>|EXAMPLE2=
<nowiki>[</nowiki>[1],"2",3] [[call]] some_func; //Alright!</code>




| [[try]], [[catch]], [[throw]], [[halt]], [[diag_captureFrame]], [[diag_captureSlowFrame]], [[diag_logSlowFrame]]|SEEALSO=
| [[try]], [[catch]], [[throw]], [[halt]], [[diag_captureFrame]], [[diag_captureSlowFrame]], [[diag_logSlowFrame]]


}}
}}

Revision as of 00:02, 18 January 2021

Hover & click on the images for description

Description

Description:
Tests a condition and if the condition is false, displays error on screen (if -showscripterrors enabled) and logs error into .rpt file. It does not interrupt the script execution. If script was pre-processed with preprocessFileLineNumbers, it will also show/log the error line number and the file name.
Groups:
Program Flow

Syntax

Syntax:
assert condition
Parameters:
condition: Boolean
Return Value:
Boolean - mirrors condition

Examples

Example 1:
assert (1>2); PreprocessFile.jpg
Example 2:
Check function params (Faster alternative to BIS_fnc_param)some_func = { _0 = _this select 0; _1 = _this select 1; _2 = _this select 2; if (!assert ( typeName _0 == "ARRAY" && typeName _1 == "STRING" && typeName _2 == "SCALAR" )) exitWith {/*optional error logging*/}; hint "Alright!"; }; [1,2,3] call some_func; //assert error [[1],"2",3] call some_func; //Alright!

Additional Information

See also:
trycatchthrowhaltdiag_captureFramediag_captureSlowFramediag_logSlowFrame

Notes

Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note

Notes

Posted on May 15, 2010 - 0:01
Roehre
Returns false, if condition is false, and returns true, if condition is true.

Bottom Section