Legacy Documentation: Version 4.6(go to latest)
Language: English
  • C#
  • JS
  • Boo

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

Sumbission failed

For some reason your suggested change could not be submitted. Please try again 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);
public def GetPath(index as int) as Vector2[]

Parameters

index The 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.

Copyright © 2014 Unity Technologies
LearnCommunityAsset StoreBuyDownload