path_get_point_speed

Returns the speed setting of a given path's given defining point.

Syntax:

path_get_point_speed(index, n);


Argument Description
index The index of the path to check.
n The point identity to check.


Returns: Real.


Description

With this function you can get the speed of the point (as defined in the Path Editor or when you dynamically add a path point using path_add_point()) expressed as a percentage. So, if you have a path point set to 50 in the path editor, this function would return 50 when used.


Example:

if path_get_point_speed(c_path, 0) != 100
   {
   path_change_point(c_path, 0, path_get_point_x(c_path, 0), path_get_point_x(c_path, 0), 100);
   }

the above code checks the path point "0" of the path indexed by "c_path" to see if the speed is not equal to 100. If it is not then it sets the speed of that point to 100.


Back: Path Information
Next: path_get_point_x
© Copyright YoYo Games Ltd. 2019 All Rights Reserved