switch: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "|= Game version" to "|Game version=")
m (Text replacement - "{{Feature|Informative|" to "{{Feature|informative|")
 
(32 intermediate revisions by 3 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


| Creates a switch type that can be used inside a [[switch do]] -block |DESCRIPTION=
|game3= arma2oa
____________________________________________________________________________________________
|version3= 1.50


| [[switch]] arg|SYNTAX=
|game4= tkoh
|version4= 1.00


|p1= arg: [[Anything]] |PARAMETER1=
|game5= tkoh
|version5= 1.00


| [[Switch Type]] |RETURNVALUE=
|game6= arma3
____________________________________________________________________________________________
|version6= 0.50


|x1= <code>_mySwitch = [[switch]] "Test";
|gr1= Program Flow
_mySwitch [[do]] {/*Something*/};</code> |EXAMPLE1=


|x2= <code>[[switch]] (_a) [[do]] { [[case]] 1 : { /*...code...*/ }; [[case]] 2 : { /*...code...*/ }; [[default]] { /*...code...*/ }; };</code>
|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>
<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>
<code>[[switch]] (_condition) [[do]] {
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.
    [[case]] 1: { [[hint]] "1" };
    [[case]] 2: { [[hint]] "2" };
    [[default]] { [[hint]] "default" };
};</code>
<br>
<code>[[switch]] (_condition) [[do]] {
    [[case]] "string1";
    [[case]] "string2": { [[hint]] "string1 or string2" };
    [[case]] "string3";
    [[case]] "string4": { [[hint]] "string3 or string4" };
    [[default]] { [[hint]] "default" };
};</code> |EXAMPLE2=


| [[Control Structures]] [[switch do]] [[a:b]] [[case]] [[default]] |SEEALSO=
{{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
 
|p1= value: [[Anything]]
 
|r1= [[Switch Type]]
 
|x1= <sqf>
switch (floor random 5) do
{
case 1: { hint "one"; };
case 2: { hint "two"; };
default { hint "zero, three or four" };
};
</sqf>
 
|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>
 
|x3= <sqf>
private _color = switch (side player) do
{
case west: { "ColorGreen" };
case east: { "ColorRed" };
};
</sqf>
 
|x4= <sqf>
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;
};
</sqf>
 
|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]]
}}
 
{{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
|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>
}}
}}


<h3 style="display:none">Notes</h3>
{{Note
<dl class="command_description">
|user= Freddo3000
|timestamp= 20201101100500
|text= You are able to call code within the switch statements, such as:


<!-- Note Section BEGIN -->
<sqf>
private _myFunc = {
systemChat "0";
case 1: { systemChat "1" };
systemChat "2";
};


<!-- Note Section END -->
private _myParameter = 1;
</dl>


[[Category:Scripting Commands|SWITCH]]
switch (_myParameter) do
[[Category:Scripting Commands ArmA|SWITCH]]
{
[[Category:ArmA: Control Structures|{{uc:{{PAGENAME}}}}]]
_myParameter call _myFunc;
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
case 1: { systemChat "4" };
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
systemChat "3";
[[Category:Command Group: Program Flow|{{uc:{{PAGENAME}}}}]]
default { systemChat "-1"; };
};
</sqf>


<!-- CONTINUE Notes -->
However the order in which it is executed is difficult to make sense of, see the code comment.


<!-- DISCONTINUE Notes -->
This is used by [[BIS_fnc_missionConversations]] and [[BIS_fnc_missionTasks]]
}}

Latest revision as of 00: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