Logan: /* Syntax */

2020-10-03T12:35:02Z

Syntax

New page

{{Note|You can use [[CountPlayersInRange|countPlayersInRange]] if you want count players in the range.}}
{{Useful Function}}
==Syntax==
<syntaxhighlight lang="lua">
table getPlayersInRange(element thePlayer, float range)
</syntaxhighlight>

===Required Arguments===
* '''thePlayer''' : The player you want to get the players in range.
* '''range''' : Range size.
===Returns===
Returns a table of players that are within a certain range if there is minimum 1 player else it returns false.
==Code==
<section name="Function source" class="both" show="true">
<syntaxhighlight lang="lua">
function getPlayersInRange (playerSource,range)
local allPlayers = getElementsByType("player");
local x,y,z = getElementPosition(playerSource);
local count = 0;
local players = {}
for k, v in ipairs(allPlayers) do
if(v and playerSource)then
if not(v == playerSource)then
local Sx,Sy,Sz = getElementPosition(v);
local distance = getDistanceBetweenPoints3D(x,y,z,Sx,Sy,Sz);
if(distance <= range)then
count = count +1
players[v] = v;
end
end
end
end
if(count == 0)then
return false;
else
return players;
end
end
</syntaxhighlight>
</section>

* [ Created By ; IDARED ]

==See Also==
{{Useful_Functions}}

GetPlayersInRange - Revision history

Logan: /* Syntax */