Ground Contact

Reference for gameplay_util_groundContact, a simple utility that checks whether a vehicle is resting on its wheels (right-side-up and touching the ground).

Module Exports (M)

Internals

Detection Method

1. Gets the vehicle's oriented bounding box (OOBB) center position
2. Adjusts Z position to the bottom of the bounding box + 0.3m offset
3. Casts a static ray downward (1.5m max length)
4. Returns true if the ray hits within 1.1m

Constants

Requirements

• Requires map.objects[vehId] to exist (vehicle must be in the map system)
• Uses castRayStatic for ground detection (only checks static geometry, not other vehicles)

How It Works

The function checks if the bottom of the vehicle's bounding box is close to static ground geometry. The 0.3m offset from the OOBB bottom accounts for wheel/suspension travel. If the downward raycast hits within 1.1m, the vehicle is considered to be resting on its wheels.

This is a simple check - it doesn't verify individual wheel contact or distinguish between being on wheels vs being on the roof near the ground.

Usage Example

-- Check if player vehicle is on its wheels
local vehId = be:getPlayerVehicleID(0)
if gameplay_util_groundContact.isOnWheels(vehId) then
  log("I", "", "Vehicle is on its wheels")
else
  log("I", "", "Vehicle is flipped or airborne")
end

See Also

• gameplay/util/crashDetection - Vehicle Crash Detection System - Related reference
• gameplay/util/damageAssessment - Vehicle Damage Location Assessment - Related reference
• gameplay/util/sortedList - Sorted Object List Container - Related reference
• Gameplay Systems Guide - Guide