count: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (added break at syntax, added missing blanks in the examples between count and _array)
m (Text replacement - "<sqf>([^↵][^<]*↵[^<]*)<\/sqf>" to "<sqf> $1 </sqf>")
 
(174 intermediate revisions by 26 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


| ofp |= Game name
|game1= ofp
|version1= 1.00


|1.00|= Game version
|game2= ofpe
|version2= 1.00


|arg= local |= Arguments in MP
|game3= arma1
____________________________________________________________________________________________
|version3= 1.00


| Returns the number of elements in an array |= Description
|game4= arma2
____________________________________________________________________________________________
|version4= 1.00


| '''count''' array<br>condition '''count''' array |= Syntax
|game5= arma2oa
|version5= 1.50


|p1= array: [[Array]] |= Parameter 1
|game6= tkoh
|version6= 1.00


|p2= condition: [[String]] - the condition which should be checked. Inside it "_x" stands for each array item. |= Parameter 2
|game7= arma3
|version7= 0.50


|p3= array: [[Array]] |= Parameter 3
|gr1= Arrays


| [[Integer]] |= Return value
|gr2= Strings
____________________________________________________________________________________________
 
|x1= <pre>_array = [soldier1, soldier2, soldier3]
count _array</pre>


returns 3The second usage of count counts how often a condition applies in an array.
|gr3= Config


<pre>_array = [1,2,2,3,4,4,4,5,6]
|gr4= HashMap
{_x==2} count _array</pre>


returns 2 |= Example 1
|descr= Can be used to count:
____________________________________________________________________________________________
* The number of elements in an array (returns the already internally known array size)
* The number of elements in an array matching the condition
* The number of sub-entries in a config entry
* {{GVI|arma3|1.28|size= 0.75}} The number of characters in an ANSI string {{Feature|informative|If Unicode support is desired, see [[forceUnicode]].}}


| [[forEach]] |= See also
|s1= [[count]] value


|p1= value: [[Array]], [[String]], [[Config]] or [[HashMap]]
|r1= [[Number]]
|s2= condition [[count]] array
|p21= condition: [[Code]] - condition that must return [[true]] for the tested element to be counted. The variable {{hl|[[Magic Variables#x|_x]]}} will contain the currently tested element
{{Feature|arma3|If the provided array contains different data types, use [[isEqualTo]] for item comparison instead of [[==]].}}
|p22= array: [[Array]]
|r2= [[Number]]
|x1= <sqf>
count [0, 0, 1, 2]; // returns 4
count units group player; // returns number of units in player group
</sqf>
|x2= <sqf>
private _cnt = { _x == 4 } count [1, 9, 8, 3, 4, 4, 4, 5, 6]; // returns 3
_cnt = { alive _x } count allUnits; // returns the number of alive units
</sqf>
|x3= <sqf>private _cnt = count (configFile >> "CfgVehicles");</sqf>
|x4= <sqf>hint str count "japa is the man!"; // 16</sqf>
|x5= <sqf>hint format ["There are %1 elements in the provided hashmap", count _myHashMap];</sqf>
|seealso= [[apply]] [[select]] [[in]] [[find]] [[countFriendly]] [[countEnemy]] [[countUnknown]] [[countSide]] [[countType]] [[findIf]] [[forceUnicode]]
}}
}}


<h3 style="display:none">Notes</h3>
{{Note
<dl class="command_description">
|user= Hardrock
<!-- Note Section BEGIN -->
|timestamp= 20060803142700
*Use this to calculate how many "M16" mags a soldier has left. ("_x == {M16}" count [[magazines]] soldier1)
|text= ''Notes from before the conversion:''<br>
Use this to calculate how many "M16" mags a soldier has left.  
<sqf>{ _x == "M16" } count magazines soldier1;</sqf>
Take care when using count to determine how many units are left alive in a group: count units [[group]] [[player]] or count units groupname Will return the number of units the leader of the group thinks are alive. If some units have been killed out of sight of other members of the group then it may take sometime for this to be the actual numbers in the group. To determine exactly how many units are really alive in a group use:
<sqf>{ alive _x } count units group player;</sqf>
or
<sqf>{ alive _x } count units groupname;</sqf>
}}


*Take care when using count to determine how many units are left alive in a group: count units [[group]] [[player]] or count units groupname Will return the number of units the leader of the group thinks are alive. If some units have been killed out of sight of other members of the group then it may take sometime for this to be the actual numbers in the group. To determine exactly how many units are really alive in a group use: {[[alive]] _x} count units [[group]] [[player]] or {[[alive]] _x} count units groupname
{{Note
<!-- Note Section END -->
|user= Heeeere's Johnny!
</dl>
|timestamp= 20141215000100
|text= ''count'' can be (ab)used for a very fast and simple check if at least one element in an array fulfills a certain condition:
<sqf>
if ({ if (/* _x fulfills condition */) exitWith {1}; false } count _array isEqualTo 1) then
{
// do whatever here
};
</sqf>
This code will exit the ''count'' loop as soon as it finds an element fulfilling the condition, leaving the ''count'' with the value of 1, hence make the larger if-condition be ''true''.<br>
If no array element fulfills the condition, the ''count'' will be 0 and the if-condition will be ''false''.
}}


<h3 style="display:none">Bottom Section</h3>
{{Note
|user= Killzone_Kid
|timestamp= 20141229212300
|text= Quit loop at first fulfilled condition (same as above but faster):
<sqf>
{
if (_x == 4) exitWith {
// do something when we reach 4
}
} count [1,2,3,4,5,6];
</sqf>
}}


{{Note
|user= Heeeere's Johnny!
|timestamp= 20150102223200
|text= Using [[exitWith]] inside a '''count''' loop will overwrite the default functionality and make '''count''' return whatever the '''exitWith''' returns:
<sqf>
_result = {
if (_x isEqualTo 3) exitWith { "Hello" }
} count [1,2,3,4,5];
// _result = "Hello"
</sqf>
}}


[[Category:Scripting Commands|COUNT]]
{{Note
[[Category:Scripting Commands OFP 1.96|COUNT]]
|user= Ebay
[[Category:Scripting Commands OFP 1.46|COUNT]]
|timestamp= 20160822194100
[[Category:Scripting Commands ArmA|COUNT]]
|text= With the alternative syntax each iteration should result in an interior return of bool or nothing. Example:
<sqf>
createDialog "RscFunctionsViewer";
{ lbAdd [292901, _x]; } count ["first", "second", "third"];
</sqf>
[[lbAdd]] returns a number, so this throws "Error Type Number, expected Bool". Tested in A2OA 1.63.131129
}}

Latest revision as of 19:43, 3 September 2024

Hover & click on the images for description

Description

Description:
Can be used to count:
  • The number of elements in an array (returns the already internally known array size)
  • The number of elements in an array matching the condition
  • The number of sub-entries in a config entry
  • Arma 3 logo black.png1.28 The number of characters in an ANSI string
    If Unicode support is desired, see forceUnicode.
Groups:
ArraysStringsConfigHashMap

Syntax

Syntax:
count value
Parameters:
value: Array, String, Config or HashMap
Return Value:
Number

Alternative Syntax

Syntax:
condition count array
Parameters:
condition: Code - condition that must return true for the tested element to be counted. The variable _x will contain the currently tested element
Arma 3
If the provided array contains different data types, use isEqualTo for item comparison instead of ==.
array: Array
Return Value:
Number

Examples

Example 1:
count [0, 0, 1, 2]; // returns 4 count units group player; // returns number of units in player group
Example 2:
private _cnt = { _x == 4 } count [1, 9, 8, 3, 4, 4, 4, 5, 6]; // returns 3 _cnt = { alive _x } count allUnits; // returns the number of alive units
Example 3:
private _cnt = count (configFile >> "CfgVehicles");
Example 4:
hint str count "japa is the man!"; // 16
Example 5:
hint format ["There are %1 elements in the provided hashmap", count _myHashMap];

Additional Information

See also:
apply select in find countFriendly countEnemy countUnknown countSide countType findIf 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
Hardrock - c
Posted on Aug 03, 2006 - 14:27 (UTC)
Notes from before the conversion:
Use this to calculate how many "M16" mags a soldier has left.
{ _x == "M16" } count magazines soldier1;
Take care when using count to determine how many units are left alive in a group: count units group player or count units groupname Will return the number of units the leader of the group thinks are alive. If some units have been killed out of sight of other members of the group then it may take sometime for this to be the actual numbers in the group. To determine exactly how many units are really alive in a group use: or
{ alive _x } count units groupname;
Heeeere's Johnny! - c
Posted on Dec 15, 2014 - 00:01 (UTC)
count can be (ab)used for a very fast and simple check if at least one element in an array fulfills a certain condition:
if ({ if (/* _x fulfills condition */) exitWith {1}; false } count _array isEqualTo 1) then { // do whatever here };
This code will exit the count loop as soon as it finds an element fulfilling the condition, leaving the count with the value of 1, hence make the larger if-condition be true.
If no array element fulfills the condition, the count will be 0 and the if-condition will be false.
Killzone_Kid - c
Posted on Dec 29, 2014 - 21:23 (UTC)
Quit loop at first fulfilled condition (same as above but faster):
{ if (_x == 4) exitWith { // do something when we reach 4 } } count [1,2,3,4,5,6];
Heeeere's Johnny! - c
Posted on Jan 02, 2015 - 22:32 (UTC)
Using exitWith inside a count loop will overwrite the default functionality and make count return whatever the exitWith returns:
_result = { if (_x isEqualTo 3) exitWith { "Hello" } } count [1,2,3,4,5]; // _result = "Hello"
Ebay - c
Posted on Aug 22, 2016 - 19:41 (UTC)
With the alternative syntax each iteration should result in an interior return of bool or nothing. Example:
createDialog "RscFunctionsViewer"; { lbAdd [292901, _x]; } count ["first", "second", "third"];
lbAdd returns a number, so this throws "Error Type Number, expected Bool". Tested in A2OA 1.63.131129