switch: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\{\{( *)Important( *)\|" to "{{$1Feature$2|$2important$2|")
m (Text replacement - "{{Feature|Informative|" to "{{Feature|informative|")
 
(14 intermediate revisions by the same 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= tkoh
|version5= 1.00
 
|game6= arma3
|version6= 0.50


|gr1= Program Flow
|gr1= Program Flow


|1.00
|descr= Checks if the given parameter matches any [[case]]. If so, the code block of that case will be executed. After that the switch ends so no further cases will be checked.<br>
If a case has no code block the code of the next case will automatically be executed, making it possible to formulate a logical "or" for cases which would otherwise contain the exact same code (see {{Link|#Example 2}}).<br>
The [[default]] block will be executed '''only''' if no case matches, no matter its position inside the code block. It is not a [[case]], and will '''never''' be entered by fallthrough.
 
{{Feature|informative|
* [[String]] comparison is case-sensitive. Use [[toUpper]], [[toLower]], [[toLowerANSI]] or [[toUpperANSI]] to force all [[String|strings]] to the same case.
* if no [[default]] block is provided and no [[case]] is matched, the switch block returns the default value [[true]], otherwise it returns what the valid case block returns.
}}
 
|s1= [[switch]] value


| Creates a switch type that can be used inside a [[switch do|switch-do]] block.
|p1= value: [[Anything]]
<br><br>
{{Feature | important | When it comes to strings, switch case matching is <b>case-sensitive</b>}}


| [[switch]] condition
|r1= [[Switch Type]]


|p1= condition: [[Anything]]
|x1= <sqf>
switch (floor random 5) do
{
case 1: { hint "one"; };
case 2: { hint "two"; };
default { hint "zero, three or four" };
};
</sqf>


| [[Switch Type]]
|x2= <!-- this example is referenced in Description -->
<sqf>
switch (_condition) do
{
case "string1";
case "string2": { hint "string1 or string2" };
case "string3";
case "string4": { hint "string3 or string4" };
case "string5"; // will never enter default's code
default { hint "default" };
};
</sqf>


|x1= <code>[[private]] _mySwitch = [[switch]] "Test";
|x3= <sqf>
_mySwitch [[do]] { {{codecomment|/* Something */}} };</code>
private _color = switch (side player) do
{
case west: { "ColorGreen" };
case east: { "ColorRed" };
};
</sqf>


|x2= <code>[[switch]] (_condition) [[do]] {
|x4= <sqf>
    [[case]] 1: { [[hint]] "1" };
private _fn_moveForward = { /*...code...*/ };
    [[case]] 2: { [[hint]] "2" };
private _fn_moveBackward = { /*...code...*/ };
    [[default]] { [[hint]] "default" };
private _fn_invalidKey = { /*...code...*/ };
};</code>


|x3=
switch true do
<code>[[switch]] (_condition) [[do]] {
{
    [[case]] "string1";
case (_dikCode in actionKeys "MoveForward"): _fn_moveForward;
    [[case]] "string2": { [[hint]] "string1 or string2" };
case (_dikCode in actionKeys "MoveBackward"): _fn_moveBackward;
    [[case]] "string3";
default _fn_invalidKey;
    [[case]] "string4": { [[hint]] "string3 or string4" };
};
    [[default]] { [[hint]] "default" };
</sqf>
};</code>


| [[Control Structures]] [[switch do]] [[a:b]] [[case]] [[default]]
|x5= <sqf>
switch _var do
{
case "0";
default { hint str ["default", _var] };
case "3": { hint str ["3", _var] };
case "1";
case "4";
case "2": { hint str ["2", _var] };
};
 
_var = "0"; // -> ["3", "0"]
_var = "1"; // -> ["2", "1"]
_var = "2"; // -> ["2", "2"]
_var = "3"; // -> ["3", "3"]
_var = "4"; // -> ["2", "4"]
_var = "5"; // -> ["default", "5"]
</sqf>
 
|seealso= [[Control Structures]] [[a:b]] [[case]] [[default]]
}}
}}


<dl class="command_description">
{{Note
|user= ColonelSandersLite
|timestamp= 20070807074900
|text= Be careful of the parentheses around the variable you're switching on.
If you accidentally use braces instead (e.g: <sqf inline>switch { _myVar } do { /*... */ }</sqf>), it won't error, but will always return default.
{{Feature|informative|This is due to <sqf inline>{ _myvar }</sqf> being [[Code]].}}
}}


<!-- Note Section BEGIN -->
{{Note
|user= Iva
|timestamp= 20091006144300
|text= It's possible to use [[Boolean]] value as a switch and [[Code]] as case. One thing to take special care in such case is that code must be in parentheses. Example:
<sqf>
switch (true) do
{
case (_boolVar): { someCode };
case (unit1 distance unit2 > 5): { someCode };
};
</sqf>
}}


<!-- Note Section END -->
{{Note
</dl>
|user= Freddo3000
|timestamp= 20201101100500
|text= You are able to call code within the switch statements, such as:


<sqf>
private _myFunc = {
systemChat "0";
case 1: { systemChat "1" };
systemChat "2";
};


[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
private _myParameter = 1;
{{GameCategory|arma1|Scripting Commands}}


{{GameCategory|arma2|Scripting Commands}}
switch (_myParameter) do
{{GameCategory|arma3|Scripting Commands}}
{
_myParameter call _myFunc;
case 1: { systemChat "4" };
systemChat "3";
default { systemChat "-1"; };
};
</sqf>
 
However the order in which it is executed is difficult to make sense of, see the code comment.
 
This is used by [[BIS_fnc_missionConversations]] and [[BIS_fnc_missionTasks]]
}}

Latest revision as of 01:26, 2 February 2024

Hover & click on the images for description

Description

Description:
Checks if the given parameter matches any case. If so, the code block of that case will be executed. After that the switch ends so no further cases will be checked.
If a case has no code block the code of the next case will automatically be executed, making it possible to formulate a logical "or" for cases which would otherwise contain the exact same code (see Example 2).
The default block will be executed only if no case matches, no matter its position inside the code block. It is not a case, and will never be entered by fallthrough.
Groups:
Program Flow

Syntax

Syntax:
switch value
Parameters:
value: Anything
Return Value:
Switch Type

Examples

Example 1:
switch (floor random 5) do { case 1: { hint "one"; }; case 2: { hint "two"; }; default { hint "zero, three or four" }; };
Example 2:
switch (_condition) do { case "string1"; case "string2": { hint "string1 or string2" }; case "string3"; case "string4": { hint "string3 or string4" }; case "string5"; // will never enter default's code default { hint "default" }; };
Example 3:
private _color = switch (side player) do { case west: { "ColorGreen" }; case east: { "ColorRed" }; };
Example 4:
private _fn_moveForward = { /*...code...*/ }; private _fn_moveBackward = { /*...code...*/ }; private _fn_invalidKey = { /*...code...*/ }; switch true do { case (_dikCode in actionKeys "MoveForward"): _fn_moveForward; case (_dikCode in actionKeys "MoveBackward"): _fn_moveBackward; default _fn_invalidKey; };
Example 5:
switch _var do { case "0"; default { hint str ["default", _var] }; case "3": { hint str ["3", _var] }; case "1"; case "4"; case "2": { hint str ["2", _var] }; }; _var = "0"; // -> ["3", "0"] _var = "1"; // -> ["2", "1"] _var = "2"; // -> ["2", "2"] _var = "3"; // -> ["3", "3"] _var = "4"; // -> ["2", "4"] _var = "5"; // -> ["default", "5"]

Additional Information

See also:
Control Structures a:b case default

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
ColonelSandersLite - c
Posted on Aug 07, 2007 - 07:49 (UTC)
Be careful of the parentheses around the variable you're switching on. If you accidentally use braces instead (e.g: switch { _myVar } do { /*... */ }), it won't error, but will always return default.
This is due to { _myvar } being Code.
Iva - c
Posted on Oct 06, 2009 - 14:43 (UTC)
It's possible to use Boolean value as a switch and Code as case. One thing to take special care in such case is that code must be in parentheses. Example:
switch (true) do { case (_boolVar): { someCode }; case (unit1 distance unit2 > 5): { someCode }; };
Freddo3000 - c
Posted on Nov 01, 2020 - 10:05 (UTC)
You are able to call code within the switch statements, such as:
private _myFunc = { systemChat "0"; case 1: { systemChat "1" }; systemChat "2"; }; private _myParameter = 1; switch (_myParameter) do { _myParameter call _myFunc; case 1: { systemChat "4" }; systemChat "3"; default { systemChat "-1"; }; };
However the order in which it is executed is difficult to make sense of, see the code comment. This is used by BIS_fnc_missionConversations and BIS_fnc_missionTasks