Documentation

Unity Engine

User Manual

Script Reference

Unity Engine

SetPath

Define a path by its constituent points.
Read time 1 minuteLast updated 4 days ago

Definition

  • Type: Method
  • Namespace: UnityEngine
  • Assembly: UnityEngine.Physics2DModule

SetPath(int, Vector2[])

Define a path by its constituent points.
public void SetPath(int index, Vector2[] points)

Parameters

index

int
Index of the path to set.

points

Vector2[]
An ordered array of the vertices (points) that define the path.

Remarks

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 PolygonCollider2D.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.
Additional Resources: PolygonCollider2D.pathCount, PolygonCollider2D.GetPath.

SetPath(int, List<Vector2>)

Define a path by its constituent points.
public void SetPath(int index, List<Vector2> points)

Parameters

index

int
Index of the path to set.

points

List<Vector2>
An ordered list of the vertices (points) that define the path.

Remarks

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 PolygonCollider2D.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.
Additional Resources: PolygonCollider2D.pathCount, PolygonCollider2D.GetPath.