GetPlayersInRange2D: Difference between revisions

From Onset Developer Wiki
Created page with "{{Info|Function|Server|1.0}} {{FuncDescription|__EDIT_ME__}} {{FuncSyntax|GetPlayersInRange2D(x, y, range)}} {{FuncParameters}} {{FuncParam|x|__EDIT_ME__}} {{FuncParam|y|__..."
 
No edit summary
 
(2 intermediate revisions by one other user not shown)
Line 1: Line 1:
{{Info|Function|Server|1.0}}
{{Info|Function|Server|1.0}}


{{FuncDescription|__EDIT_ME__}}
{{FuncDescription|Gets the players in the specified range of XY in a table. An important function which replaces the use of looping through all players and then checking if they are in the specified range.}}


{{FuncSyntax|GetPlayersInRange2D(x, y, range)}}
{{FuncSyntax|GetPlayersInRange2D(x, y, range)}}


{{FuncParameters}}
{{FuncParameters}}
{{FuncParam|x|__EDIT_ME__}}
{{FuncParam|x|The X axis}}
{{FuncParam|y|__EDIT_ME__}}
{{FuncParam|y|The Y axis}}
{{FuncParam|range|__EDIT_ME__}}
{{FuncParam|range|The range in cm}}


{{FuncReturnValue|__EDIT_ME__}}
{{FuncReturnValue|Returns a table with the player identifiers in range.}}


== Example ==
== Example ==
__EDIT_ME__
<syntaxhighlight lang='Lua'>
for k, v in pairs(GetPlayersInRange2D(x, y, 1000)) do
        AddPlayerChat(v, "HEY YOU ARE IN THE RANGE OF THIS POINT.")
end
</syntaxhighlight>


{{RelatedFunctions}}
{{RelatedFunctions}}
__EDIT_ME__
{{ServerPlayerFunctions}}

Latest revision as of 18:33, 30 August 2020

GetPlayersInRange2D

Type: Function
Context: Server
Introduced: v1.0

Description

Gets the players in the specified range of XY in a table. An important function which replaces the use of looping through all players and then checking if they are in the specified range.

Syntax

GetPlayersInRange2D(x, y, range)

Parameters

  • x
    The X axis
  • y
    The Y axis
  • range
    The range in cm

Return Value

  • Returns a table with the player identifiers in range.

Example

for k, v in pairs(GetPlayersInRange2D(x, y, 1000)) do
        AddPlayerChat(v, "HEY YOU ARE IN THE RANGE OF THIS POINT.")
end

See also

Retrieved from "https://dev.playonset.com/index.php?title=GetPlayersInRange2D&oldid=4100"