Events Reference

Module defined in lua/common/jbeam/sections/events.lua. Processes event definitions and physics triggers from JBeam data, creating trigger objects on the vehicle's C++ object.

---

Exports

Functions

M.process(objID, vehicleObj, vehicle)

Processes three sub-sections: events (cleans up rows), triggers (creates C++ trigger objects with node references, dimensions, and event bindings), and triggerEventLinks (wires triggers to events with Lua command callbacks).

• Parameters:
  • objID - number - Vehicle object ID
  • vehicleObj - userdata - C++ vehicle object
  • vehicle - table - Assembled vehicle data with events, triggers, triggerEventLinks sections
• Returns: self (module table, for chaining)

Internal Notes

• Trigger creation via vehicleObj:addTrigger() returns a trigger ID that must match the CID.
• Trigger properties set via C++ API: position (setPosition), dimensions (setDimensions), rotation (setRotation), type, debug color, action mode.
• Trigger-event linking creates Lua command strings for onBeamNGTrigger callbacks.
• Row cleanup removes leaked properties: nodeOffset, skinName.
• Trigger node references (bottomNode, topNode, etc.) are resolved to CIDs.