Version: 2022.1
LanguageEnglish
  • C#

PolygonCollider2D.SetPath

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

Declaration

public void SetPath(int index, Vector2[] points);

Parameters

index Index of the path to set.
points An ordered array of the vertices (points) that define the path.

Description

Define a path by its constituent points.

A path is a cyclic sequence of line segments between points that define the outline of the polygon. Because the polygon can have holes and discontinuous parts, its shape is not necessarily defined by a single path. For example, the polygon might actually be 3 separate paths. In this case SetPath will be called 3 times, with an index of 0, 1 and 2. So index specifies which of these three collections of points are used.

See Also: pathCount, GetPath.


Declaration

public void SetPath(int index, List<Vector2> points);

Parameters

index Index of the path to set.
points An ordered list of the vertices (points) that define the path.

Description

Define a path by its constituent points.

A path is a cyclic sequence of line segments between points that define the outline of the polygon. Because the polygon can have holes and discontinuous parts, its shape is not necessarily defined by a single path. For example, the polygon might actually be 3 separate paths. In this case SetPath will be called 3 times, with an index of 0, 1 and 2. So index specifies which of these three collections of points are used.

See Also: pathCount, GetPath.