breakOut

1.001.001.501.000.50

Hover & click on the images for description

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

Syntax:

breakOut name

Parameters:

name: String - Name of the scope which was previously set with scopeName. "" will exit the current scope (see also exitWith)

Return Value:

Nothing

1.48

Alternative Syntax

Syntax:

value breakOut name

Parameters:

value: Anything - A value to return

name: String - Name of the scope which was previously set with scopeName. "" will exit the current scope (see also exitWith)

Return Value:

Anything - Will return value

Examples

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 }; };

Additional Information

See also:

scopeName breakTo exitWith

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