Vehicle Rope Debug

Reference for extensions/util/vehicleRopeDebug.lua. Provides an ImGui debug sandbox for visualizing and editing rope physics parameters on the current vehicle.

Exports

Internals

Debug Visualization

• Strain-colored segments: Lines between rope nodes colored green→red based on stretch strain.
• Node spheres: Sized by mass; colored by type (blue=anchor A, red=fixed B, green=free B, light blue=intermediate).
• Direction arrows: Shows anchor direction vectors (magenta for A, cyan for B).
• Mass labels: Optional per-node mass text display.

Node Interaction

• Hover detection: Raycasts against node spheres (0.1m radius) to find hovered nodes.
• Drag support: Click-drag nodes on XY plane at node's Z height. Updates rope anchor positions and intermediate node positions.

ImGui Window ("Rope Visual Sandbox")

Exposes all rope parameters for live editing:

• Anchors: Base position (editable) and calculated position (read-only) for A and B, plus direction vectors.
• Physics: Node count, length scale, diameter, damping, total mass, mass falloff, iterations, gravity (XYZ), Young's modulus.
• Constraints: XPBD toggle, bending (stiffness + segment length), strain limit.
• Environment: Wind scale, wind drag, simulation FPS.
• Rendering: Material name, render toggle, debug visualization toggles.
• Stats: Max/avg strain, current/rest length, sim time.

Performance Tracking

• Tracks per-rope sim times over 60-frame history.
• Computes average, max, and spike counts (>2x average).
• Displays total sim/render time as percentage of frame budget.

How It Works

1. Load via extensions.load('util_vehicleRopeDebug').
2. Automatically finds ropes on the current player vehicle via be:getPlayerVehicle(0).ropeIds.
3. Auto-selects first rope; UI parameters sync bidirectionally with the rope object.
4. Changes to physics parameters (node count, etc.) trigger rope:rebuild().
5. Debug drawing happens every frame via debugDrawer calls.

-- Load the debug UI
extensions.load('util_vehicleRopeDebug')
-- The ImGui window appears automatically with rope controls

Additional Exports

• M.onUpdate - (undocumented)

See Also

• Auto Annotation - Related reference
• Booster - Related reference
• Calibrate ESC - Related reference
• Game Engine Overview - Guide