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

Particlefilter Module Reference

Module defined in `lua/vehicle/particlefilter.lua`. Filters collision events to determine which impacts should trigger particle effects (sparks, dust, debris). Evaluates perpendicular velocity and penetration depth thresholds to avoid spawning particles for minor or irrelevant contacts.

Module defined in lua/vehicle/particlefilter.lua. Filters collision events to determine which impacts should trigger particle effects (sparks, dust, debris). Evaluates perpendicular velocity and penetration depth thresholds to avoid spawning particles for minor or irrelevant contacts.

See Also

  • Particles: Global particle rules.
  • Fire: For fire-related particles.

State Fields

VariableDescription
particleDataTemplate table for collision packet structure.

Public API

FunctionSignatureDescription
nodeCollision(p) (**hook**)Evaluates if perpendicularVel vs depth warrants particle spawning. Called automatically by the engine for every node collision event.

Usage Example

-- This module is used automatically by the engine. You don't typically call it directly.
-- To customize particle thresholds, modify the JBeam particle definitions.
-- The collision packet `p` contains: perpendicularVel, depth, materialID, nodeId, etc.

PartCondition Module Reference

Module defined in `lua/vehicle/partCondition.lua`. Tracks the long-term health, mileage (odometer), and visual wear of every installed vehicle part. Used by the career/campaign systems to persist vehicle condition across sessions — parts degrade over time and use, affecting both gameplay (repair costs, performance) and visuals (paint wear, rust). Supports condition snapshots for save/restore.

Particles Module Reference

Module defined in `lua/common/particles.lua`. Manages the global registry of material-to-particle interaction rules. Defines which particle effects (dust, sparks, mud, snow) are spawned when specific material pairs interact during collisions, tire contact, or scraping. Shared across both GE and VE contexts.

On this page

See AlsoState FieldsPublic APIUsage Example