getPositionBySideOfRoad
GET_POSITION_BY_SIDE_OF_ROAD0x16F46FB18C8009E4The GTA V native GET_POSITION_BY_SIDE_OF_ROAD of the PATHFIND namespace, as LS:MP client scripts call it: the global function getPositionBySideOfRoad, in JavaScript and in Lua.
getPositionBySideOfRoad(x: number, y: number, z: number, p3: number): [
ok: boolean,
outPosition: { x: number, y: number, z: number }
]getPositionBySideOfRoad(
x: number,
y: number,
z: number,
p3: integer
): boolean, Vector3Usage
JavaScript
const [ok, outPosition] = getPositionBySideOfRoad(x, y, z, p3);Lua
local ok, outPosition = getPositionBySideOfRoad(x, y, z, p3)Three consecutive numbers can be given as one vector: { x, y, z } (or [x, y, z]) in JavaScript, a Vector3 in Lua.
JavaScript · with vectors
const [ok, outPosition] = getPositionBySideOfRoad(pos, p3);Lua · with vectors
local ok, outPosition = getPositionBySideOfRoad(pos, p3)Parameters
| Parameter | Type | JavaScript | Lua |
|---|---|---|---|
x | float | number | number |
y | float | number | number |
z | float | number | number |
p3 | int | number | integer |
Returns
2 values, in this order: an array in JavaScript, multiple return values in Lua.
| # | Value | Type | JavaScript | Lua | Description |
|---|---|---|---|---|---|
| 1 | ok | BOOL | boolean | boolean | The native’s own return value. |
| 2 | outPosition | Vector3 | { x: number, y: number, z: number } | Vector3 | output |
Reference
- Namespace
- Pathfinding PATHFIND
- In the game
BOOL GET_POSITION_BY_SIDE_OF_ROAD(float x, float y, float z, int p3, Vector3* outPosition)- Hash
0x16F46FB18C8009E4- Formerly
_GET_POINT_ON_ROAD_SIDE