breakTo: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
m (Some wiki formatting)
 
(63 intermediate revisions by 4 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.
|game3= arma2oa
|version3= 1.50


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


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


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


| [[Nothing]] |= Return value
|descr= Breaks block to scope named ''name''.


|x1= <code>[[scopeName]] "main";
Scope name can be assigned using the [[scopeName]] command.
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;
};
</code> |= Example 1
____________________________________________________________________________________________


| [[scopeName]], [[breakOut]], [[exitWith]] |= See also
|s1= [[breakTo]] name


}}
|p1= name: [[String]]


<h3 style="display:none">Notes</h3>
|r1= [[Nothing]]
<dl class="command_description">
<!-- Note Section BEGIN -->


<!-- Note Section END -->
|x1= <sqf>
</dl>
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;
};
</sqf>


<h3 style="display:none">Bottom Section</h3>
|seealso= [[scopeName]] [[breakOut]] [[exitWith]]
}}


[[Category:Scripting Commands|BREAKTO]]
{{Note
[[Category:Scripting Commands ArmA|BREAKTO]]
|user= Nelis.75733126
[[Category:Scripting Commands ArmA2|BREAKTO]]
|timestamp= 20170518181900
[[Category:Command_Group:_Variables|{{uc:{{PAGENAME}}}}]]
|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>
[[Category:Command_Group:_Program_Flow|{{uc:{{PAGENAME}}}}]]
Example:
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
<sqf>
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
scopeName "something";
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
if true then
{
breakTo "something";
_v = 0; // this line will be skipped
};


<!-- CONTINUE Notes -->
_a = 0; // this is where script execution will jump to.
<dl class="command_description">
</sqf>
<dd class="notedate">Posted on May 18, 2017 - 18:19 (UTC)</dd>
}}
<dt class="note">[[User:IT07|IT07]]</dt>
<dd class="note">
This command can not be used to re-execute scopes in which command is inside of. Example:
<code>scopeName "whatever";
if true then {
  breakTo "whatever"
};
</code>
The example above will not make the engine jump back to line 1 and re-execute the 2nd line. Instead, it will just jump across line 2 to line 5 if it [ line 5 ] exists.
</dd>
</dl>
<!-- DISCONTINUE Notes -->

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"