Version: 2018.1 (switch to 2018.2b or 2017.4)
LanguageEnglish
  • C#
  • JS

Script language

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

Rigidbody2D.useAutoMass

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

Switch to Manual
public var useAutoMass: bool;
public bool useAutoMass;

Description

Should the total rigid-body mass be automatically calculated from the [[Collider2D.density]] of attached colliders?

When false, the explicitly set mass is used for the rigid-body mass. When true, the mass is automatically calculated from all attached Collider2D as a product of their [[Collider2D.density]] and area.

When true, inside the Unity editor, the [[Collider2D.density]] property will appear on any attached Collider2D and the mass property will become read-only.

When false, the mass property can be written to and the [[Collider2D.density]] property is not shown.

See Also: mass, ::Collider2D.density.

Did you find this page useful? Please give it a rating: