Differences

This shows you the differences between two versions of the page.

--- prpl:getnearestshipinrange [2016/12/02 23:33] – external edit 127.0.0.1
+++ prpl:getnearestshipinrange [2025/02/14 14:57] (current) – external edit 127.0.0.1
@@ Line 1: / Line 1: @@
 <- [[.:prplreference| PRPL reference]] <- [[.:prplreference#everything_else_2|Everything Else 2]]
-=====  GETNEARESTSHIPINRANGE  =====
+=====  GetNearestShipInRange  =====
 ^Arguments^Result^Notation^
-| | | [ - ] |
+| x y radius sqaure | sid | [ int int float bool - int ] |
 === Description ===
+  * **x**: The x coordinate of the center of the search, in cells
+  * **y**: The y coordinate of the center of the search, in cells
+  * **radius**: The radius of the search area, in cells
+  * **sqaure**: If set to true, the search area will be square with side length 2x**radius**, otherwise it will be a cirlce with radius **radius**
+Find the nearest ship to the target coordinates and returns it's ship id on stack. If no ship is found in the range, -1 is pushed on the stack instead.
+The center of the command module needs to be in range in order for the ship to register (you could even have a ship collide with the search cencer and still not be found if the command center is too far away, for example).
+All 3 of player ship, friendly ships (the blue uncontrollable ones) and enemy ships count. Dopplers and friendly dopplers don't count.
 === Examples ===
-<code>	i1 = GetIntFromStack();
+<code prpl>
-	f1 = GetFloatFromStack();
+50 20 1 GetNearestShipInRange Trace
-	gsy = GetIntFromStack();
-	gsx = GetIntFromStack();
-	stack.Push(new Data(nearestShip));
 </code>
+Screenshot:
+{{:prpl:screenshot_3.png?400|}}
+This is a visual representation of the code in the example. The energy source in the middle has the same range as the search would have, if it was in circle mode, giving you a good idea of the search area.

Knuckle Cracker Wiki

User Tools

Site Tools

Differences

Page Tools