breakWith: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " *\| *([Cc]omments|COMMENTS|Game|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments \("local" or "global"\)|Multiplayer Effects \("local" or "global"\)|Multiplayer Execution \("serv...)
m (Text replacement - "(\|[pr][0-9]+ *= *[^- ]*) *- *V([a-z ])" to "$1 - v$2")
 
(7 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Command
{{RV|type=command


|arma3dev
|game1= arma3
 
|version1= 2.02
|2.01


|gr1= Program Flow
|gr1= Program Flow


| Skips all loop iterations and returns given value.
|descr= Skips all loop iterations and immediately returns the given value.


| [[breakWith]] return
|s1= [[breakWith]] return


|p1= return: [[Anything]] - Value to be returned when iterations are skipped
|p1= return: [[Anything]] - value to be returned when iterations are skipped


| [[Anything]]
|r1= [[Anything]]


|x1= <code></code>
|x1= <sqf>
// stops once _i reaches 5 and outputs 0, 1, 2, 3, 4, END
systemChat call {
for "_i" from 0 to 10 do {
if (_i == 5) then { breakWith "END"; };
systemChat str _i;
};
};
</sqf>


| [[continueWith]] [[break]] [[continue]] [[breakOut]]
|seealso= [[continueWith]] [[break]] [[continue]] [[breakOut]]
}}
}}

Latest revision as of 16:53, 8 November 2023

Hover & click on the images for description

Description

Description:
Skips all loop iterations and immediately returns the given value.
Groups:
Program Flow

Syntax

Syntax:
breakWith return
Parameters:
return: Anything - value to be returned when iterations are skipped
Return Value:
Anything

Examples

Example 1:
// stops once _i reaches 5 and outputs 0, 1, 2, 3, 4, END systemChat call { for "_i" from 0 to 10 do { if (_i == 5) then { breakWith "END"; }; systemChat str _i; }; };

Additional Information

See also:
continueWith break continue breakOut

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