breakOut: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "<code>([^<]*)\[\[([a-zA-Z][a-zA-Z0-9_]+)\]\]([^<]*) *<\/code>" to "<code>$1$2$3</code>")
m (Text replacement - "(\|[pr][0-9]+ *= *[^- ]*) *- *W([a-z ])" to "$1 - w$2")
 
(15 intermediate revisions by the same user not shown)
Line 19: Line 19:


|descr= Breaks out of the [[Variables#Scopes|scope]] with given '''name'''.
|descr= Breaks out of the [[Variables#Scopes|scope]] with given '''name'''.
* An unknown [[scopeName]] name will cause the script error {{ic|Generic error in expression}}
* 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 '''Example 3'''.
* If multiple scopes with the same '''name''' exist, the command will break out the nearest scope. See {{Link|#Example 3}}.


|s1= [[breakOut]]  name
|s1= [[breakOut]]  name


|p1= name: [[String]] - Name of the scope which was previously set with [[scopeName]]. {{ic|""}} will exit the current scope.
|p1= name: [[String]] - name of the scope which was previously set with [[scopeName]]. <sqf inline>""</sqf> will exit the current scope (see also [[exitWith]])


|r1= [[Nothing]]
|r1= [[Nothing]]
Line 32: Line 32:
|s2since= arma3 1.48
|s2since= arma3 1.48


|p21= value: [[Anything]] - A value to return
|p21= value: [[Anything]] - a value to return


|p22= name: [[String]] - Name of the scope which was previously set with [[scopeName]]. {{ic|""}} will exit the current scope.
|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'''
|r2= [[Anything]] - will return '''value'''


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


|x2= <code>call {
|x2= <sqf>call {
scopeName "main";
scopeName "main";
call {
call {
Line 56: Line 56:
};
};
345
345
}; // call returns 123</code>
}; // call returns 123</sqf>


|x3= <code>call {
|x3= <sqf>call {
scopeName "Main"; // Parent Main
scopeName "Main"; // Parent Main
call {
call {
Line 64: Line 64:
"String" breakOut "Main"; // Will break out of child main and return "String" to parent main
"String" breakOut "Main"; // Will break out of child main and return "String" to parent main
};
};
};</code>
};</sqf>


|seealso= [[scopeName]] [[breakTo]] [[exitWith]]
|seealso= [[scopeName]] [[breakTo]] [[exitWith]]
}}
}}

Latest revision as of 17:35, 8 November 2023

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