path_get_closed

This function can be used to return whether the path is flagged as closed (true) or open (false), i.e. whether the path loops or if it has a definitive beginning and end.

The default for a newly created path is closed (true).

Syntax:

path_get_closed(index);

Returns:

Boolean

Example:

state = path_get_closed(pth_Patrol);

This will set "state" to either true or false depending on the closed state of the path indexed in "pth_Patrol".