playableUnits: Difference between revisions

From Bohemia Interactive Community
(moved important AgentRevs note to description)
m (Text replacement - "{{Feature|Informative|" to "{{Feature|informative|")
 
(80 intermediate revisions by 7 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


| arma2 |= Game name
|game1= arma2
|version1= 1.00


|1.00|= Game version
|game2= arma2oa
____________________________________________________________________________________________
|version2= 1.50


| Returns a list of playable units (occupied by both AI or players) in a multiplayer game. This does not include dead players awaiting respawn.  |= Description
|game3= tkoh
____________________________________________________________________________________________
|version3= 1.00


| '''playableUnits''' |= Syntax
|game4= arma3
|version4= 0.50


|p1= |= PARAMETER1
|gr1= Multiplayer


|p2= |= PARAMETER2
|gr2= Object Detection


|p3= |= PARAMETER3
|descr= 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]].
{{Feature|informative|This command returns an empty array in Singleplayer; use [[switchableUnits]] instead.}}
{{Feature|important|This command does not include dead players awaiting for respawn.}}


| [[Array]] |= RETURNVALUE
|s1= [[playableUnits]]


|r1= [[Array]]


|x1= <code>{_x [[groupChat]] "I'm a playable unit.";} [[forEach]] [[playableUnits]];</code>|= EXAMPLE1
|x1= <sqf>{ _x groupChat "I'm a playable unit."; } forEach playableUnits;</sqf>


____________________________________________________________________________________________
|x2= <sqf>_playableInGroup = units group player arrayIntersect playableUnits;</sqf>


| [[allCurators]], [[allGroups]], [[allDead]], [[switchableUnits]], [[vehicles]], [[allUnitsUAV]], [[allDeadMen]], [[isPlayer]] |= SEEALSO
|x3= <sqf>_nonPlayableInGroup = units group player - playableUnits;</sqf>


| |= MPBEHAVIOUR
|seealso= [[playableSlotsNumber]] [[allPlayers]] [[allCurators]] [[allGroups]] [[allDead]] [[switchableUnits]] [[vehicles]] [[allUnitsUAV]] [[allDeadMen]] [[isPlayer]] [[playersNumber]]
____________________________________________________________________________________________
}}
}}


<h3 style='display:none'>Notes</h3>
{{Note
<dl class='command_description'>
|user= DreadedEntity
<!-- Note Section BEGIN -->
|timestamp= 20141223231300
<dd class="notedate">Posted on July 13, 2009 - 11:35
|text= To get a list of all player-controlled units:
<dt class="note">'''[[User:Killswitch|Killswitch]]'''<dd class="note">In single-player missions, this command will return an empty array.
<sqf>
<!-- Note Section END -->
_allPlayers = [];
</dl>
 
<h3 style='display:none'>Bottom Section</h3>
[[Category:ArmA 2: New Scripting Commands List|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
[[Category:Command_Group:_Multiplayer|{{uc:{{PAGENAME}}}}]]
 
<!-- CONTINUE Notes -->
<dl class="command_description">
<dd class="notedate">Posted on December 23, 2014 - 23:13 (UTC)</dd>
<dt class="note">[[User:DreadedEntity|DreadedEntity]]</dt>
<dd class="note">
To get a list of all player-controlled units:
<code>_allPlayers = [];
{
{
[[if]] ([[isPlayer]] _x) [[then]]
if (isPlayer _x) then
{
{
_allPlayers [[pushBack]] _x;
_allPlayers pushBack _x;
};
};
} [[forEach]] [[playableUnits]];</code>
} forEach playableUnits;
</dd>
</sqf>
</dl>
}}
<!-- DISCONTINUE Notes -->
 
{{Note
|user= FR Starfox64
|timestamp= 20150816100500
|text= [[playableUnits]] will not return dead players, use [[allPlayers]] instead.
}}
 
{{Note
|user= Pierre MGI
|timestamp= 20170214220500
|text= 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<br>
Furthermore, in this case, non-played slot (playable and disabled AI) units simply don't exist!<br>
i.e. If you name 8 playable units: u1..u8, then 2 players in game: u3 & u6<br>
playableUnits will return [u3,u6], and true for  isNil "u1", isNil "u2"... until another player takes the slot.
}}

Latest revision as of 01:24, 2 February 2024

Logo A2.png 1.00A2 OA Logo.png 1.50tkoh logo small.png 1.00Arma 3 logo black.png 0.50
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:
playableSlotsNumber allPlayers allCurators allGroups allDead switchableUnits vehicles allUnitsUAV allDeadMen isPlayer playersNumber

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
DreadedEntity - c
Posted on Dec 23, 2014 - 23:13 (UTC)
To get a list of all player-controlled units:
_allPlayers = []; { if (isPlayer _x) then { _allPlayers pushBack _x; }; } forEach playableUnits;
FR Starfox64 - c
Posted on Aug 16, 2015 - 10:05 (UTC)
playableUnits will not return dead players, use allPlayers instead.
Pierre MGI - c
Posted on Feb 14, 2017 - 22:05 (UTC)
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.
Retrieved from "https://community.bistudio.com/wiki?title=playableUnits&oldid=352069"