Legacy Documentation: Version 5.2
LanguageEnglish
  • C#
  • JS

Script language

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

JointSpring

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

JointSpring is used add a spring force to HingeJoint and PhysicMaterial.

function Start() {
	var hinge = GetComponent.<HingeJoint>();
	
	// Make the spring reach shoot for a 70 degree angle.
	// This could be used to fire off a catapult.
	
	var spring = hinge.spring;
	spring.spring = 10;
	spring.damper = 3;
	spring.targetPosition = 70;
	hinge.spring = spring;
}
using UnityEngine;
using System.Collections;

public class ExampleClass : MonoBehaviour { void Start() { HingeJoint hinge = GetComponent<HingeJoint>(); JointSpring spring = hinge.spring; spring.spring = 10; spring.damper = 3; spring.targetPosition = 70; hinge.spring = spring; } }

Variables

damperThe damper force uses to dampen the spring.
springThe spring forces used to reach the target position.
targetPositionThe target position the joint attempts to reach.