playersNumber: Difference between revisions

Latest revision as of 19:30, 16 April 2024

1.80

1.00

1.50

1.00

0.50

Hover & click on the images for description

Description

Description:: Returns count of occupied role selection slots for given side. Players who claimed a slot in the lobby but did not start the mission are counted as well. If disabledAI = 0; in description.ext or Enable AI option is checked in Eden Editor, AI bots will be treated as valid players and will be counted too.
Multiplayer:: Multiplayer only, in singleplayer it always returns 0.
Groups:: Multiplayer

Syntax

Syntax:: playersNumber side
Parameters:: side: Side
Return Value:: Number

Examples

Example 1:: _west = playersNumber west; _east = playersNumber east; _civ = playersNumber civilian; hint format ["West:%1 East:%2, Civ:%3", _west, _east, _civ];

Additional Information

See also:: playableSlotsNumber countSide allPlayers allUnits

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

Nelis.75733126 - c

Posted on Apr 13, 2015 - 09:44 (UTC)

1.05

2024-04-16 edit:
playersNumber returns playable AI as well as human players.
By default, a unit (placed down in the editor for example) ONLY becomes playable when the creator specifically checks the relevant checkbox.

In addition to the examples already given, this is how playersNumber can be used to get an array of players and playable AI on the same side as the side of the player:

playersNumber playerSide;

@@ Line 1: / Line 1: @@
-{{Command|= Comments
+{{RV|type=command
-____________________________________________________________________________________________
-| ofpr |= Game name
+|game1= ofp
+|version1= 1.80
-|1.8|= Game version
+|game2= ofpe
-____________________________________________________________________________________________
+|version2= 1.00
-| Return count of players playing on given side. Works only in multiplayer, in singleplayer always returns 0. |= Description
+|game3= arma1
-____________________________________________________________________________________________
+|version3= 1.00
-| '''playersNumber''' side |= Syntax
+|game4= arma2
+|version4= 1.00
-|p1= side: [[Side]] |= Parameter 1
+|game5= arma2oa
+|version5= 1.50
-| [[Number]] |= Return value
+|game6= tkoh
-____________________________________________________________________________________________
+|version6= 1.00
-|  |= See also
+|game7= arma3
+|version7= 0.50
+|gr1= Multiplayer
+|descr= Returns count of occupied role selection slots for given side. Players who claimed a slot in the lobby but did not start the mission are counted as well. If <syntaxhighlight lang="cpp" inline>disabledAI = 0;</syntaxhighlight> in [[Description.ext#disabledAI|description.ext]] or ''Enable AI'' option is checked in [[:Category:Eden Editor|Eden Editor]], AI bots will be treated as valid players and will be counted too.
+|mp= '''Multiplayer only''', in singleplayer it always returns 0.
+|s1= [[playersNumber]] side
+|p1= side: [[Side]]
+|r1= [[Number]]
+|x1= <sqf>_west = playersNumber west;
+_east = playersNumber east;
+_civ = playersNumber civilian;
+hint format ["West:%1 East:%2, Civ:%3", _west, _east, _civ];</sqf>
+|seealso= [[playableSlotsNumber]] [[countSide]] [[allPlayers]] [[allUnits]]
 }}
-<h3 style="display:none">Notes</h3>
+{{Note
-<dl class="command_description">
+|user= Nelis.75733126
-<!-- Note Section BEGIN -->
+|timestamp= 20150413094400
-playersNumber returns playable AI as well as players. It does not include non playable AI.
+|text= '''2024-04-16 edit:'''<br>
-<!-- Note Section END -->
+<sqf inline>playersNumber</sqf> returns playable AI as well as human players.<br>
-</dl>
+By default, a unit (placed down in the editor for example) ONLY becomes playable when the creator specifically checks the relevant checkbox.<br>
+<br>
-<h3 style="display:none">Bottom Section</h3>
+In addition to the examples already given, this is how <sqf inline>playersNumber</sqf> can be used to get an array of players and playable AI on the same side as the side of the player:<br>
-[[Category:Scripting Commands|PLAYERSNUMBER]]
+<sqf>playersNumber playerSide;</sqf>
-[[Category:Scripting Commands OFP 1.96|PLAYERSNUMBER]]
+|game= arma1
-[[Category:Scripting Commands ArmA|PLAYERSNUMBER]]
+|version= 1.05
+}}