Pool::toArray: Difference between revisions

From RAGE Multiplayer Wiki
m (Cleaned up the example code's grammar, punctuation, and capitalization.)
No edit summary
Line 1: Line 1:
This function converts a pool to a [https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array JavaScript array].
__NOTOC__
{{SharedJsFunction}}
This function converts a pool to an array. If you don't need to create a new array every time, use [[Pool::toArrayFast]].


{{JSContainer|
==Syntax==
==Syntax==
<pre>
<pre>
pool.toArray();
mp.pool.toArray();
</pre>  
</pre>  


Line 9: Line 13:
{{ServersideCode|
{{ServersideCode|
<pre>
<pre>
var suchJavascript = mp.players.toArray();
const onlinePlayers = mp.players.toArray();
if(suchJavascript.every((player) => { return player.isAiming; } ))
if(onlinePlayers.every((player) => { return player.isAiming; } ))
     console.log("Everyone is aiming.");
     console.log("Everyone is aiming.");
</pre>
</pre>
}}
}}
}}
== See Also ==
{{EntityPool_definition}}
[[Category:Shared API]]
[[Category:Shared Function]]

Revision as of 02:07, 25 April 2021

Shared
Function

 JavaScript


This function converts a pool to an array. If you don't need to create a new array every time, use Pool::toArrayFast.

JavaScript Syntax

Syntax

mp.pool.toArray();

Example

Server-Side
const onlinePlayers = mp.players.toArray();
if(onlinePlayers.every((player) => { return player.isAiming; } ))
    console.log("Everyone is aiming.");


See Also