Skip to content

function getNearestWaypoint (server-side)

Available since version: 0.1.4

This function is used to retrieve the information about nearest waypoint from the specified position.

Declaration

{name, x, y, z} getNearestWaypoint(string world, int x, int y, int z, distance distance = -1)

Parameters

  • string world: the world name in which the waypoint exists.
  • int x: the position in the world on the x axis.
  • int y: the position in the world on the y axis.
  • int z: the position in the world on the z axis.
  • distance distance: search distance, by default all world waypoints will be taken into consideration, pass positive value to search only nearest waypoints inside the grid.

Returns {name, x, y, z}

Waypoint information.