path_clear_points


Description

With this function you can remove all point definitions from a path, effectively making an "empty" path. This does not delete the path, for that you should use path_delete.


Syntax:

path_clear_points(index);

Argument Description
index The index of the path to clear.


Returns:

N/A


Example:

if path_get_number(mypath) > 0
    {
    path_clear_points(mypath);
    }

The above code checks to see if there are any points on the path indexed in the variable "mypath" and if there are, it clears the path.