playableUnits: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Category:[ _]?Scripting[ _]Commands[ _]Take[ _]On[ _]Helicopters(\|.*)?\]\]" to "{{GameCategory|tkoh|Scripting Commands}}")
m (Text replacement - "_{10,} " to "")
Line 1: Line 1:
{{Command|Comments=
{{Command|Comments=
____________________________________________________________________________________________


| arma2 |Game name=
| arma2 |Game name=
Line 9: Line 8:


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


| Returns a list of playable units in a multiplayer game (occupied by both AI or players), created on the following sides [[east]]/[[opfor]], [[west]]/[[blufor]], [[resistance]]/[[independent]] and [[civilian]] only. Does not contain units of [[sideLogic]].<br>
| Returns a list of playable units in a multiplayer game (occupied by both AI or players), created on the following sides [[east]]/[[opfor]], [[west]]/[[blufor]], [[resistance]]/[[independent]] and [[civilian]] only. Does not contain units of [[sideLogic]].<br>
{{Informative|This command returns an empty array in Singleplayer; use [[switchableUnits]] instead.}}
{{Informative|This command returns an empty array in Singleplayer; use [[switchableUnits]] instead.}}
{{Important|This command does not include dead players awaiting for respawn.}} |Description=
{{Important|This command does not include dead players awaiting for respawn.}} |Description=
____________________________________________________________________________________________


| [[playableUnits]] |Syntax=
| [[playableUnits]] |Syntax=
Line 24: Line 21:
|x2= <code>_playableInGroup = [[units]] [[group]] [[player]] [[arrayIntersect]] [[playableUnits]];</code> |EXAMPLE2=
|x2= <code>_playableInGroup = [[units]] [[group]] [[player]] [[arrayIntersect]] [[playableUnits]];</code> |EXAMPLE2=
|x3= <code>_nonPlayableInGroup = [[units]] [[group]] [[player]] - [[playableUnits]];</code> |EXAMPLE3=
|x3= <code>_nonPlayableInGroup = [[units]] [[group]] [[player]] - [[playableUnits]];</code> |EXAMPLE3=
____________________________________________________________________________________________


| [[playableSlotsNumber]], [[allPlayers]], [[allCurators]], [[allGroups]], [[allDead]], [[switchableUnits]], [[vehicles]], [[allUnitsUAV]], [[allDeadMen]], [[isPlayer]], [[playersNumber]] |SEEALSO=
| [[playableSlotsNumber]], [[allPlayers]], [[allCurators]], [[allGroups]], [[allDead]], [[switchableUnits]], [[vehicles]], [[allUnitsUAV]], [[allDeadMen]], [[isPlayer]], [[playersNumber]] |SEEALSO=


| |MPBEHAVIOUR=
| |MPBEHAVIOUR=
____________________________________________________________________________________________
}}
}}



Revision as of 03:16, 17 January 2021

Hover & click on the images for description

Description

Description:
Returns a list of playable units in a multiplayer game (occupied by both AI or players), created on the following sides east/opfor, west/blufor, resistance/independent and civilian only. Does not contain units of sideLogic.
This command returns an empty array in Singleplayer; use switchableUnits instead.
This command does not include dead players awaiting for respawn.
Groups:
MultiplayerObject Detection

Syntax

Syntax:
playableUnits
Return Value:
Array

Examples

Example 1:
{ _x groupChat "I'm a playable unit."; } forEach playableUnits;
Example 2:
_playableInGroup = units group player arrayIntersect playableUnits;
Example 3:
_nonPlayableInGroup = units group player - playableUnits;

Additional Information

See also:
playableSlotsNumberallPlayersallCuratorsallGroupsallDeadswitchableUnitsvehiclesallUnitsUAVallDeadMenisPlayerplayersNumber

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


Bottom Section


Notes

Posted on December 23, 2014 - 23:13 (UTC)
DreadedEntity
To get a list of all player-controlled units: _allPlayers = []; { if (isPlayer _x) then { _allPlayers pushBack _x; }; } forEach playableUnits;
Posted on August 16, 2015 - 10:05 (UTC)
FR Starfox64
playableUnits will not return dead players, use allPlayers instead.
Posted on February 14, 2017 - 22:05 (UTC)
Pierre MGI
Using the Editor (multiplayer attributes) for unchecking "enable AI", or disabling AI(s) in lobby, will make playableUnits as a public variable, updated by each JIP on disabled slot. So, if all slots are disabled AI, playableUnits is same as allPlayers
Furthermore, in this case, non-played slot (playable and disabled AI) units simply don't exist!
i.e. If you name 8 playable units: u1..u8, then 2 players in game: u3 & u6
playableUnits will return [u3,u6], and true for isNil "u1", isNil "u2"... until another player takes the slot.