breakOut

From Bohemia Interactive Community
Jump to: navigation, search
Introduced with Armed Assault version 1.00
  

Click on the images for descriptions

Introduced in

Game:
Armed Assault
Version:
1.00

Description

Description:
Breaks the code execution out of scope {} named name. nil is returned. Scope name can be assigned using scopeName command.

Since Arma 3 v1.47, breakOut can be used to return a value. It is the closest SQF comes to having "return" like operation.

Syntax

Syntax:
breakOut name
Parameters:
name: String - name of the scope (previously set with scopeName)
Return Value:
Nothing

Alternative Syntax

Syntax:
value breakOut name         (since Arma 3 v1.47)
Parameters:
value: Anything - a value to return
name: String - name of the scope (previously set with scopeName)
Return Value:
Anything

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

Additional Information

Multiplayer:
-
See also:
scopeNamebreakToexitWith

Notes

Only post proven facts here. Report bugs on the feedback tracker. Use the talk page or the forums for discussions.
Add New Note | How To

Notes

Posted on 19 Aug, 2008
alef
When "name" is nil, the command is ignored.
When "name" is an undefined scope name or "", the script quits current scope. if (true) then { hint "1"; breakOut nil; hint "2"; }; //result "2" if (true) then { hint "1"; breakOut ""; hint "2"; }; //result "1" if (true) then { hint "1"; breakOut "dskfhdsklfh"; hint "2"; }; //result "1"

Bottom Section

Posted on August 27, 2015 - 16:09 (UTC)
Polaris
breakOut can still be used if multiple scopes share identical names. It will simply break out of the nearest scope that matches the name parameter you've used. For example: 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 }; }; Therefore you are able to consistently reuse scope names such as "Main", "Child", "Primary", "Secondary", etc throughout functions without worrying about having to ensure you create unique names for each scope.