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.
CloseFor 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.
CloseThe maximum number of simulation sub-steps allowed per-frame when simulation sub-stepping is enabled.
When simulation sub-stepping is enabled with Physics2D.useSubStepping, this property is used to control the maximum number of simulation sub-steps that will occur.
When sub-stepping occurs, multiple simulation sub-steps will happen. Running too many simulation sub-steps will result in poor performance. Indeed, the reason that sub-stepping is used is because of a low frame-rate situation so care needs to be taken to ensure that the situation is not made worse by running too many simulation sub-steps.
If the required number of simulation sub-steps exceed the allowed maximum and the frame-rate cannot be divided into updates at or higher than the Physics2D.minSubStepFPS then only the maximum number of sub-steps are used. This results in time being "lost" in the simulation with the benefit that the cost of sub-stepping is restrained. The total amount of "lost" time can be read from PhysicsScene2D.subStepLostTime. The number of simulation sub-steps taken in the last simulation step can be read from PhysicsScene2D.subStepCount. The cost of this should be monitored with the Unity Profiler using the Physics 2D Module.
Additional resources: Physics2D.useSubStepping, Physics2D.minSubStepFPS, PhysicsScene2D.subStepCount and PhysicsScene2D.subStepLostTime.
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.