Pathfind::getStreetNameAtCoord: Difference between revisions

Latest revision as of 09:03, 17 November 2017

Determines the name of the street which is the closest to the given coordinates.

x,y,z - the coordinates of the street
streetName - returns a hash to the name of the street the coords are on
crossingRoad - if the coordinates are on an intersection, a hash to the name of the crossing road

Note: the names are returned as hashes, the strings can be returned using the function UI::GET_STREET_NAME_FROM_HASH_KEY.

Syntax

mp.game.pathfind.getStreetNameAtCoord(x, y, z, streetName, crossingRoad);

Required Arguments

x: float
y: float
z: float
streetName: Hash
crossingRoad: Hash

Return value

object: streetName, crossingRoad

Example

// Clientside
const local = mp.players.local; 

let getStreet = mp.game.pathfind.getStreetNameAtCoord(local.position.x, local.position.y, local.position.z, 0, 0);
// Returns obj {"streetName": hash, crossingRoad: hash}

If you want the real streetname you have to use: https://wiki.rage.mp/index.php?title=Ui::getStreetNameFromHashKey

@@ Line 1: / Line 1: @@
 Determines the name of the street which is the closest to the given coordinates.<br><br>x,y,z - the coordinates of the street<br>streetName - returns a hash to the name of the street the coords are on<br>crossingRoad - if the coordinates are on an intersection, a hash to the name of the crossing road<br><br>Note: the names are returned as hashes, the strings can be returned using the function UI::GET_STREET_NAME_FROM_HASH_KEY.
 ==Syntax==
-<syntaxhighlight lang="javascript">pathfind.getStreetNameAtCoord(x, y, z, streetName, crossingRoad);</syntaxhighlight>
+<syntaxhighlight lang="javascript">mp.game.pathfind.getStreetNameAtCoord(x, y, z, streetName, crossingRoad);</syntaxhighlight>
 === Required Arguments ===
 *'''x:''' float
@@ Line 12: / Line 12: @@
 ==Example==
 <syntaxhighlight lang="javascript">
-todo
+// Clientside
+const local = mp.players.local;
+let getStreet = mp.game.pathfind.getStreetNameAtCoord(local.position.x, local.position.y, local.position.z, 0, 0);
+// Returns obj {"streetName": hash, crossingRoad: hash}
 </syntaxhighlight>
+If you want the real streetname you have to use:
+https://wiki.rage.mp/index.php?title=Ui::getStreetNameFromHashKey
 ==See also==
-{{Pathfind_function_c}}
+{{Pathfind_s_function_c}}
 [[Category:Clientside API]]
 [[Category:TODO: Example]]