PathWaypoint

Not yet Datatype

A description of the steps required to reach the next waypoint in a path.

Not implemented in Nova

This datatype is not registered in Nova's Lua VM. Constructing or receiving it from an API call will not work.

Description

The PathWaypoint data type is constructed by a PathWaypointAction action, Vector3 position, and string label which is used by the PathfindingService to create points along a generated path.

Constructors

new Not yet Returns a PathWaypoint object from the given Vector3 position, PathWaypointAction action, and optional string label.

PathWaypoint.new(position: Vector3, action: PathWaypointAction, label: string)

Returns a PathWaypoint object from the given Vector3 position, PathWaypointAction action, and optional string label.

Properties

Action Not yet The action to perform at this waypoint.

PathWaypoint.Action()

The action to perform at this waypoint.

The action to perform at this waypoint as an PathWaypointAction.

Position Not yet The 3D position of this waypoint.

PathWaypoint.Position()

The 3D position of this waypoint.

Label Not yet The name of the navigation area that generates this waypoint.

PathWaypoint.Label()

The name of the navigation area that generates this waypoint. Automatic jump links have Jump as their label.

Roblox reference: PathWaypoint