Legacy Documentation: Version 4.5.0

Script language:

  • JS
  • C#
  • Boo
Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

GetPath(index: int): Vector2[];
Vector2[] GetPath(int index);
def GetPath(index as int) as Vector2[]

Parameters

indexThe index of the path to retrieve.

Description

Get a path from the polygon by its index.

A path is cyclic sequence of line segments between points that define the outline of the polygon. Since the polygon can have holes and discontinuous parts, its shape is not necessarily defined by a single path.

The returned value is an ordered array of the points in the path.

See Also: pathCount, SetPath.