playersNumber: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
m (improved note formatting.)
 
(55 intermediate revisions by 3 users not shown)
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.
|game3= arma1
|version3= 1.00


Returns number of playable slots taken by a side, not actual number of players of the side present in the mission. As a result, players who claimed a slot in the lobby but didn't start the mission yet are counted in as well. |= Description
|game4= arma2
____________________________________________________________________________________________
|version4= 1.00


| [[Number]] <nowiki>=</nowiki>  '''playersNumber''' side |= Syntax
|game5= arma2oa
|version5= 1.50


|p1= side: [[Side]] |= Parameter 1
|game6= tkoh
|version6= 1.00


| [[Number]] |= Return value
|game7= arma3
____________________________________________________________________________________________
|version7= 0.50
 
 
|x1= <pre>_west = playersNumber west;
|gr1= Multiplayer
_east = playersNumber east;
 
_civ = playersNumber civilian;
|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.
hint format [ "West:%1 East:%2, Civ:%3", _west, _east, _civ];</pre>
 
|= Example 1
|mp= '''Multiplayer only''', in singleplayer it always returns 0.


____________________________________________________________________________________________
|s1= [[playersNumber]] side


| |= See also
|p1= side: [[Side]]


}}
|r1= [[Number]]


<h3 style="display:none">Notes</h3>
|x1= <sqf>_west = playersNumber west;
<dl class="command_description">
_east = playersNumber east;
<!-- Note Section BEGIN -->
_civ = playersNumber civilian;
playersNumber returns playable AI as well as human players. It does not include non playable AI. [NOTE: This was observed in ArmA 1.05]
hint format ["West:%1 East:%2, Civ:%3", _west, _east, _civ];</sqf>
<!-- Note Section END -->
</dl>


<h3 style="display:none">Bottom Section</h3>
|seealso= [[playableSlotsNumber]] [[countSide]] [[allPlayers]] [[allUnits]]
[[Category:Scripting Commands|PLAYERSNUMBER]]
}}
[[Category:Scripting Commands OFP 1.99|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands OFP 1.96|PLAYERSNUMBER]]
[[Category:Scripting Commands ArmA|PLAYERSNUMBER]]
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
[[Category:Command_Group:_Multiplayer|{{uc:{{PAGENAME}}}}]]


<!-- CONTINUE Notes -->
{{Note
<dl class="command_description">
|user= Nelis.75733126
<dd class="notedate">Posted on April 13, 2015 - 09:44 (UTC)</dd>
|timestamp= 20150413094400
<dt class="note">[[User:IT07|IT07]]</dt>
|text= '''2024-04-16 edit:'''<br>
<dd class="note">
<sqf inline>playersNumber</sqf> returns playable AI as well as human players.<br>
To get the amount of players that are on the same side as the person executing the script:
By default, a unit (placed down in the editor for example) ONLY becomes playable when the creator specifically checks the relevant checkbox.<br>
<code>playersNumber playerSide;</code>
<br>
</dd>
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>
</dl>
<sqf>playersNumber playerSide;</sqf>
<!-- DISCONTINUE Notes -->
|game= arma1
|version= 1.05
}}

Latest revision as of 19:30, 16 April 2024

Logo A0.png1.80ofpe logo.png1.00Logo A1 black.png1.00Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.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)
Logo A1 black.png1.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;

Retrieved from "https://community.bistudio.com/wiki?title=playersNumber&oldid=363708"