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.
This function has been superseded by the
Path/Blocked event which you can connect to a
Path object. This lets you detect if the path becomes blocked at any time during its existence.
Checks if a path is blocked starting at the waypoint indicated by start. Returns the first waypoint of occlusion if blocked, -1 if not. Returns an error if start is less than 0 or greater than the number of waypoints in the