Path

Path is one of the basic elements in a project, consisting of multiple point links that can be used as unit movement routes.

Functions

Get path by scene ID.

Variable	Type	Description
`scene_id`	number	ID in the edit scene.

Type	Description
Path	Path of the path.

cli.get_path_by_scene_id(scene_id)

Create paths from py objects.

Variable	Type	Description
`py_path`	table	Py layer object.

Type	Description
Path	Path of the Path.

path.get_lua_path_from_py(py_path)

Whether the path has a tag or not.

Variable	Type	Description
`tag`	string	Tag.

Type	Description
boolean	Whether the path has tag.

path:has_tag(tag)

Remove path.

path:remove_path()

Add a point to a path.

Variable	Type	Description
`index`	number	Serial number.
`point`	point	Point.

path:add_point(index, point)

Remove a point from a path.

Variable	Type	Description
`index`	number	Serial number.

path:remove_point(index)

Adds a tag to a path.

Variable	Type	Description
`tag`	string	Serial number.

path:add_tag(tag)

Remove a tag from a path.

Variable	Type	Description
`tag`	string	Serial number.

path:remove_tag(tag)

Get the number of points in the path.

path:get_point_count()

Create a path starting with a point.

Variable	Type	Description
`start_point`	point	Starting point.

Type	Description
path	Path to create.

path.create_path(start_point)