Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


GetPhysicsShape(int, List<Vector2>)

Gets a physics shape from the Sprite by its index.
Read time 1 minuteLast updated 7 days ago

Definition

  • Type: Method
  • Namespace: UnityEngine
  • Assembly: UnityEngine.CoreModule
public int GetPhysicsShape(int shapeIdx, List<Vector2> physicsShape)

Parameters

shapeIdx

The index of the physics shape to retrieve.

physicsShape

An ordered list of the points in the selected physics shape to store points in.

Returns

Type

Description

intThe number of points stored in the given list.

Remarks

A physics shape is a cyclic sequence of line segments between points that define the outline of the Sprite used for physics. Since the Sprite can have holes and discontinuous parts, its outline is not necessarily defined by a single physics shape.