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.

WheelCollider.GetGroundHit

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

Switch to Manual
public function GetGroundHit(out hit: WheelHit): bool;
public bool GetGroundHit(out WheelHit hit);

Description

Gets ground collision data for the wheel.

If the wheel collides with something, returns true and fills the hit structure. If the wheel is not colliding, returns false and leaves hit structure unchanged.

The reported hit is always the closest one. Because the tire friction model does not automatically respond to other PhysicMaterials, any simulation of different ground materials must be done manually by adjusting forwardFriction and sidewaysFriction based on collider's material returned here.