GetPath
Gets a path from the Collider by its index.
Read time 2 minutesLast updated 5 days ago
Definition
- Type: Method
- Namespace: UnityEngine
- Assembly: UnityEngine.Physics2DModule
GetPath(int)
Gets a path from the Collider by its index.
public Vector2[] GetPath(int index)
Parameters
The index of the path to retrieve.
Returns
Type | Description |
|---|---|
| Vector2[] | An ordered array of the vertices (points) in the selected path. |
Remarks
A path is a cyclic sequence of line segments between points that define the outline of the Collider. Because 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 in the path.
Additional Resources: PolygonCollider2D.pathCount, PolygonCollider2D.SetPath.
GetPath(int, List<Vector2>)
Gets a path from the Collider by its index.
public int GetPath(int index, List<Vector2> points)
Parameters
The index of the path to retrieve.
An ordered list of the vertices (points) in the selected path.
Returns
Type | Description |
|---|---|
| int | Returns the number of results placed in the |
Remarks
A path is a cyclic sequence of line segments between points that define the outline of the Collider. Because the Collider can have holes and discontinuous parts, its shape is not necessarily defined by a single path.
Returns an ordered list of the points in the path.
The integer return value is the number of results written into the list. The points list will be resized if it doesn't contain enough elements to report all the points.This prevents memory from being allocated for results when the list does not need to be resized, and improves garbage collection performance when the query is performed frequently.
pointspointsAdditional Resources: PolygonCollider2D.pathCount, PolygonCollider2D.SetPath.
GetPath(int, Allocator)
Gets a path from the Collider by its index.
public NativeArray<Vector2> GetPath(int index = 0, Allocator allocator = Allocator.Temp)
Parameters
Returns
Type | Description |
|---|---|
| NativeArray<Vector2> | The NativeArray that contains an ordered list of the vertices (points) in the selected path. This must be disposed of unless it contains no results. |
Remarks
A path is a cyclic sequence of line segments between points that define the outline of the Collider. Because the Collider can have holes and discontinuous parts, its shape is not necessarily defined by a single path.
Returns an ordered list of the points in the path.
Additional Resources: PolygonCollider2D.pathCount, PolygonCollider2D.SetPath.