Pathfind::getStreetNameAtCoord: Difference between revisions
(yay) |
m (→Example) |
||
| Line 12: | Line 12: | ||
==Example== | ==Example== | ||
<syntaxhighlight lang="javascript"> | <syntaxhighlight lang="javascript"> | ||
// | // Clientside | ||
const localPlayer = mp.players.local; | |||
let getStreet = mp.game.pathfind.getStreetNameAtCoord(localPlayer.position.x, localPlayer.position.y, localPlayer.position.z, 0, 0); | |||
// Returns hashes of the streetname of the position from the local player | |||
</syntaxhighlight> | </syntaxhighlight> | ||
==See also== | ==See also== | ||
{{Pathfind_s_function_c}} | {{Pathfind_s_function_c}} | ||
[[Category:Clientside API]] | [[Category:Clientside API]] | ||
[[Category:TODO: Example]] | [[Category:TODO: Example]] | ||
Revision as of 08:15, 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 localPlayer = mp.players.local;
let getStreet = mp.game.pathfind.getStreetNameAtCoord(localPlayer.position.x, localPlayer.position.y, localPlayer.position.z, 0, 0);
// Returns hashes of the streetname of the position from the local player