IsPlayerInRangeOfPoint: Difference between revisions

From NPC for VCMP 0.4 Servers
Jump to navigation Jump to search
(Created page with "{{Welcome| params=<source lang="lua">(playerid, radius, point)</source> <poem>::playerid : The ID of the player whom you want to check if within an area. ::raidus : The radius...")
 
No edit summary
 
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{Welcome|
{{Welcome|
desc=Checks whether a player is within an area ( around a point with specified radius ).|
params=<source lang="lua">(playerid, radius, point)</source>
params=<source lang="lua">(playerid, radius, point)</source>
<poem>::playerid : The ID of the player whom you want to check if within an area.
<poem>::playerid : The ID of the player whom you want to check if within an area.
::raidus : The radius (as Float) about a point you want to check if the player is within.
::raidus : The radius (as Float) about a point you want to check if the player is within.
::point : This is a [[Vector]] which has 3 components. Checks if the player is around this point.</poem>|
::point : This is a [[Vector]] which has 3 components. Checks if the player is around this point.</poem>|
retvals=true, if the player is within the circle; false, otherwise.|
retvals='''true''', if the player is within the circle; '''false''', if not and null if the player is not connected.|
}}
}}

Latest revision as of 22:25, 7 January 2023


Description:
Checks whether a player is within an area ( around a point with specified radius ).


Parameters:

(playerid, radius, point)

playerid : The ID of the player whom you want to check if within an area.
raidus : The radius (as Float) about a point you want to check if the player is within.
point : This is a Vector which has 3 components. Checks if the player is around this point.


Return Values:
true, if the player is within the circle; false, if not and null if the player is not connected.