allPlayers: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "_{10,} " to "")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|Game|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments \("local" or "global"\)|Multiplayer Effects \("local" or "global"\)|Multiplayer Execution \("serv...)
Line 1: Line 1:
{{Command|Comments=
{{Command


| arma3 |Game name=
| arma3


|1.48|Game version=
|1.48


|gr1 = Multiplayer |GROUP1=
|gr1 = Multiplayer


|gr2= Object Detection |GROUP2=
|gr2= Object Detection


| Returns a list of all units controlled by ''connected clients'' - human players including dead players, but also [[Arma 3 Headless Client|Headless Clients]].<br>
| Returns a list of all units controlled by ''connected clients'' - human players including dead players, but also [[Arma 3 Headless Client|Headless Clients]].<br>
Line 16: Line 16:
* The order of players in the return array may differ from server to clients. |Multiplayer=
* The order of players in the return array may differ from server to clients. |Multiplayer=


| [[allPlayers]] |SYNTAX=
| [[allPlayers]]


| [[Array]] of [[Object]] |RETURNVALUE=
| [[Array]] of [[Object]]


|x1= Get only human players:
|x1= Get only human players:
<code>[[private]] _headlessClients = [[entities]] "HeadlessClient_F";
<code>[[private]] _headlessClients = [[entities]] "HeadlessClient_F";
[[private]] _humanPlayers = [[allPlayers]] - _headlessClients;</code> |EXAMPLE1=
[[private]] _humanPlayers = [[allPlayers]] - _headlessClients;</code>


|x2= <code>{
|x2= <code>{
Line 30: Line 30:
["dead", "alive"] [[select]] [[alive]] _x
["dead", "alive"] [[select]] [[alive]] _x
];
];
} [[forEach]] [[allPlayers]];</code>|EXAMPLE2=
} [[forEach]] [[allPlayers]];</code>


|x3= <code>[[private]] _bluNums = [[west]] [[countSide]] [[allPlayers]];</code> |EXAMPLE3=
|x3= <code>[[private]] _bluNums = [[west]] [[countSide]] [[allPlayers]];</code>




| [[allCurators]], [[allGroups]], [[allDead]], [[allUnits]], [[switchableUnits]], [[playableUnits]], [[vehicles]], [[allUnitsUAV]], [[allDeadMen]], [[isPlayer]], [[playersNumber]] |SEEALSO=
| [[allCurators]], [[allGroups]], [[allDead]], [[allUnits]], [[switchableUnits]], [[playableUnits]], [[vehicles]], [[allUnitsUAV]], [[allDeadMen]], [[isPlayer]], [[playersNumber]]
}}
}}



Revision as of 01:04, 18 January 2021

Hover & click on the images for description

Description

Description:
Returns a list of all units controlled by connected clients - human players including dead players, but also Headless Clients.
Use BIS_fnc_listPlayers or see Example 1 to get human players only.
Multiplayer:
* In a player-hosted game, the complete array of allPlayers may get delayed on mission start. Use BIS_fnc_listPlayers if you need it earlier.
  • The order of players in the return array may differ from server to clients.
Groups:
MultiplayerObject Detection

Syntax

Syntax:
allPlayers
Return Value:
Array of Object

Examples

Example 1:
Get only human players: private _headlessClients = entities "HeadlessClient_F"; private _humanPlayers = allPlayers - _headlessClients;
Example 2:
{ systemChat format [ "Player %1 is %2", name _x, ["dead", "alive"] select alive _x ]; } forEach allPlayers;
Example 3:
private _bluNums = west countSide allPlayers;

Additional Information

See also:
allCuratorsallGroupsallDeadallUnitsswitchableUnitsplayableUnitsvehiclesallUnitsUAVallDeadMenisPlayerplayersNumber

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

Notes

Bottom Section