enumeration
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.
CloseUse ForceMode to specify how to apply a force using Rigidbody.AddForce or ArticulationBody.AddForce.
The AddForce function impacts how your GameObject moves by allowing you to define your own force vector, as well as choosing how to apply this force to the GameObject (this GameObject must have a Rigidbody component attached).
ForceMode allows you to choose from four different ways to affect the GameObject using this Force: Acceleration, Force, Impulse, and VelocityChange.
For more information on how ForceMode affects velocity, see Rigidbody.AddForce.
using UnityEngine;
public class ForceModeExample : MonoBehaviour { //Use to switch between Force Modes enum ModeSwitching { Start, Impulse, Acceleration, Force, VelocityChange }; ModeSwitching m_ModeSwitching;
Vector3 m_StartPos, m_StartForce; Vector3 m_NewForce; Rigidbody m_Rigidbody;
string m_ForceXString = string.Empty; string m_ForceYString = string.Empty;
float m_ForceX, m_ForceY; float m_Result;
void Start() { //You get the Rigidbody component you attach to the GameObject m_Rigidbody = GetComponent<Rigidbody>();
//This starts at first mode (nothing happening yet) m_ModeSwitching = ModeSwitching.Start;
//Initialising the force which is used on GameObject in various ways m_NewForce = new Vector3(-5.0f, 1.0f, 0.0f);
//Initialising floats m_ForceX = 0; m_ForceY = 0;
//The forces typed in from the text fields (the ones you can manipulate in Game view) m_ForceXString = "0"; m_ForceYString = "0";
//The GameObject's starting position and Rigidbody position m_StartPos = transform.position; m_StartForce = m_Rigidbody.transform.position; }
void FixedUpdate() { //If the current mode is not the starting mode (or the GameObject is not reset), the force can change if (m_ModeSwitching != ModeSwitching.Start) { //The force changes depending what you input into the text fields m_NewForce = new Vector3(m_ForceX, m_ForceY, 0); }
//Here, switching modes depend on button presses in the Game mode switch (m_ModeSwitching) { //This is the starting mode which resets the GameObject case ModeSwitching.Start: //This resets the GameObject and Rigidbody to their starting positions transform.position = m_StartPos; m_Rigidbody.transform.position = m_StartForce;
//This resets the velocity of the Rigidbody m_Rigidbody.velocity = new Vector3(0f, 0f, 0f); break;
//These are the modes ForceMode can force on a Rigidbody //This is Acceleration mode case ModeSwitching.Acceleration: //The function converts the text fields into floats and updates the Rigidbody’s force MakeCustomForce();
//Use Acceleration as the force on the Rigidbody m_Rigidbody.AddForce(m_NewForce, ForceMode.Acceleration); break;
//This is Force Mode, using a continuous force on the Rigidbody considering its mass case ModeSwitching.Force: //Converts the text fields into floats and updates the force applied to the Rigidbody MakeCustomForce();
//Use Force as the force on GameObject’s Rigidbody m_Rigidbody.AddForce(m_NewForce, ForceMode.Force); break;
//This is Impulse Mode, which involves using the Rigidbody’s mass to apply an instant impulse force. case ModeSwitching.Impulse: //The function converts the text fields into floats and updates the force applied to the Rigidbody MakeCustomForce();
//Use Impulse as the force on GameObject m_Rigidbody.AddForce(m_NewForce, ForceMode.Impulse); break;
//This is VelocityChange which involves ignoring the mass of the GameObject and impacting it with a sudden speed change in a direction case ModeSwitching.VelocityChange: //Converts the text fields into floats and updates the force applied to the Rigidbody MakeCustomForce();
//Make a Velocity change on the Rigidbody m_Rigidbody.AddForce(m_NewForce, ForceMode.VelocityChange); break; } }
//The function outputs buttons, text fields, and other interactable UI elements to the Scene in Game view void OnGUI() { //Getting the inputs from each text field and storing them as strings m_ForceXString = GUI.TextField(new Rect(300, 10, 200, 20), m_ForceXString, 25); m_ForceYString = GUI.TextField(new Rect(300, 30, 200, 20), m_ForceYString, 25);
//Press the button to reset the GameObject and Rigidbody if (GUI.Button(new Rect(100, 0, 150, 30), "Reset")) { //This switches to the start/reset case m_ModeSwitching = ModeSwitching.Start; }
//When you press the Acceleration button, switch to Acceleration mode if (GUI.Button(new Rect(100, 30, 150, 30), "Apply Acceleration")) { //Switch to Acceleration (apply acceleration force to GameObject) m_ModeSwitching = ModeSwitching.Acceleration; }
//If you press the Impulse button if (GUI.Button(new Rect(100, 60, 150, 30), "Apply Impulse")) { //Switch to impulse (apply impulse forces to GameObject) m_ModeSwitching = ModeSwitching.Impulse; }
//If you press the Force Button, switch to Force state if (GUI.Button(new Rect(100, 90, 150, 30), "Apply Force")) { //Switch to Force (apply force to GameObject) m_ModeSwitching = ModeSwitching.Force; }
//Press the button to switch to VelocityChange state if (GUI.Button(new Rect(100, 120, 150, 30), "Apply Velocity Change")) { //Switch to velocity changing m_ModeSwitching = ModeSwitching.VelocityChange; } }
//Changing strings to floats for the forces float ConvertToFloat(string Name) { float.TryParse(Name, out m_Result); return m_Result; }
//Set the converted float from the text fields as the forces to apply to the Rigidbody void MakeCustomForce() { //This converts the strings to floats m_ForceX = ConvertToFloat(m_ForceXString); m_ForceY = ConvertToFloat(m_ForceYString); } }
Force | Add a continuous force to the rigidbody, using its mass. |
Acceleration | Add a continuous acceleration to the rigidbody, ignoring its mass. |
Impulse | Add an instant force impulse to the rigidbody, using its mass. |
VelocityChange | Add an instant velocity change to the rigidbody, ignoring its mass. |
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.
When you visit any website, it may store or retrieve information on your browser, mostly in the form of cookies. This information might be about you, your preferences or your device and is mostly used to make the site work as you expect it to. The information does not usually directly identify you, but it can give you a more personalized web experience. Because we respect your right to privacy, you can choose not to allow some types of cookies. Click on the different category headings to find out more and change our default settings. However, blocking some types of cookies may impact your experience of the site and the services we are able to offer.
More information
These cookies enable the website to provide enhanced functionality and personalisation. They may be set by us or by third party providers whose services we have added to our pages. If you do not allow these cookies then some or all of these services may not function properly.
These cookies allow us to count visits and traffic sources so we can measure and improve the performance of our site. They help us to know which pages are the most and least popular and see how visitors move around the site. All information these cookies collect is aggregated and therefore anonymous. If you do not allow these cookies we will not know when you have visited our site, and will not be able to monitor its performance.
These cookies may be set through our site by our advertising partners. They may be used by those companies to build a profile of your interests and show you relevant adverts on other sites. They do not store directly personal information, but are based on uniquely identifying your browser and internet device. If you do not allow these cookies, you will experience less targeted advertising. Some 3rd party video providers do not allow video views without targeting cookies. If you are experiencing difficulty viewing a video, you will need to set your cookie preferences for targeting to yes if you wish to view videos from these providers. Unity does not control this.
These cookies are necessary for the website to function and cannot be switched off in our systems. They are usually only set in response to actions made by you which amount to a request for services, such as setting your privacy preferences, logging in or filling in forms. You can set your browser to block or alert you about these cookies, but some parts of the site will not then work. These cookies do not store any personally identifiable information.