The total amount of force that has been explicitly applied to this Rigidbody2D since the last physics simulation step.
When adding force to the Rigidbody2D using Rigidbody2D.AddForce, Rigidbody2D.AddForceAtPosition or Rigidbody2D.AddRelativeForce the force total is summed. This only applies when using ForceMode2D.Force and not when using ForceMode2D.Impulse.
During the next simulation step, the total force will be time-integrated into the Rigidbody2D.velocity then automatically reset to zero.
NOTE: Only a Rigidbody2D with a Dynamic Body Type will respond to force or torque. Setting this property on a Kinematic Body Type or Static Body Type will have no effect.
using UnityEngine; using UnityEngine.Assertions;
public class Example : MonoBehaviour { void Start() { // Fetch the rigidbody. var body = GetComponent<Rigidbody2D>();
// Make the assumption the body has no previous force applied. Assert.AreEqual(Vector2.zero, body.totalForce);
// Initialize a force. var force = new Vector2(3f, 2f);
// Add the force. body.AddForce(force);
// The total force should be what we just added. Assert.AreEqual(force, body.totalForce);
// Add the same force again. body.AddForce(force);
// The total force should still be what we've added. Assert.AreEqual(force * 2f, body.totalForce);
// We can reset any force that has been applied since the last simulation step. body.totalForce = Vector2.zero; } }
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.