allPlayers: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - "|= |x3=" to "|Example2= |x3=") |
Lou Montana (talk | contribs) m (Text replacement - "<sqf>([^↵][^\/]*↵[^\/]*)<\/sqf>" to "<sqf> $1 </sqf>") |
||
(47 intermediate revisions by 4 users not shown) | |||
Line 1: | Line 1: | ||
{{ | {{RV|type=command | ||
| arma3 | | |game1= arma3 | ||
|version1= 1.48 | |||
| | |gr1= Multiplayer | ||
| | |gr2= Object Detection | ||
''' | |descr= Returns a list of all units controlled by connected clients. This includes: | ||
* Normal human players (including dead players) | |||
* | * [[Eden Editor: System#Virtual Entities|Virtual Entities]] (see ''Systems'' → ''Logic Entities'' → ''Virtual Entities'' in the [[:Category:Eden Editor|Eden Editor]]) | ||
** [[Arma 3: Headless Client|Headless Clients]] ({{hl|HeadlessClient_F}}) | |||
** Virtual Curators ({{hl|VirtualCurator_F}}, {{hl|*_VirtualCurator_F}}) | |||
** Virtual Spectators ({{hl|VirtualSpectator_F}}) | |||
| | Use [[BIS_fnc_listPlayers]] or see {{Link|#Example 1}} to only get human players. | ||
| | |mp=<nowiki/> | ||
* The complete array of [[allPlayers]] may get delayed on mission start in multiplayer. Use [[BIS_fnc_listPlayers]] to obtain it earlier. | |||
* The order of the returned array may differ from server to clients. | |||
| | |s1= [[allPlayers]] | ||
| | |r1= [[Array]] of [[Object]]s | ||
| | |x1= Get human players (i.e. all players excluding Headless Clients): | ||
<sqf> | |||
private _players = allPlayers - entities "HeadlessClient_F"; | |||
</sqf> | |||
|x2= Get non-virtual players (i.e. all players excluding Virtual Entities): | |||
<sqf> | |||
private _players = allPlayers select {!(_x isKindOf "VirtualMan_F")}; | |||
</sqf> | |||
| | |x3= <sqf> | ||
{ | |||
systemChat format [ | |||
"Player %1 is %2", | "Player %1 is %2", | ||
name _x, | |||
["dead", "alive"] | ["dead", "alive"] select alive _x | ||
]; | ]; | ||
} | } forEach allPlayers; | ||
</sqf> | |||
| | |x4= <sqf>private _bluforPlayers = blufor countSide allPlayers;</sqf> | ||
| | |seealso= [[allCurators]] [[allGroups]] [[allDead]] [[allUnits]] [[switchableUnits]] [[playableUnits]] [[vehicles]] [[allUnitsUAV]] [[allDeadMen]] [[isPlayer]] [[playersNumber]] [[allUsers]] [[getUserInfo]] | ||
}} | }} | ||
Latest revision as of 11:25, 3 September 2024
Description
- Description:
- Returns a list of all units controlled by connected clients. This includes:
- Normal human players (including dead players)
- Virtual Entities (see Systems → Logic Entities → Virtual Entities in the Eden Editor)
- Headless Clients (HeadlessClient_F)
- Virtual Curators (VirtualCurator_F,
- _VirtualCurator_F)
- Virtual Spectators (VirtualSpectator_F)
- Multiplayer:
-
- The complete array of allPlayers may get delayed on mission start in multiplayer. Use BIS_fnc_listPlayers to obtain it earlier.
- The order of the returned array may differ from server to clients.
- Groups:
- MultiplayerObject Detection
Syntax
- Syntax:
- allPlayers
- Return Value:
- Array of Objects
Examples
- Example 1:
- Get human players (i.e. all players excluding Headless Clients):
- Example 2:
- Get non-virtual players (i.e. all players excluding Virtual Entities):
- Example 3:
- Example 4:
Additional Information
- See also:
- allCurators allGroups allDead allUnits switchableUnits playableUnits vehicles allUnitsUAV allDeadMen isPlayer playersNumber allUsers getUserInfo
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