breakOut: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - "_{10,} " to "") |
Lou Montana (talk | contribs) 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 | {{Command | ||
| arma1 | | arma1 | ||
|gr1= Program Flow | |gr1= Program Flow | ||
|1.00 | |1.00 | ||
| Breaks the code execution out of scope {} named ''name''. [[nil]] is returned. Scope name can be assigned using [[scopeName]] command. | | Breaks the code execution out of scope {} named ''name''. [[nil]] is returned. Scope name can be assigned using [[scopeName]] command. | ||
| Line 11: | Line 11: | ||
{{Informative|An empty [[scopeName]] name will immediately leave the current scope}} | {{Informative|An empty [[scopeName]] name will immediately leave the current scope}} | ||
<br><br> | <br><br> | ||
Since Arma 3 v1.47, [[breakOut]] can be used to return a ''value''. It is the closest SQF comes to having "return"-like operation. | Since Arma 3 v1.47, [[breakOut]] can be used to return a ''value''. It is the closest SQF comes to having "return"-like operation. | ||
| '''breakOut''' name | | '''breakOut''' name | ||
|p1= name: [[String]] - name of the scope (previously set with [[scopeName]]) | |p1= name: [[String]] - name of the scope (previously set with [[scopeName]]) | ||
| [[Nothing]] | | [[Nothing]] | ||
|s2= value '''breakOut''' name {{Since|arma3|1.47|y}} | |s2= value '''breakOut''' name {{Since|arma3|1.47|y}} | ||
|p21= value: [[Anything]] - a value to return |PARAMETER21= | |p21= value: [[Anything]] - a value to return |PARAMETER21= | ||
| Line 25: | Line 25: | ||
|p22= name: [[String]] - name of the scope (previously set with [[scopeName]]) |PARAMETER22= | |p22= name: [[String]] - name of the scope (previously set with [[scopeName]]) |PARAMETER22= | ||
|r2= [[Anything]] | |r2= [[Anything]] | ||
|x1= <code>[[scopeName]] "main"; | |x1= <code>[[scopeName]] "main"; | ||
| Line 38: | Line 38: | ||
[[sleep]] 1; | [[sleep]] 1; | ||
}; | }; | ||
</code> | </code> | ||
|x2= <code>[[call]] { | |x2= <code>[[call]] { | ||
| Line 46: | Line 46: | ||
}; | }; | ||
345 | 345 | ||
}; {{cc|call returns 123}}</code> | }; {{cc|call returns 123}}</code> | ||
| [[scopeName]], [[breakTo]], [[exitWith]] | | [[scopeName]], [[breakTo]], [[exitWith]] | ||
}} | }} | ||
Revision as of 01:02, 18 January 2021
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.
- Groups:
- Program Flow
Syntax
- Syntax:
- breakOut name
- Parameters:
- name: String - name of the scope (previously set with scopeName)
- Return Value:
- Nothing
Alternative Syntax
- Syntax:
- value breakOut name Template:Since
- 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
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
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.