Legacy Documentation: Version 2018.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.SetPath

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

Parameters

indexIndex of the path to set.
pointsPoints 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. Since 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.

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