Documentation

Unity Engine

User Manual

Script Reference

Unity Engine

AddRelativeForce

Adds a force to the rigidbody relative to its coordinate system.
Read time 1 minuteLast updated 4 days ago

Definition

  • Type: Method
  • Namespace: UnityEngine
  • Assembly: UnityEngine.PhysicsModule

AddRelativeForce(Vector3, ForceMode)

Adds a force to the rigidbody relative to its coordinate system.
public void AddRelativeForce(Vector3 force, ForceMode mode)

Parameters

force

Vector3
Force vector in local coordinates.

mode

ForceMode

Remarks

Force can be applied only to an active rigidbody. If a GameObject is inactive, AddRelativeForce has no effect.
Wakes up the Rigidbody by default. If the force size is zero then the Rigidbody will not be woken up.
For more information on how ForceMode affects velocity, see Rigidbody.AddForce.
Additional Resources: Rigidbody.AddForce, Rigidbody.AddForceAtPosition, Rigidbody.AddRelativeTorque

Examples

using UnityEngine;using System.Collections; // Add a thrust force to push an object in its current forward // direction (to simulate a rocket motor, say).public class ExampleClass : MonoBehaviour{    public float thrust;    public Rigidbody rb;    void Start()    {        rb = GetComponent<Rigidbody>();    }    void FixedUpdate()    {        rb.AddRelativeForce(Vector3.forward * thrust);    }}

AddRelativeForce(float, float, float, ForceMode)

Adds a force to the rigidbody relative to its coordinate system.
public void AddRelativeForce(float x, float y, float z, ForceMode mode)

Parameters

x

float
Size of force along the local x-axis.

y

float
Size of force along the local y-axis.

z

float
Size of force along the local z-axis.

mode

ForceMode

Remarks

Force can be applied only to an active rigidbody. If a GameObject is inactive, AddRelativeForce has no effect.
Wakes up the Rigidbody by default. If the force size is zero then the Rigidbody will not be woken up.