breakOut: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "<sqf>([^↵][^<]*↵[^<]*)<\/sqf>" to "<sqf> $1 </sqf>")
 
(84 intermediate revisions by 9 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


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


|1.00|= Game version
|game2= arma2
____________________________________________________________________________________________
|version2= 1.00


| Breaks block out of scope named name. Nil is returned.
|game3= arma2oa
|version3= 1.50


Scope name can be assigned using [[scopeName]] command. |= Description
|game4= tkoh
____________________________________________________________________________________________
|version4= 1.00


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


|p1= name: [[String]] |= Parameter 1
|gr1= Program Flow


| [[Nothing]] |= Return value
|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}}.


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


| [[scopeName]], [[breakTo]] |= See also
|p22= name: [[String]] - name of the scope which was previously set with [[scopeName]]. <sqf inline>""</sqf> will exit the current scope (see also [[exitWith]])


}}
|r2= [[Anything]] - will return '''value'''


<h3 style="display:none">Notes</h3>
|x1= <sqf>
<dl class="command_description">
scopeName "main";
<!-- Note Section BEGIN -->
while { true } do {
<dd class="notedate">Posted on 19 Aug, 2008
scopeName "loop1";
<dt class="note">'''[[User:Alef|alef]]'''<dd class="note">
while {true} do {
When "name" is "" or nil, the command is ignored.<br>
scopeName "loop2";
When "name" is an undefined scope, the script quit.
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;
};
</sqf>


<!-- Note Section END -->
|x2= <sqf>
</dl>
call {
scopeName "main";
call {
123 breakOut "main"
};
345
}; // call returns 123
</sqf>


<h3 style="display:none">Bottom Section</h3>
|x3= <sqf>
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
};
};
</sqf>


[[Category:Scripting Commands|BREAKOUT]]
|seealso= [[scopeName]] [[breakTo]] [[exitWith]]
[[Category:Scripting Commands ArmA|BREAKOUT]]
}}
[[Category:Scripting Commands ArmA2|BREAKOUT]]
[[Category:Command_Group:_Variables|{{uc:{{PAGENAME}}}}]]
[[Category:Command_Group:_Program_Flow|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]

Latest revision as of 19:42, 3 September 2024

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=369282"