gps: Added export functions for custom logic (#517)

Author: T-MaxWiese-T

[gameplay]/gps/gps.lua

@@ -94,12 +94,19 @@ local function calculatePath(db, nodeFrom, nodeTo)
 end
 
 function calculatePathByCoords(x1, y1, z1, x2, y2, z2)
-	return calculatePath(vehicleNodes, findNodeClosestToPoint(vehicleNodes, x1, y1, z1), findNodeClosestToPoint(vehicleNodes, x2, y2, z2))
+	if not tonumber(x1) or not tonumber(y1) or not tonumber(x2) or not tonumber(y2) then
+		return false
+	end
+	return calculatePath(vehicleNodes, findNodeClosestToPoint(vehicleNodes, tonumber(x1), tonumber(y1), tonumber(z1)),
+	findNodeClosestToPoint(vehicleNodes, tonumber(x2), tonumber(y2), tonumber(z2)))
 end
 
 function calculatePathByNodeIDs(node1, node2)
-	node1 = getNodeByID(vehicleNodes, node1)
-	node2 = getNodeByID(vehicleNodes, node2)
+	if not tonumber(node1) or not tonumber(node2) then
+		return false
+	end
+	node1 = getNodeByID(vehicleNodes, tonumber(node1))
+	node2 = getNodeByID(vehicleNodes, tonumber(node2))
 	if node1 and node2 then
 		return calculatePath(vehicleNodes, node1, node2)
 	else

[gameplay]/gps/linedrawer.lua

@@ -17,9 +17,12 @@ function removeLinePoints ( )
 end
 
 function addLinePoint ( posX, posY )
+	if not tonumber(posX) and not tonumber(poxY) then
+		return false
+	end
 	-- Calculate the row and column of the radar tile we will be targeting
-	local row = 11 - math.floor  ( ( posY + 3000 ) / 500 )
-	local col =      math.floor ( ( posX + 3000 ) / 500 )
+	local row = 11 - math.floor  ( ( tonumber(posY) + 3000 ) / 500 )
+	local col =      math.floor ( ( tonumber(posX) + 3000 ) / 500 )
 
 	-- If it's off the map, don't bother
 	if row < 0 or row > 11 or col < 0 or col > 11 then
@@ -31,8 +34,8 @@ function addLinePoint ( posX, posY )
 	local startY = 3000 - row * 500
 
 	-- Now get the tile position (We don't want to calculate this for every point on render)
-	local tileX = ( posX - startX ) / 500 * OVERLAY_WIDTH
-	local tileY = ( startY - posY ) / 500 * OVERLAY_HEIGHT
+	local tileX = ( tonumber(posX) - startX ) / 500 * OVERLAY_WIDTH
+	local tileY = ( startY - tonumber(posY) ) / 500 * OVERLAY_HEIGHT
 
 	-- Now calulcate the ID and get the name of the tile
 	local id   = col + row * 12

[gameplay]/gps/meta.xml

@@ -1,5 +1,5 @@
 <meta>
-	<info author="arc_" type="script" version="1.0.0"/>
+	<info author="arc_" type="script" version="1.1.0" description="Calculates and displays the quickest road path between two points/nodes on the map. Commands: /path node1 node2 /path2 x y [z]. Resource contains export functions for custom logic."/>
 
 	<script src="util.lua" type="client"/>
 	<script src="client.lua" type="client"/>
@@ -10,4 +10,21 @@
 	<script src="vehiclenodes.lua" type="server"/>
 	<script src="MinHeap.lua" type="server"/>
 	<script src="gps.lua" type="server"/>
+
+	<export function="calculatePathByCoords" type="server"/> <!--calculatePathByCoords(float x1, float y1, float [z1], float x2,
+	float y2, float [z2]) 
+	Function returns a table with the ID (int), neighbours (table), x (float), y (float), z (float) otherwise false. So the 
+	original GTA vehicle node points in ascending order from point A to point B.-->
+	<export function="calculatePathByNodeIDs" type="server"/> <!--calculatePathByNodeIDs(int node1, int node2) 
+	Function returns a table with the ID (int), neighbours (table), x (float), y (float), z (float) otherwise false. So the 
+	original GTA vehicle node points in ascending order from node A to node B.-->
+	<export function="addLinePoint" type="client"/> <!--addLinePoint(float posX, float posY) 
+	Function returns true if successful otherwise false.
+	Draws the path on the client HUD mini map in ascending order. For example, if you use the table returned by the calculatePathByCoords
+	or calculatePathByNodeIDs function. 
+	If you add your own line points points they must be very close to each other, otherwise the path will not be drawn properly.-->
+	<export function="removeLinePoints" type="client"/> <!--removeLinePoints()
+	Function returns nil.
+	Removes the line points of the addLinePoint function respectively the drawn lines of the client HUD mini map. 
+	This can be used, for example, when the target node point has been reached or a player gets out of the vehicle.-->
 </meta>