Skip to content

function getNearestWaypoint (server-side)

Available since version: 0.3.0

Retrieve nearest waypoint for a given position.

Declaration

{name, x, y, z}|nil getNearestWaypoint(string world, number x, number y, number z, number|nil distance)

Parameters

  • string world: World name in which the waypoint exists.
  • number x: Position X.
  • number y: Position Y.
  • number z: Position Z.
  • number|nil distance: Optional maximum search distance.

Returns {name, x, y, z}|nil

Waypoint information or nil.