breakTo: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "</dd> </dl>" to "</dd> </dl>")
m (better clarification.)
(28 intermediate revisions by one other user not shown)
Line 1: Line 1:
{{RV|type=command
{{RV|type=command


| arma1
|game1= arma1
|version1= 1.00
 
|game2= arma2
|version2= 1.00
 
|game3= arma2oa
|version3= 1.50
 
|game4= tkoh
|version4= 1.00
 
|game5= arma3
|version5= 0.50


|gr1= Program Flow
|gr1= Program Flow


|1.00
|descr= Breaks block to scope named ''name''. Nil is returned.
 
| Breaks block to scope named '''name'''. Nil is returned.


Scope name can be assigned using [[scopeName]] command.
Scope name can be assigned using [[scopeName]] command.


|s1= '''breakTo''' name
|s1= [[breakTo]] name


|p1= name: [[String]]
|p1= name: [[String]]
Line 17: Line 28:
|r1= [[Nothing]]
|r1= [[Nothing]]


|x1= <code>[[scopeName]] "main";
|x1= <sqf>scopeName "main";
while {[[true]]} do {
while { true } do
[[scopeName]] "loop1";
{
while {[[true]]} do {
scopeName "loop1";
[[scopeName]] "loop2";
while { true } do
if (condition1) then {[[breakTo]] "main"}; // Breaks all scopes and return to "main"
{
if (condition2) then {[[breakOut]] "loop2"}; // Breaks scope named "loop2"
scopeName "loop2";
[[sleep]] 1;
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>


|seealso= [[scopeName]], [[breakOut]], [[exitWith]]
|seealso= [[scopeName]] [[breakOut]] [[exitWith]]
}}
}}
{{GameCategory|arma2|Scripting Commands}}
{{GameCategory|arma2|Scripting Commands}}
{{GameCategory|arma3|Scripting Commands}}
{{GameCategory|tkoh|Scripting Commands}}


<dl class="command_description">
<dl class="command_description">


<dt></dt>
<dt></dt>
<dd class="notedate">Posted on May 18, 2017 - 18:19 (UTC)</dd>
<dd class="notedate">Posted on 2017-05-18 - 18:19 (UTC)</dd>
<dt class="note">[[User:IT07|IT07]]</dt>
<dt class="note">[[User:Nelis.75733126|Nelis.75733126]]</dt>
<dd class="note">
<dd class="note">
This command can not be used to re-execute scopes in which command is inside of. Example:
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>
<code>scopeName "whatever";
Example:
if true then {
<sqf>scopeName "something";
  breakTo "whatever"
if true then
{
breakTo "something";
    _v = 0; // this line will be skipped
};
};
</code>
_a = 0; // this is where script execution will jump to.</sqf>
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>
</dd>


</dl>
</dl>

Revision as of 20:57, 16 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. Nil is returned. Scope name can be assigned using 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
Posted on 2017-05-18 - 18:19 (UTC)
Nelis.75733126
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=363719"