Version: 1.3
LanguageEnglish
  • C#

Sprite.OverridePhysicsShape

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Declaration

public void OverridePhysicsShape(IList<Vector2[]> physicsShapes);

Parameters

physicsShapes A multidimensional list of points in Sprite.rect space denoting the physics shape outlines.

Description

Sets up a new Sprite physics shape.

The positions are in Sprite.rect space and this space is from Rect.zero to Rect.size. Pivot offset and transformation to unit space are done automatically. Values outside of the Rect bounds are valid and are transformed based on Sprite.rect space.

Each internal array of physics shape outlines must have more than 2 positions to be able to describe a shape.

Additional resources: Sprite.rect.