breakOut: Difference between revisions

Revision as of 15:42, 19 June 2021

Hover & click on the images for description

Description:

Breaks out of the scope with given name.

An unknown scopeName name will cause the script error Generic error in expression
If multiple scopes with the same name exist, the command will break out the nearest scope. See Example 3.

Groups:

Program Flow

Syntax:: breakOut name
Parameters:: name: String - Name of the scope which was previously set with scopeName. "" will exit the current scope.
Return Value:: Nothing

Syntax:: value breakOut name Template:Since
Parameters:: value: Anything - A value to return
: name: String - Name of the scope which was previously set with scopeName. "" will exit the current scope.
Return Value:: Anything - Will return value

Example 1:: scopeName "main"; while {true} do { scopeName "loop1"; while {true} do { scopeName "loop2"; if (condition1) then {breakTo "main"}; // Breaks all scopes and return to "main" if (condition2) then {breakOut "loop2"}; // Breaks scope named "loop2" sleep 1; }; sleep 1; };
Example 2:: call { scopeName "main"; call { 123 breakOut "main" }; 345 }; // call returns 123
Example 3:: call { scopeName "Main"; //Parent Main call { scopeName "Main"; //Child Main "String" breakOut "Main"; //Will break out of child main and return "String" to parent main }; };

: 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

@@ Line 22: / Line 22: @@
 * If multiple scopes with the same '''name''' exist, the command will break out the nearest scope. See '''Example 3'''.
-|s1=  [[breakOut]]  name
+|s1= [[breakOut]]  name
 |p1= name: [[String]] - Name of the scope which was previously set with [[scopeName]]. {{ic|""}} will exit the current scope.