Data type
PathWaypoint
A description of the steps required to reach the next waypoint in a path.
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 1#
| new | Returns a PathWaypoint object from the given Vector3
position, PathWaypointAction action, and optional string label. |
new(position: Vector3, action: PathWaypointAction, label: string)#
Returns a PathWaypoint object from the given Vector3
position, PathWaypointAction action, and optional string label.
| 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 3#
ActionPathWaypointAction | The action to perform at this waypoint. |
PositionVector3 | The 3D position of this waypoint. |
Labelstring | The name of the navigation area that generates this waypoint. |
Action: PathWaypointAction#
The action to perform at this waypoint as an PathWaypointAction.
Position: Vector3#
The 3D position of this waypoint.
Label: string#
The name of the navigation area that generates this waypoint. Automatic
jump links have Jump as their label.