path_get_name

Returns the name of a given path.

Syntax:

path_get_name(index);


Argument Description
index The index of the path to check.


Returns: String.


Description

This function will return the name of the path that is referenced as a string. The name is whatever has been used to define the path in the editor or (if the path has been created through a code function) it will return a string with the format "_newpathXX" where "XX" is the number of the path generated, starting at 0 and incrementing by one every time a new path is created. Please note that this is only a string and cannot be used to reference the path directly - for that you would need the path index. You can, however, use this string to get the path index using the returned string along with the function asset_get_index().


Example:

name = path_get_name(mypath);

This will set "name" to the name of the path indexed in the variable "mypath".


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