Legacy Documentation: Version 2017.1 (Go to current version)
LanguageEnglish
  • C#
  • JS

Script language

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

PolygonCollider2D.GetPath

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Switch to Manual
public function GetPath(index: int): Vector2[];
public Vector2[] GetPath(int index);

Parameters

index The index of the path to retrieve.

Returns

Vector2[] An ordered array of the vertices or points in the selected path.

Description

Gets a path from the Collider by its index.

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

Returns an ordered array of the points in the path.

See Also: pathCount, SetPath.

Did you find this page useful? Please give it a rating: