Path

Missing API Documentation

This API Class does not have any or complete API documentation. Please add API documentation if possible.

The Path class, added in version 158, inherits from Instance.

Properties

Status: PathStatus

Read-onlyThis property is capable of being read but not written.
Not replicatedThis member is not replicated across the network boundary.

This class member is missing documentation. Create or add to its subpage at Class:Path/Status.

Category: Data.
Serialization: can save only.
Thread safety: read safe

Methods

CheckOcclusionAsync(`start`: int): int

YieldsThis function can yield the script it is used in.

Parameters
Name	Type
`start`	int

Thread safety: unsafe

ComputeAsync(`start`: Vector3, `finish`: Vector3): null

YieldsThis function can yield the script it is used in.

Parameters
Name	Type
`start`	Vector3
`finish`	Vector3

Thread safety: unsafe

GetPointCoordinates(): Array

DeprecatedThis member will be phased out and should be avoided while it is still available.

This class member is missing documentation. Create or add to its subpage at Class:Path/GetPointCoordinates.

Thread safety: unsafe

GetWaypoints(): Array

This class member is missing documentation. Create or add to its subpage at Class:Path/GetWaypoints.

Thread safety: unsafe

Events

Blocked(`blockedWaypointIdx`: int)

Parameters
Name	Type
`blockedWaypointIdx`	int

Thread safety: unsafe

Unblocked(`unblockedWaypointIdx`: int)

Parameters
Name	Type
`unblockedWaypointIdx`	int

Thread safety: unsafe

External links[]

Path in the Roblox Creator Documentation
Path in the Roblox API Reference