RLS Studios
ProjectsPatreonCommunityDocsAbout
Join Patreon
BeamNG Modding Docs

Guides

Reference

server/commands - Camera & Input Commandsge_utils - Game Engine Utility Functionsmain.lua - GE Lua Entry Point & Game Loopmap.lua - Navigation Graph (AI Road Map)screenshot.lua - Screenshot Systemserver/server - Level Loading & Game ServerserverConnection - Client-Server Connection Manager`setSpawnpoint` - Default Spawn Point Persistence`simTimeAuthority` - Simulation Time & Bullet Time Control`spawn` - Vehicle Spawning & Safe Placement`suspensionFrequencyTester` - Suspension Natural Frequency Analysis
Activity ManagerAudio Bank ManagerAudio Ribbon SystemBus Route ManagerCamera SystemCore Chat (IRC)Core CheckpointsCore Command HandlerCoupler Camera ModifierDevices (RGB Peripherals)Dynamic PropsEnvironmentFlowgraph ManagerForestFun StuffGame ContextGame StateGround Marker ArrowsGround MarkersHardware InfoHighscoresHotlappingInventoryJob SystemLap TimesLevelsLoad Map CommandMetricsMod ManagerMultiseatMultiseat CameraMulti SpawnOnlinePaths (Camera Paths)Quick Access (Radial Menu)Recovery PromptRemote ControllerReplayRepositoryRope Visual TestScheme Command ServerCore SnapshotCore SoundsCore TerrainTraffic SignalsTrailer RespawnVehicle Active PoolingVehicle Bridge (GE ↔ VLua Communication)Vehicle MirrorsVehicle PaintsCore VehiclesVehicle TriggersVersion UpdateWeather SystemWindows Console

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 ReferenceGE Extensionscore

Rope Visual Test

ImGui sandbox for creating, editing, and testing rope visual simulations. Provides a full editor for rope physics parameters, animations, node interaction, performance tracking, and save/load.

ImGui sandbox for creating, editing, and testing rope visual simulations. Provides a full editor for rope physics parameters, animations, node interaction, performance tracking, and save/load.


Key Public Functions

FunctionSignatureDescription
M.onUpdate(dt)Main loop: animations, node interaction, debug drawing, ImGui UI
M.onSerialize() → tableSaves all UI state and rope parameters
M.onExtensionUnloaded()Cleans up rope data, resets state

Rope Parameters

ParameterTypeDefaultDescription
nodeCountint32Number of simulation nodes
lengthScalefloat1.0Scale factor for rope length
diameterfloat0.12Visual/collision diameter
dampingfloat0.995Velocity damping per step
bendStiffnessfloat0.6Bending resistance
totalMassfloat1.0Total rope mass in kg
massFallofffloat0.0Mass distribution falloff
iterationsint1Constraint solver iterations
gravityvec3(0, 0, -9.81)Gravity vector
youngsModulusfloat1e7Material stiffness
simFPSint60Simulation update rate

Simulation Toggles

ToggleDefaultDescription
useXPBDtrueExtended Position-Based Dynamics solver
useBendingtrueBending constraint
useWorldCollisionfalseCollision with terrain/objects
useSelfCollisionfalseSelf-intersection prevention
useStrainLimittrueMaximum stretch limit
anchorAFixedtruePin anchor A in place
anchorBFixedtruePin anchor B in place

Animation Types

IDNameDescription
0NoneStatic position
1WiggleMulti-frequency oscillation
2CircleCircular orbit
3Bumpy RideBouncing motion
4RectangleRectangular path
5Random WalkPseudo-random movement
6Sin WaveSmooth sinusoidal
7Dir SweepDirection vector rotation (anchors only)

Node Interaction

  • Hover: Mouse ray-cast detects nodes within 0.1m spheres
  • Drag: Click and drag nodes on XY plane at node's Z height
  • Colors: Fixed=red, Free=green, Calculated=blue, Hovered=yellow, Dragged=orange

Debug Visualization

SettingDescription
debugDrawStrain-colored line segments (green→red)
debugNodesMass-scaled spheres at node positions
debugDirDirection arrows at anchors
debugTextNode count, length, strain stats
debugMassMass value labels per node

Menu Operations

MenuActionDescription
RopeCreate RopeNew rope from current UI parameters
RopeFocus CameraMoves camera to frame selected rope
RopeRebuild SelectedRebuilds with current parameters
ManagementDelete SelectedRemoves selected rope
ManagementClone 10Creates 10 copies with Y offset
ManagementClear AllRemoves everything
ManagementKeep FirstDeletes all except first rope
FileSave/Load ParametersJSON file I/O for parameters

Hooks

HookPurpose
M.onExtensionLoadedInitialize ropes on module load

Usage Example

-- Load the rope sandbox
extensions.load("core_ropeVisualTest")
-- The ImGui window "Rope Visual Sandbox" appears automatically
-- Use the UI to create, configure, and animate ropes

Notes

  • Performance stats track per-rope simulation time, averages, and spike detection.
  • Clone operations offset each copy by 0.2m in Y, accumulating a 2m offset per batch.
  • Parameters can be saved/loaded via JSON files or the editor file dialog.
  • Requires ui_imgui and ffi modules.
  • This is a development/test tool, not loaded in normal gameplay.

See Also

  • metrics - Performance overlay
  • globals - debugDrawer, getCameraMouseRay

Repository

Online mod repository client. Handles mod browsing, subscribing/unsubscribing, downloading with progress, update queuing, and synchronization with BeamNG servers.

Scheme Command Server

UDP listener for `beamng:` URI scheme commands (obsolete - replaced by Windows pipe).

On this page

Key Public FunctionsRope ParametersSimulation TogglesAnimation TypesNode InteractionDebug VisualizationMenu OperationsHooksUsage ExampleNotesSee Also