BIS fnc listPlayers: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (template:command argument fix)
m (Text replacement - "Objects" to "Objects")
 
(33 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Function|= Comments
{{RV|type=function
____________________________________________________________________________________________


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


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


| Returns a list of ''currently played'' units, alive or dead. |DESCRIPTION=
|game3= tkoh
____________________________________________________________________________________________
|version3= 1.00


| call [[BIS_fnc_listPlayers]] |SYNTAX=
|game4= arma3
|version4= 0.50


| [[Array]] of [[Object|Objects]] |RETURNVALUE=
|gr1= Multiplayer
____________________________________________________________________________________________


|x1= <code>_allPlayers = [[call]] [[BIS_fnc_listPlayers]];</code> |EXAMPLE1=
|descr= Returns a list of ''currently played'' units, alive or dead.
____________________________________________________________________________________________


| [[isPlayer]], [[playableUnits]] |SEEALSO=
|s1= call [[BIS_fnc_listPlayers]]
}}


<h3 style="display:none">Notes</h3>
|r1= [[Array]] of [[Object]]s
<dl class="command_description">
<!-- Note Section BEGIN -->


<!-- Note Section END -->
|x1= <sqf>private _allPlayers = call BIS_fnc_listPlayers;</sqf>
</dl>


<h3 style="display:none">Bottom Section</h3>
|seealso= [[isPlayer]] [[playableUnits]]
[[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