Difference between revisions of "Particles:getNearestParticle"

Latest revision as of 21:32, 21 September 2023

Available since: 2020.9
Class: Particles

Gets the nearest particle number from a specified point.

(number) = Particles:getNearestParticle(x,y)

x: (number) x coordinate of the reference point
y: (number) y coordinate of the reference point

Returns (number) index of the nearest particle, or nil if no particles

@@ Line 1: / Line 1: @@
 __NOTOC__
-<languages />
+'''Available since:''' 2020.9<br/>
-'''<translate>Available since</translate>:''' 2020.9<br/>
+'''Class:''' [[Particles]]<br/>
-'''<translate>Class</translate>:''' [[Special:MyLanguage/Particles|Particles]]<br/>
-=== <translate>Description</translate> ===
+=== Description ===
-<translate>Get the nearest particle number from a specified point</translate>
+Gets the nearest particle number from a specified point.
-<source lang="lua">
+<syntaxhighlight lang="lua">
 (number) = Particles:getNearestParticle(x,y)
-</source>
+</syntaxhighlight>
-=== <translate>Parameters</translate> ===
-'''x''': (number) <translate>X coordinate of the reference point</translate> <br/>
+=== Parameters ===
-'''y''': (number) <translate>Y coordinate of the reference point</translate> <br/>
+'''x''': (number) x coordinate of the reference point<br/>
-=== <translate>Return values</translate> ===
+'''y''': (number) y coordinate of the reference point<br/>
-'''<translate>Returns</translate>''' (number) <translate>index of the nearest particle, or nil if no particles</translate><br/>
+=== Return values ===
+'''Returns''' (number) index of the nearest particle, or nil if no particles<br/>
 {{Particles}}