breakOut: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Category:[ _]?Scripting[ _]Commands[ _]Arma[ _]2(\|.*)]]" to "{{GameCategory|arma2|Scripting Commands}}")
m (Text replacement - "(\|[pr][0-9]+ *= *[^- ]*) *- *W([a-z ])" to "$1 - w$2")
 
(47 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
____________________________________________________________________________________________


| arma1 |Game name=
|game1= arma1
|version1= 1.00


|gr1= Program Flow |GROUP1=
|game2= arma2
|version2= 1.00


|1.00|Game version=
|game3= arma2oa
____________________________________________________________________________________________
|version3= 1.50


| Breaks the code execution out of scope {} named ''name''. [[nil]] is returned. Scope name can be assigned using [[scopeName]] command.
|game4= tkoh
{{Important|An unknown [[scopeName]] name will cause the script error {{Inline code|Generic error in expression}}}}
|version4= 1.00
{{Informative|An empty [[scopeName]] name will immediately leave the current scope}}
<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. |DESCRIPTION=
____________________________________________________________________________________________


| '''breakOut''' name |SYNTAX=
|game5= arma3
|version5= 0.50


|p1= name: [[String]] - name of the scope (previously set with [[scopeName]]) |PARAMETER1=
|gr1= Program Flow


| [[Nothing]] |RETURNVALUE=
|descr= Breaks out of the [[Variables#Scopes|scope]] with given '''name'''.
* An unknown [[scopeName]] name will cause the script error {{hl|Generic error in expression}}
* If multiple scopes with the same '''name''' exist, the command will break out the nearest scope. See {{Link|#Example 3}}.


|s2= value '''breakOut''' name {{since|arma3|1.47|y}} |SYNTAX2=
|s1= [[breakOut]]  name


|p21= value: [[Anything]] - a value to return |PARAMETER21=
|p1= name: [[String]] - name of the scope which was previously set with [[scopeName]]. <sqf inline>""</sqf> will exit the current scope (see also [[exitWith]])


|p22= name: [[String]] - name of the scope (previously set with [[scopeName]])  |PARAMETER22=
|r1= [[Nothing]]


|r2= [[Anything]] |RETURNVALUE2=
|s2= value [[breakOut]] name


|x1= <code>[[scopeName]] "main";
|s2since= arma3 1.48
[[while]] {[[true]]} [[do]] {
 
[[scopeName]] "loop1";
|p21= value: [[Anything]] - a value to return
[[while]] {[[true]]} [[do]] {
 
[[scopeName]] "loop2";
|p22= name: [[String]] - name of the scope which was previously set with [[scopeName]]. <sqf inline>""</sqf> will exit the current scope (see also [[exitWith]])
[[if]] (condition1) [[then]] {[[breakTo]] "main"}; {{cc|Breaks all scopes and return to "main"}}
 
[[if]] (condition2) [[then]] {[[breakOut]] "loop2"}; {{cc|Breaks scope named "loop2"}}
|r2= [[Anything]] - will return '''value'''
[[sleep]] 1;
 
|x1= <sqf>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;
sleep 1;
};
};</sqf>
</code> |EXAMPLE1=


|x2= <code>[[call]] {
|x2= <sqf>call {
[[scopeName]] "main";  
scopeName "main";
[[call]] {
call {
123 [[breakOut]] "main"
123 breakOut "main"
};
};
345
345
}; {{cc|call returns 123}}</code> |EXAMPLE2=
}; // call returns 123</sqf>
____________________________________________________________________________________________
 
| [[scopeName]], [[breakTo]], [[exitWith]] |SEEALSO=
}}
 
<h3 style="display:none">Notes</h3>
<h3 style="display:none">Bottom Section</h3>


<!-- CONTINUE Notes -->
|x3= <sqf>call {
<dl class="command_description">
scopeName "Main"; // Parent Main
<dd class="notedate">Posted on August 27, 2015 - 16:09 (UTC)</dd>
call {
<dt class="note">[[User:Polaris|Polaris]]</dt>
scopeName "Main"; // Child Main
<dd class="note">
"String" breakOut "Main"; // Will break out of child main and return "String" to parent main
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:
<code>[[call]] {
[[scopeName]] "Main"; [[a / b|/]]/Parent Ma[[in]]
[[call]] {
[[scopeName]] "Main"; [[a / b|/]]/Child Ma[[in]]
"String" [[breakOut]] "Main"; [[a / b|/]]/Will break out of child ma[[in]] [[and]] return "String" [[to]] parent ma[[in]]
};
};
};
};</sqf>
</code>
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.
</dd>
</dl>
<!-- DISCONTINUE Notes -->


{{GameCategory|arma2|Scripting Commands}}
|seealso= [[scopeName]] [[breakTo]] [[exitWith]]
{{GameCategory|arma2|Scripting Commands}}
}}
{{GameCategory|arma3|Scripting Commands}}
[[Category:Scripting Commands Take On Helicopters|{{uc:{{PAGENAME}}}}]]

Latest revision as of 17:35, 8 November 2023

Logo A1 black.png1.00Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.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

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
Retrieved from "https://community.bistudio.com/wiki?title=breakOut&oldid=349383"