Version: 5.6 (switch to 2017.1b)
LanguageEnglish
  • C#
  • JS

Script language

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

Collision2D.relativeVelocity

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

Submission failed

For 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.

Close

Cancel

public var relativeVelocity: Vector2;
public Vector2 relativeVelocity;

Description

The relative linear velocity of the two colliding objects (Read Only).

#pragma strict

// Play a sound when we hit an object with a big velocity var audio: AudioSource; function Start() {

audio = GetComponent.<AudioSource>(); }

function OnCollisionEnter2D(collision: Collision2D) {

if (collision.relativeVelocity.magnitude > 2) audio.Play(); }
// Play a sound when we hit an object with a big velocity
using UnityEngine;
using System.Collections;

public class ExampleClass : MonoBehaviour { AudioSource audio;

void Start() { audio = GetComponent<AudioSource>(); }

void OnCollisionEnter2D(Collision2D collision) { if (collision.relativeVelocity.magnitude > 2) audio.Play(); } }