Legacy Documentation: Version 4.5.0

Script language:

  • JS
  • C#
  • Boo
Script language

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

Collision2D.relativeVelocity

var relativeVelocity: Vector2;
Vector2 relativeVelocity;
relativeVelocity as Vector2

Description

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

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

public class ExampleClass : MonoBehaviour {
    void OnCollisionEnter2D(Collision2D collision) {
        if (collision.relativeVelocity.magnitude > 2)
            audio.Play();
        
    }
}
import UnityEngine
import System.Collections

public class ExampleClass(MonoBehaviour):

	def OnCollisionEnter2D(collision as Collision2D) as void:
		if collision.relativeVelocity.magnitude > 2:
			audio.Play()