select: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "<!-- Note Section [A-Z]+ --> " to "")
m (minor style fix)
 
(60 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{RV|type=command
{{RV|type=command


| ofp
|game1= ofp
|version1= 1.00


|1.00
|game2= ofpe
|version2= 1.00
 
|game3= arma1
|version3= 1.00
 
|game4= arma2
|version4= 1.00
 
|game5= arma2oa
|version5= 1.50
 
|game6= tkoh
|version6= 1.00
 
|game7= arma3
|version7= 0.50


|gr1= Arrays
|gr1= Arrays
Line 11: Line 28:
|gr3= Config
|gr3= Config


| Selects an element from an array, config entry from [[Config]] or substring from a string or a range from an array.  
|descr= Selects an element from an array, config entry from [[Config]] or substring from a string or a range from an array.  
{{Feature | Informative | Substring version of `select` operates with ANSI charset, if Unicode support is desired, see [[forceUnicode]] }}
 
|s1= array [[select]] index
 
|p1= array: [[Array]]
 
|p2= index: [[Number]] - index 0 denotes the first element, 1 the second, etc. If index has decimal places it gets rounded down for fractions less than or equal .5, otherwise it gets rounded up.<br>
{{GVI|arma3|2.12|size= 0.75}} negative index can be used to select from the end of the array, i.e. -1 means last array element.
 
|r1= [[Anything]] - a <u>reference</u> to the array element given by its index
{{Feature|important|When the index equals the size of the array, there is no error for out of range selection and [[nil]] is returned - see {{Link|#Example 8}}.}}
 
|s2= array [[select]] boolean
 
|p21= array: [[Array]]
 
|p22= boolean: [[Boolean]] - [[false]] selects the '''first''' element of the [[Array]], [[true]] the '''second''' one
 
|r2= [[Anything]] - a <u>reference</u> to the array element
 
|s3= config [[select]] index
 
|s3since= arma1 1.00
 
|p41= config: [[Config]]


| array  '''select''' index
|p42= index: [[Number]] - index 0 denotes the first element, 1 the second, etc. If index has decimal places it gets rounded down for fractions less than or equal .5, otherwise it gets rounded up


| p1= array: [[Array]]
|r3= [[Config]]


| p2= index: [[Number]] - Index 0 denotes the first element, 1 the second, etc. If index has decimal places it gets rounded down for fractions less than or equal .5, otherwise it gets rounded up.
|s4= string [[select]] [start, length]


| [[Anything]] - a <u>reference</u> to array element given by its index
|s4since= arma3 1.28


| s2= array  '''select''' boolean
|p61= string: [[String]]


| p21= array: [[Array]]
|p62= start: [[Number]] - string position to start selection from. 0 denotes the first character of the string, 1 the second, etc. If passed number has decimal places it gets rounded down for fractions less than or equal .5, otherwise it gets rounded up


| p22= boolean: [[Boolean]] - [[true]] => 1, [[false]] => 0
|p63= length: [[Number]] - (Optional, default ''string''<nowiki/>'s length) number of characters to select


| r2= [[Anything]] - a <u>reference</u> to array element given by its index (false - 0, true - 1)
|r4= [[String]]
{{Feature|informative|Substring version of [[select]] operates with the ANSI charset; if Unicode support is desired, see [[forceUnicode]].}}


| s3= config  '''select''' index
|s5= array [[select]] [start, count]


| p41= config: [[Config]]
|s5since= arma3 1.32


| p42= index: [[Number]] - Index 0 denotes the first element, 1 the second, etc. If index has decimal places it gets rounded down for fractions less than or equal .5, otherwise it gets rounded up.
|p81= array: [[Array]]


| r3= [[Config]]
|p82= start: [[Number]] - array index to start selection from


| s4= string '''select''' [start, length] {{Since|arma3|1.27.126674|y}}
|p83= count: [[Number]] - (Optional after {{GVI|arma3|2.14|size= 0.75}}) number of array elements to select. If the selected range exceeds source array boundaries, selection will be made up to the last element of the array.
{{Feature|informative|Since v2.14 'count' is optional, if omitted the selection is made from ''start'' until the end of the array.}}


| p61= string: [[String]]
|r5= [[Array]] - a <u>new array</u> from selection


| p62= [start, length]: [[Array]]
|s6= array [[select]] expression


| p63= start: [[Number]] - String position to start selection from. 0 denotes the first character of the string, 1 the second, etc. If passed number has decimal places it gets rounded down for fractions less than or equal .5, otherwise it gets rounded up.
|s6since= arma3 1.56
| p64= length (optional): [[Number]] - Number of the string characters to select. If "length" is omitted, selection will be made from "start" to the end of the string.


| r4= [[String]]
|p101= array: [[Array]]


| s5= array '''select''' [start, count] {{Since|arma3|1.31.127272|y}}
|p102= expression: [[Code]] - expression that is expected to return [[Boolean]] or [[Nothing]].
If [[true]] is returned, the original array value of currently tested element [[Magic Variables#x|_x]] will be added to the output array


| p81= array: [[Array]]
|r6= [[Array]] - a <u>new array</u> of all elements from the original array that satisfied expression condition


| p82= [start, count]: [[Array]]
|x1= <sqf>
["a", "b", "c", "d"] select 2; // result is "c"
position player select 2; // result is Z coordinate of player position
</sqf>


| p83= start: [[Number]] - Array index to start selection from.
|x2= <sqf>["", currentWeapon player] select alive player; // if player is dead, "" is selected</sqf>
| p84= count: [[Number]] - Number of array elements to select. If the selected range exceeds source array boundaries, selection will be made up to the last element of the array.


| r5= [[Array]] - a <u>new array</u> from selection
|x3= <sqf>(configFile >> "cfgVehicles" >> typeOf vehicle player >> "Turrets") select 0 >> "gunnerAction";</sqf>


| s6= array '''select''' expression {{Since|arma3|1.55.133771|y}}
|x4= <sqf>
hint str ("japa is the man!" select [8]); // the man!
hint str ("japa is the man!" select [0, 7]); // japa is
</sqf>


| p101= array: [[Array]]
|x5= <sqf>hint str ([1,2,3,4,5,6] select [1, 4]); // [2,3,4,5]</sqf>


| p102= expression: [[Code]] - expression that is expected to return [[Boolean]] or [[Nothing]]. If [[true]] is returned, the original array value of currently tested element [[Magic Variables#x|_x]] will be added to the output array
|x6= <sqf>_even = [1,2,3,4,5,6,7,8,9,0] select { _x % 2 == 0 }; // returns [2, 4, 6, 8, 0]</sqf>
 
|x7= JavaScript endsWith() alternative:
<sqf>
private _fnc_endsWith =
{
params ["_string", "_endswith"];
_string select [count _string - count _endswith] isEqualTo _endswith
};


| r6= [[Array]] - a <u>new array</u> of all elements from the original array that satisfied expression condition
["Arma 3", "3"] call _fnc_endsWith; // true
 
["Arma 3", "4"] call _fnc_endsWith; // false
 
</sqf>
|x1= <code>["a", "b", "c", "d"] [[select]] 2; {{cc|result is "c"}}
[[position]] [[player]] [[select]] 2; {{cc|result is Z coordinate of player position}}</code>


|x2= <code>["", [[currentWeapon]] [[player]]] [[select]] [[alive]] [[player]]; {{cc|if player is dead, "" is selected}}</code>
<!-- referenced in r1 -->
|x8= [[select]] index traps:
<sqf>
private _array = ["a", "b", "c", "d"];
_array select 0; // "a"
_array select 3; // "d"
_array select 4; // nil - no error shown
_array select 5; // error


|x3= <code>([[configFile]] >> "cfgVehicles" >> [[typeOf]] [[vehicle]] [[player]] >> "Turrets") [[select]] 0 >> "gunnerAction";</code>
// can sometimes be useful
private _firstEnemyNearMe = allUnits opfor select { player distance _x < 10 } select 0; // nil if no enemies nearby
if (isNil _firstEnemyNearMe) exitWith { systemChat "no enemy found" };
systemChat format ["enemy found: %1", name _firstEnemyNearMe];


|x4= <code>[[hint]] [[str]] ("japa is the man!" [[select]] [8]); {{cc|the man!}}
// get the last element properly
[[hint]] [[str]] ("japa is the man!" [[select]] [0,7]); {{cc|japa is}}</code>
_array select (count _array); // wrong - nil is returned
_array select (count _array - 1); // correct - "d" is returned
</sqf>


|x5= <code>[[hint]] [[str]] ([1,2,3,4,5,6] [[select]] [1,4]); {{cc|[2,3,4,5]}}</code>
|x9= {{Feature|arma3|Since {{GVI|arma3|2.12}} {{hl|-1}} can be used to select the last element of an array.}}
<sqf>private _array = [1, 2, 3, 4, 5];
hint str (_array select -1); // 5</sqf>


|x6= <code>_even = [1,2,3,4,5,6,7,8,9,0] [[select]] { _x % 2 == 0 }; {{cc|returns [2, 4, 6, 8, 0]}}</code>
|seealso= [[a hash b|#]] [[selectRandom]] [[selectRandomWeighted]] [[set]] [[resize]] [[reverse]] [[in]] [[find]] [[findIf]] [[toArray]] [[toString]] [[forEach]] [[count]] [[deleteAt]] [[deleteRange]] [[append]] [[sort]] [[param]] [[params]] [[splitString]] [[joinString]] [[pushBack]] [[pushBackUnique]] [[apply]] [[forceUnicode]]
}}


|seealso= [[a hash b]], [[selectRandom]], [[selectRandomWeighted]], [[set]], [[resize]], [[reverse]], [[in]], [[find]], [[findIf]], [[toArray]], [[toString]], [[forEach]], [[count]], [[deleteAt]], [[deleteRange]], [[append]], [[sort]], [[param]], [[params]], [[splitString]], [[joinString]], [[pushBack]], [[pushBackUnique]], [[apply]], [[forceUnicode]]
{{Note
|user= General Barron
|timestamp= 20090303020200
|text= When combined with the [[count]] command, this can be used to read all entries out of a config; even when you don't know exactly how many entries there will be.
See the notes under [[count]] for more info.
}}
}}


<dl class="command_description">
{{Note
<dd class="notedate">Posted on 3 March 2009</dd>
|user= Killzone_Kid
<dt class="note">[[User:General Barron|General Barron]]</dt>
|timestamp= 20130928005300
<dd class="note">
|text= Rounding of fractions with [[select]] is not the same as when you use [[round]] command:
When combined with the [[count]] command, this can be used to read all entries out of a config; even when you don't know exactly how many entries there will be. See the notes under [[count]] for more info.
<sqf>
</dd>
_roundThis = 0.5;
<dt><dt>
hint str ([0,1] select _roundThis); // 0
<dd class="notedate">Posted on 27 Sep, 2013</dd>
hint str ([0,1] select round _roundThis); // 1
<dt class="note">[[User:Killzone_Kid|Killzone_Kid]]</dt>
</sqf>
<dd class="note">Rounding of fractions with [[select]] is not the same as when you use [[round]] command:
}}
<code>_roundThis = 0.5;
[[hint]] [[str]] ([0,1] [[select]] _roundThis); {{cc|0}}
[[hint]] [[str]] ([0,1] [[select]] [[round]] _roundThis); {{cc|1}}</code>
</dd>
<dt><dt>
<dd class="notedate">Posted on 14 juil, 2016</dd>
<dt class="note">[[User:Pierre MGI|Pierre MGI]]<dd class="note">You can substract array from array using select:
<code>_array = [[1],[2],[3]]; _sub = [2];
_array - _sub //  [[1],[2],[3];
_array [[select]] {!(_x [[isEqualTo]] _sub)} // [[1],[3]];
[[1],[2],[2],[2],[2],[3]] [[select]] {!(_x [[isEqualTo]] _sub)} // [[1],[3]];
</code>
</dd>
</dl>


{{GameCategory|arma1|Scripting Commands}}
{{Note
{{GameCategory|arma2|Scripting Commands}}
|user= Pierre MGI
{{GameCategory|arma3|Scripting Commands}}
|timestamp= 20160714041800
{{GameCategory|tkoh|Scripting Commands}}
|text= You can substract array from array using select:
<sqf>
_array = [[1], [2], [3]];
_sub = [2];
_array - _sub; // [[1], [2], [3]]
_array select { !(_x isEqualTo _sub) }; // [[1], [3]]
[[1],[2],[2],[2],[2],[3]] select { !(_x isEqualTo _sub) }; // [[1], [3]]
</sqf>
}}


<!-- CONTINUE Notes -->
{{Note
<dl class="command_description">
|user= Commy2
<dt></dt>
|timestamp= 20161112223600
<dd class="notedate">Posted on June 22, 2015 - 23:23 (UTC)</dd>
|text= It is not safe to escape the code block of alternative syntax #5 with [[exitWith]], [[breakOut]] etc:
<dt class="note">[[User:Killzone Kid|Killzone Kid]]</dt>
<sqf>
<dd class="note">
x3 = [1,2,3,4,5] select {
Usually when select tries to pick up element out of range, Arma throws "division by zero" error. However there are exceptions. Basically as long as index of element you are selecting is less then or equal to array size, you will get no error.
if (_x == 3) exitWith
<code>[] [[select]] 0; //ok, result is nil
{
[1,2,3] [[select]] 3; //ok, result is nil
false;
[1,2,3] [[select]] 4; //division by zero</code>
};
</dd>
true
<dt><dt>
<dd class="notedate">Posted on November 12, 2016 - 22:36 (UTC)</dd>
<dt class="note">[[User:Commy2|Commy2]]</dt>
<dd class="note">
It is not safe to escape the code block of alternative syntax #5 with exitWith, breakOut etc.<br>
<code>x3 = [1,2,3,4,5] select {  
    if (_x == 3) exitWith {  
        false;  
    };  
    true  
};
};
// could be expected to be: x3 = [1,2,4,5]
// could be expected to be: x3 = [1,2,4,5]
// actual result: x3 = false
// actual result: x3 = false
</code>
</sqf>
</dd>
}}
<dt><dt>
 
<dd class="notedate">Posted on February 14, 2017 - 16:26 (UTC)</dd>
{{Note
<dt class="note">[[User:Igneous01|Igneous01]]</dt>
|user= Igneous01
<dd class="note">
|timestamp= 20170214162600
Syntax #5 is the equivalent of passing in a predicate that returns a boolean. In SQF, a piece of code will always return what the last executed command returned.
|text= {{Link|#Syntax 5}} is the equivalent of passing in a predicate that returns a boolean. In SQF, a piece of code will always return what the last executed command returned.
<code>myAliveUnits = allunits select {alive _x;}; // alive returns a boolean, the last statement run was alive _x, therefore this piece of code will return a true/false to the select command
<sqf>
myEastGroups = allgroups select {side _x == EAST;}; // returns all groups that are side EAST
myAliveUnits = allUnits select { alive _x }; // alive returns a boolean, the last statement run was alive _x,
my4ManGroups = allgroups select { count (units _x) == 4;}; // returns all groups that have 4 men in them
// therefore this piece of code will return a true/false to the select command
UnitsThatDetectedMe = allunits select {_x knowsAbout player > 0.1;}; // returns a list of units that have detected the player
myEastGroups = allGroups select { side _x == east }; // returns all east groups
</code>
my4ManGroups = allGroups select { count units _x == 4 }; // returns all groups that have 4 men in them
</dd>
unitsThatDetectedMe = allUnits select { _x knowsAbout player > 0.1 }; // returns a list of units that have detected the player
<dt><dt>
</sqf>
<dd class="notedate">Posted on May 28, 2017 - 13:51 (UTC)</dd>
}}
<dt class="note">[[User:IT07|IT07]]</dt>
<dd class="note">
Very simple example of how to report about the status of the player:
<code>[ "Player is dead.", "Player is alive" ] select ( alive player )</code>
returns "Player is alive" because ( alive player ) returned true. If ( alive player ) returned false, the first element (0)
would have been returned.
That is a great way of reporting about something without having to write a complicated it then else statement.
</dd>
<dt><dt>
<dd class="notedate">Posted on April 14, 2018 - 13:06 (UTC)</dd>
<dt class="note">[[User:bloodwyn1756|bloodwyn1756]]</dt>
<dd class="note">
Since 1.82 "#" symbol can be used to select from an array. It's shorter to write and has higher priority than math functions.
</dd>
</dl>
<!-- DISCONTINUE Notes -->

Latest revision as of 17:01, 4 October 2024

Hover & click on the images for description

Description

Description:
Selects an element from an array, config entry from Config or substring from a string or a range from an array.
Groups:
ArraysStringsConfig

Syntax 1

Syntax:
array select index
Parameters:
array: Array
index: Number - index 0 denotes the first element, 1 the second, etc. If index has decimal places it gets rounded down for fractions less than or equal .5, otherwise it gets rounded up.
Arma 3 logo black.png2.12 negative index can be used to select from the end of the array, i.e. -1 means last array element.
Return Value:
Anything - a reference to the array element given by its index
When the index equals the size of the array, there is no error for out of range selection and nil is returned - see Example 8.

Syntax 2

Syntax:
array select boolean
Parameters:
array: Array
boolean: Boolean - false selects the first element of the Array, true the second one
Return Value:
Anything - a reference to the array element

Syntax 3

Syntax:
config select index
Parameters:
config: Config
index: Number - index 0 denotes the first element, 1 the second, etc. If index has decimal places it gets rounded down for fractions less than or equal .5, otherwise it gets rounded up
Return Value:
Config

Syntax 4

Syntax:
string select [start, length]
Parameters:
string: String
start: Number - string position to start selection from. 0 denotes the first character of the string, 1 the second, etc. If passed number has decimal places it gets rounded down for fractions less than or equal .5, otherwise it gets rounded up
length: Number - (Optional, default string's length) number of characters to select
Return Value:
String
Substring version of select operates with the ANSI charset; if Unicode support is desired, see forceUnicode.

Syntax 5

Syntax:
array select [start, count]
Parameters:
array: Array
start: Number - array index to start selection from
count: Number - (Optional after Arma 3 logo black.png2.14) number of array elements to select. If the selected range exceeds source array boundaries, selection will be made up to the last element of the array.
Since v2.14 'count' is optional, if omitted the selection is made from start until the end of the array.
Return Value:
Array - a new array from selection

Syntax 6

Syntax:
array select expression
Parameters:
array: Array
expression: Code - expression that is expected to return Boolean or Nothing. If true is returned, the original array value of currently tested element _x will be added to the output array
Return Value:
Array - a new array of all elements from the original array that satisfied expression condition

Examples

Example 1:
["a", "b", "c", "d"] select 2; // result is "c" position player select 2; // result is Z coordinate of player position
Example 2:
["", currentWeapon player] select alive player; // if player is dead, "" is selected
Example 3:
(configFile >> "cfgVehicles" >> typeOf vehicle player >> "Turrets") select 0 >> "gunnerAction";
Example 4:
hint str ("japa is the man!" select [8]); // the man! hint str ("japa is the man!" select [0, 7]); // japa is
Example 5:
hint str ([1,2,3,4,5,6] select [1, 4]); // [2,3,4,5]
Example 6:
_even = [1,2,3,4,5,6,7,8,9,0] select { _x % 2 == 0 }; // returns [2, 4, 6, 8, 0]
Example 7:
JavaScript endsWith() alternative:
private _fnc_endsWith = { params ["_string", "_endswith"]; _string select [count _string - count _endswith] isEqualTo _endswith }; ["Arma 3", "3"] call _fnc_endsWith; // true ["Arma 3", "4"] call _fnc_endsWith; // false
Example 8:
select index traps:
private _array = ["a", "b", "c", "d"]; _array select 0; // "a" _array select 3; // "d" _array select 4; // nil - no error shown _array select 5; // error // can sometimes be useful private _firstEnemyNearMe = allUnits opfor select { player distance _x < 10 } select 0; // nil if no enemies nearby if (isNil _firstEnemyNearMe) exitWith { systemChat "no enemy found" }; systemChat format ["enemy found: %1", name _firstEnemyNearMe]; // get the last element properly _array select (count _array); // wrong - nil is returned _array select (count _array - 1); // correct - "d" is returned
Example 9:
Arma 3
Since Arma 3 logo black.png2.12 -1 can be used to select the last element of an array.
private _array = [1, 2, 3, 4, 5]; hint str (_array select -1); // 5

Additional Information

See also:
# selectRandom selectRandomWeighted set resize reverse in find findIf toArray toString forEach count deleteAt deleteRange append sort param params splitString joinString pushBack pushBackUnique apply forceUnicode

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
General Barron - c
Posted on Mar 03, 2009 - 02:02 (UTC)
When combined with the count command, this can be used to read all entries out of a config; even when you don't know exactly how many entries there will be. See the notes under count for more info.
Killzone_Kid - c
Posted on Sep 28, 2013 - 00:53 (UTC)
Rounding of fractions with select is not the same as when you use round command:
_roundThis = 0.5; hint str ([0,1] select _roundThis); // 0 hint str ([0,1] select round _roundThis); // 1
Pierre MGI - c
Posted on Jul 14, 2016 - 04:18 (UTC)
You can substract array from array using select:
_array = [[1], [2], [3]]; _sub = [2]; _array - _sub; // [[1], [2], [3]] _array select { !(_x isEqualTo _sub) }; // [[1], [3]] [[1],[2],[2],[2],[2],[3]] select { !(_x isEqualTo _sub) }; // [[1], [3]]
Commy2 - c
Posted on Nov 12, 2016 - 22:36 (UTC)
It is not safe to escape the code block of alternative syntax #5 with exitWith, breakOut etc:
x3 = [1,2,3,4,5] select { if (_x == 3) exitWith { false; }; true }; // could be expected to be: x3 = [1,2,4,5] // actual result: x3 = false
Igneous01 - c
Posted on Feb 14, 2017 - 16:26 (UTC)
Syntax 5 is the equivalent of passing in a predicate that returns a boolean. In SQF, a piece of code will always return what the last executed command returned.
myAliveUnits = allUnits select { alive _x }; // alive returns a boolean, the last statement run was alive _x, // therefore this piece of code will return a true/false to the select command myEastGroups = allGroups select { side _x == east }; // returns all east groups my4ManGroups = allGroups select { count units _x == 4 }; // returns all groups that have 4 men in them unitsThatDetectedMe = allUnits select { _x knowsAbout player > 0.1 }; // returns a list of units that have detected the player