RLS Studios
ProjectsPatreonCommunityDocsAbout
Join Patreon
BeamNG Modding Docs

Guides

Reference

AI Module ReferenceBackwards Compatibility Module ReferenceBdebug Module ReferenceBdebugImpl Module ReferenceBeamstate Module ReferenceBullettime Module ReferenceController Module ReferenceDamageTracker Module ReferenceDrivetrain Module ReferenceElectrics Module ReferenceElectrics Custom Value ParserEnergyStorage Module ReferenceExtensions Module ReferenceFire Module ReferenceVehicle Engine True GlobalsGuihooks Module ReferenceGUI Streams Module ReferenceHTML Texture Module ReferenceHydros Module ReferenceInput Module ReferenceJBeam-Lua Integration GuideMapmgr Module ReferenceMaterial Module ReferenceBeamNG Math & Unit Conversions Referenceobj (Vehicle C++ Object)PartCondition Module ReferenceParticlefilter Module ReferenceParticles Module ReferencePowertrain Module ReferenceVehicle Property & Module TreeProps Module ReferenceProtocols Module ReferenceRecovery Module ReferenceScriptAI Module ReferenceSensors Module ReferenceSounds Module ReferenceStreams Module ReferenceThrusters Module Reference`v` (Vehicle Data & JBeam)Wheels Module Reference

UI

Resources

BeamNG Game Engine Lua Cheat SheetGE Developer RecipesMCP Server Setup

// RLS.STUDIOS=true

Premium Mods for BeamNG.drive. Career systems, custom vehicles, and immersive gameplay experiences.

Index

HomeProjectsPatreon

Socials

DiscordPatreon (RLS)Patreon (Vehicles)

© 2026 RLS Studios. All rights reserved.

Modding since 2024

API Referenceve

Streams Module Reference

Module defined in `lua/vehicle/guistreams.lua`. Manages the subscription-based data streaming system that feeds real-time vehicle telemetry to UI apps. When a UI app registers interest in a data category (e.g., engine data, wheel thermals), this module evaluates the corresponding handler each frame and sends results via `guihooks`. Prevents wasted computation by only evaluating streams that have active subscribers.

Module defined in lua/vehicle/guistreams.lua. Manages the subscription-based data streaming system that feeds real-time vehicle telemetry to UI apps. When a UI app registers interest in a data category (e.g., engine data, wheel thermals), this module evaluates the corresponding handler each frame and sends results via guihooks. Prevents wasted computation by only evaluating streams that have active subscribers.

See Also

  • Guihooks: For general UI events.
  • Communication: For UI data flow overview.

Public API

FunctionSignatureDescription
drawGraph(k, val) (**callable**)Plotting interface for UI graph app.
hasActiveStreams() (**callable**)True if UI is requesting data.
reset() (**hook**)Clears stream registration.
setRequiredStreams(state) (**callable**)Bulk updates the active stream registry from the UI.
update() (**hook**)Evaluates all active stream handlers.
willSend(streamName) (**callable**)Checks if a specific data key is being requested by an app. Returns boolean.

Usage Example

-- Check if a UI app is listening before computing expensive data
if streams.willSend("wheelThermals") then
  -- Only compute thermal data if an app actually wants it
  guihooks.queueStream("wheelThermals", computeWheelThermals())
end

Sounds Module Reference

Module defined in `lua/vehicle/sounds.lua`. This module interfaces with the game's audio engine to handle impacts, scrapes, wind, tires, and the JBeam soundscape. It also provides a wrapper for manage

Thrusters Module Reference

Module defined in `lua/vehicle/thrusters.lua`. This module manages the application of continuous forces (thrusters) and temporary impulses to the vehicle structure. It supports both JBeam-defined thru

On this page

See AlsoPublic APIUsage Example