playersNumber: Difference between revisions

Latest revision as of 11:34, 3 September 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

Nelis75733126 - 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: @@
 {{RV|type=command
-| ofpr
+|game1= ofp
+|version1= 1.80
-|1.80
+|game2= ofpe
+|version2= 1.00
-|gr1 = Multiplayer
+|game3= arma1
+|version3= 1.00
-| Returns count of occupied role selection slots for given side. Players who claimed a slot in the lobby but didn't start the mission are counted as well. If <tt>disabledAI <nowiki>=</nowiki> 0;</tt> in [[description.ext#disabledAI|description.ext]] or Enable AI option is checked in [[3DEN]], AI bots will be treated as valid players and will be counted too. Multiplayer only, in singleplayer always returns 0.
+|game4= arma2
+|version4= 1.00
-| [[playersNumber]] side
+|game5= arma2oa
+|version5= 1.50
-|p1= side: [[Side]]
+|game6= tkoh
+|version6= 1.00
+|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.
-| [[Number]]
+|s1= [[playersNumber]] side
-|x1= <code>_west = [[playersNumber]] [[west]];
-_east = [[playersNumber]] [[east]];
-_civ = [[playersNumber]] [[civilian]];
-[[hint]] [[format]] ["West:%1 East:%2, Civ:%3", _west, _east, _civ];</code>
-| [[playableSlotsNumber]], [[countSide]], [[allPlayers]], [[allUnits]]
+|p1= side: [[Side]]
-}}
-<dl class="command_description">
+|r1= [[Number]]
-<dd class="notedate">Posted on April 13, 2015 - 09:44 (UTC)
+|x1= <sqf>
-<dt class="note">[[User:IT07|IT07]]
+_west = playersNumber west;
-<dd class="note">
+_east = playersNumber east;
-[[playersNumber]] returns playable AI as well as human players. It does not include non playable AI. [NOTE: This was observed in ArmA 1.05]<br>
+_civ = playersNumber civilian;
-To get the amount of players that are on the same side as the person executing the script:
+hint format ["West:%1 East:%2, Civ:%3", _west, _east, _civ];
-<code>[[playersNumber]] [[playerSide]];</code>
+</sqf>
-</dl>
+|seealso= [[playableSlotsNumber]] [[countSide]] [[allPlayers]] [[allUnits]]
+}}
-[[Category:Scripting Commands|PLAYERSNUMBER]]
+{{Note
-[[Category:Scripting Commands OFP 1.99|{{uc:{{PAGENAME}}}}]]
+|user= Nelis75733126
-[[Category:Scripting Commands OFP 1.96|PLAYERSNUMBER]]
+|timestamp= 20150413094400
-{{GameCategory|arma1|Scripting Commands}}
+|text= '''2024-04-16 edit:'''<br>
-{{GameCategory|arma2|Scripting Commands}}
+<sqf inline>playersNumber</sqf> returns playable AI as well as human players.<br>
-{{GameCategory|arma3|Scripting Commands}}
+By default, a unit (placed down in the editor for example) ONLY becomes playable when the creator specifically checks the relevant checkbox.<br>
-{{GameCategory|tkoh|Scripting Commands}}
+<br>
+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>
+<sqf>playersNumber playerSide;</sqf>
+|game= arma1
+|version= 1.05
+}}