Open Asterune
Path

Path

Computes navigation paths and exposes waypoints and obstruction events.

Behavior

Path computes navigation paths and exposes waypoints and obstruction events.

Summary

Members11
Properties3
Methods5
Events3
  • Blocked: RBXScriptSignalread only

    Fires when a waypoint on the path becomes obstructed.

  • Replanned: RBXScriptSignalread only

    Fires when a replacement route is calculated.

  • Unblocked: RBXScriptSignalread only

    Fires when a previously obstructed waypoint becomes traversable.

Properties

AutoReplan

Path.AutoReplan: boolean

Whether the path can automatically request a new route when obstructed.

Progress

Path.Progress: number

The progress of the current path calculation.

Status

Path.Status: Enum.PathStatus

The result of the latest path calculation.

Methods

CheckOcclusionAsync

Path:CheckOcclusionAsync(start: number): number

Checks the current navigation snapshot for an obstruction. The start argument is a one-based waypoint index and is clamped to at least 1. The current binding returns a zero-based obstruction index, or -1 when no obstruction is found.

Compute

Path:Compute(start: Vector3, finish: Vector3): PathRequest

Starts a path calculation and returns a PathRequest.

ComputeAsync

Path:ComputeAsync(start: Vector3, finish: Vector3): ()

Calculates a path between the supplied world-space endpoints and yields until completion.

GetWaypoints

Path:GetWaypoints(): { PathWaypoint }

Returns the waypoints from the latest path calculation.

Replan

Path:Replan(from: Vector3?): PathRequest?

Requests a new route, optionally from a new start position.

Events

Blocked

Path.Blocked: RBXScriptSignal

Fires when a waypoint on the path becomes obstructed.

Replanned

Path.Replanned: RBXScriptSignal

Fires when a replacement route is calculated.

Unblocked

Path.Unblocked: RBXScriptSignal

Fires when a previously obstructed waypoint becomes traversable.

Operators

__index · __tostring · __type

Used by

PathfindingService