Source: Roblox Creator Hub · CC BY 4.0 · View source · Code samples: MIT Imported 2026-10-03. Formatting adapted for this site.
PathWaypoint
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
| Name | Type / Returns | Description |
|---|---|---|
| PathWaypoint.new | Returns a PathWaypoint object from the given Vector3 position, PathWaypointAction action, and optional string label. |
PathWaypoint.new
Returns a PathWaypoint object from the given Vector3 position, PathWaypointAction action, and optional string label.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| position | Vector3 | The 3D position of the waypoint. | |
| action | PathWaypointAction | The action to perform at the waypoint. | |
| label | string | The name of the navigation area that generates the waypoint. |
Properties
| Name | Type / Returns | Description |
|---|---|---|
| PathWaypoint.Action | PathWaypointAction | The action to perform at this waypoint. |
| PathWaypoint.Position | Vector3 | The 3D position of this waypoint. |
| PathWaypoint.Label | string | The name of the navigation area that generates this waypoint. |
PathWaypoint.Action
The action to perform at this waypoint as an PathWaypointAction.
| Field | Value |
|---|---|
| type | PathWaypointAction |
PathWaypoint.Position
The 3D position of this waypoint.
| Field | Value |
|---|---|
| type | Vector3 |
PathWaypoint.Label
The name of the navigation area that generates this waypoint. Automatic jump links have Jump as their label.
| Field | Value |
|---|---|
| type | string |