Legacy Documentation: Version 5.2
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

JointMotor

struct in UnityEngine

Suggest a change

Success!

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.

Close

Sumbission failed

For some reason your suggested change could not be submitted. Please try again in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Switch to Manual

Description

The JointMotor is used to motorize a joint.

For example the HingeJoint can be told to rotate at a given speed and force. The joint will then attempt to reach the velocity with the given maximum force.
See Also: HingeJoint.

function Start() {
	var hinge = GetComponent.<HingeJoint>();
	
	// Make the hinge motor rotate with 90 degrees per second and a strong force.
	var motor = hinge.motor;
	motor.force = 100;
	motor.targetVelocity = 90;
	motor.freeSpin = false;
	hinge.motor = motor;
}
using UnityEngine;
using System.Collections;

public class ExampleClass : MonoBehaviour { void Start() { HingeJoint hinge = GetComponent<HingeJoint>(); JointMotor motor = hinge.motor; motor.force = 100; motor.targetVelocity = 90; motor.freeSpin = false; hinge.motor = motor; } }

Variables

forceThe motor will apply a force.
freeSpinIf freeSpin is enabled the motor will only accelerate but never slow down.
targetVelocityThe motor will apply a force up to force to achieve targetVelocity.