This is a yielding function. When called, it will pause the Lua thread that called the function until a result is ready to be returned, without interrupting other scripts.
For thread safety, this property is not safe to read in an unsynchronized thread.
This function computes a
Path from a start position to an end position. This function is not automatically called when a path is created and must be invoked each time the path needs to be updated.
Once the Path is computed, it will have a series of waypoints that, when followed, can lead a character along the path. These points are gathered with the
articles/Pathfinding, provides an in-depth pathfinding walkthrough
The world position where the computed path begins
The world position where the computed path finishes
Using the Pathfinding Service
The code sample below explores how to move an NPC along a more complex path or around obstacles. This is known as pathfinding.