breakTo: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
m (Some wiki formatting)
 
(76 intermediate revisions by 12 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 to scope named 'name'. Nil is returned. |= Description
|game3= arma2oa
____________________________________________________________________________________________
|version3= 1.50


| '''breakTo''' name |= Syntax
|game4= tkoh
|version4= 1.00


|p1= name: [[String]] |= Parameter 1
|game5= arma3
|version5= 0.50


| [[Nothing]] |= Return value
|gr1= Program Flow
____________________________________________________________________________________________


| |= See also
|descr= Breaks block to scope named ''name''.


}}
Scope name can be assigned using the [[scopeName]] command.
 
|s1= [[breakTo]] name
 
|p1= name: [[String]]
 
|r1= [[Nothing]]


<h3 style="display:none">Notes</h3>
|x1= <sqf>
<dl class="command_description">
scopeName "main";
<!-- Note Section BEGIN -->
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;
};
</sqf>


<!-- Note Section END -->
|seealso= [[scopeName]] [[breakOut]] [[exitWith]]
</dl>
}}


<h3 style="display:none">Bottom Section</h3>
{{Note
|user= Nelis.75733126
|timestamp= 20170518181900
|text= I wish to clarify the behaviour of this command by saying that the <sqf inline>breakTo</sqf> command will literally break the scope in which it has been placed, and continue reading whatever is after and outside of that scope.<br>
Example:
<sqf>
scopeName "something";
if true then
{
breakTo "something";
_v = 0; // this line will be skipped
};


[[Category:Scripting Commands|BREAKTO]]
_a = 0; // this is where script execution will jump to.
[[Category:Scripting Commands ArmA|BREAKTO]]
</sqf>
[[Category:Command_Group:_Variables|{{uc:{{PAGENAME}}}}]]
}}
[[Category:Command_Group:_Program_Flow|{{uc:{{PAGENAME}}}}]]

Latest revision as of 22:46, 23 April 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 block to scope named name. Scope name can be assigned using the scopeName command.
Groups:
Program Flow

Syntax

Syntax:
breakTo name
Parameters:
name: String
Return Value:
Nothing

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

Additional Information

See also:
scopeName breakOut 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
Nelis.75733126 - c
Posted on May 18, 2017 - 18:19 (UTC)
I wish to clarify the behaviour of this command by saying that the breakTo command will literally break the scope in which it has been placed, and continue reading whatever is after and outside of that scope.
Example:
scopeName "something"; if true then { breakTo "something"; _v = 0; // this line will be skipped }; _a = 0; // this is where script execution will jump to.
Retrieved from "https://community.bistudio.com/wiki?title=breakTo&oldid=363855"