Props Module Reference
Module defined in `lua/vehicle/props.lua`. Manages animated vehicle "props" (steering wheels, needles, shifters, etc.).
Module defined in lua/vehicle/props.lua. Manages animated vehicle "props" (steering wheels, needles, shifters, etc.).
See Also
- Electrics: For values that drive prop movement.
- Material: For visual materials associated with props.
How Props Work
Props are meshes defined in JBeam that react to electrical values.
func: The electrical value to track (e.g.,throttle,rpm,steering). Seeelectrics.values.multiplier,offset: Used to map the raw electrical value to rotation or translation.baseRotation,baseTranslation: Starting position of the prop.
Public API
| Function | Signature | Description |
|---|---|---|
disablePropsInDeformGroup | (deformGroup) | Hides props when their mesh group is damaged. |
hidePropsInBreakGroup | (breakGroup) | Hides props when their physical support breaks. |
init | () | Re-initializes props from JBeam data. |
reset | () | Alias for init(). |
updateGFX | () | Main frame update: syncs prop meshes with electrics.values. |
Usage Example
props.disablePropsInDeformGroup("dash_damage")props.hidePropsInBreakGroup("steering_column_break")Vehicle Property & Module Tree
Quick reference for common object hierarchies and their access paths in Vehicle Lua.
Protocols Module Reference
Module defined in `lua/vehicle/protocols.lua`. Manages external telemetry export over UDP for motion simulator platforms, external dashboards, and hardware gauges. Smooths and packages vehicle state data (position, velocity, acceleration, orientation) into standardized binary packets at configurable update rates. Supports OutGauge (dashboard telemetry) and MotionSim (motion platform) standards.