BIS fnc listPlayers: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (1 revision)
m (Text replacement - "Objects" to "Objects")
 
(36 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{RV|type=function


{{Function|= Comments
|game1= arma2
____________________________________________________________________________________________
|version1= 1.00


| arma2 |= Game name
|game2= arma2oa
|version2= 1.50


|1.00|= Game version
|game3= tkoh
____________________________________________________________________________________________
|version3= 1.00


| <pre>/*
|game4= arma3
|version4= 0.50


Description:
|gr1= Multiplayer
Returns list of playable units


Returns:
|descr= Returns a list of ''currently played'' units, alive or dead.
ARRAY - list of units
*/


</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
|s1= call [[BIS_fnc_listPlayers]]
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_listPlayers]]; --> |= Syntax
|r1= [[Array]] of [[Object]]s


|p1= |= Parameter 1
|x1= <sqf>private _allPlayers = call BIS_fnc_listPlayers;</sqf>
 
| |= Return value
____________________________________________________________________________________________
 
|x1= <code></code> |=
____________________________________________________________________________________________
 
| |= See also


|seealso= [[isPlayer]] [[playableUnits]]
}}
}}
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style="display:none">Bottom Section</h3>
[[Category:Function Group: Misc|{{uc:listPlayers}}]]
[[Category:Functions|{{uc:listPlayers}}]]
[[Category:{{Name|arma2}}: Functions|{{uc:listPlayers}}]]
[[Category:{{Name|arma2oa}}: Functions|{{uc:listPlayers}}]]
[[Category:{{Name|tkoh}}: Functions|{{uc:listPlayers}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:listPlayers}}]]

Latest revision as of 00:39, 13 July 2022

Hover & click on the images for description

Description

Description:
Returns a list of currently played units, alive or dead.
Execution:
call
Groups:
Multiplayer

Syntax

Syntax:
call BIS_fnc_listPlayers
Return Value:
Array of Objects

Examples

Example 1:
private _allPlayers = call BIS_fnc_listPlayers;

Additional Information

See also:
isPlayer playableUnits

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