Legacy Documentation: Version 2018.1 (Go to current version)
LanguageEnglish
  • C#
  • JS

Script language

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

Physics2D.Distance

public static ColliderDistance2D Distance(Collider2D colliderA, Collider2D colliderB);

Parameters

colliderAA collider used to calculate the minimum distance against colliderB.
colliderBA collider used to calculate the minimum distance against colliderA.

Returns

ColliderDistance2D The minimum distance between colliderA and colliderB.

Description

Calculates the minimum distance between two colliders.

A valid colliderA and colliderB must be provided for the returned ColliderDistance2D to be valid i.e. both colliderA or colliderB should not be NULL, should not be disabled and must contain collision shapes. You can check if the returned value is valid by checking ColliderDistance2D.isValid.

See Also: Collider2D.Distance and Rigidbody2D.Distance.

Did you find this page useful? Please give it a rating: