LanguageEnglish
  • C#
  • JS

Script language

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

This version of Unity is unsupported.

CompositeCollider2D.GetPath

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

Parameters

indexThe index of the path from 0 to pathCount.
pointsAn ordered array of the vertices or points in the selected path.

Returns

int Returns the number of points placed in the points array.

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 placed into the points array.

See Also: GetPathPointCount & pathCount.