The density of the fluid used to calculate the buoyancy forces.
Buoyancy forces are calculated by comparing the density of the effector to the Collider2D.density of the Collider2D. If the collider is less dense than the effector then the collider will float i.e. become more buoyant. If the collider is more dense than the effector then the collider will sink i.e. become less buoyant. If the collider is equally dense as the effector then there is no buoyancy forces applied and the collider will neither float or sink.
Note that the Collider2D.density can only be set when Rigidbody2D.useAutoMass is true. This provides the ability to fine-tune the collider density versus the effector density. If this is not required then Rigidbody2D.useAutoMass can be set to false in which case the Collider2D.density is fixed at 1 therefore an effector density more than this will cause the collider to float whereas an effector density less than this will cause the collider to sink.
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.