RLS Studios
ProjectsPatreonCommunityDocsAbout
Join Patreon
BeamNG Modding Docs

Guides

Reference

`be` - BeamNG Engine BindingGlobal Utility Functions CatalogGE Global Objects & FunctionsGE Object Path LookupSceneTree - Scene Graph Queries

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 Referenceglobals

GE Object Path Lookup

Quick lookup reference for BeamNG Game Engine (GE) object paths and extension names.

Quick lookup reference for BeamNG Game Engine (GE) object paths and extension names.


Path Naming Convention

Extensions follow a consistent naming pattern based on their file path:

File PathExtension NameGlobal Variable
lua/ge/extensions/myMod.luamyModmyMod
lua/ge/extensions/gameplay/taxi.luagameplay_taxigameplay_taxi
lua/ge/extensions/career/modules/inventory.luacareer_modules_inventorycareer_modules_inventory
lua/ge/extensions/core/camera.luacore_cameracore_camera

Core Extensions (extensions.core_*)

Camera System

PathExtensionPurpose
core/cameracore_cameraCamera manager and mode switching
core/cameraModes/chasecore_cameraModes_chaseChase camera mode
core/cameraModes/orbitcore_cameraModes_orbitOrbit/free camera mode
core/cameraModes/drivercore_cameraModes_driverDriver/cockpit view
core/cameraModes/bigMapcore_cameraModes_bigMapBig map overview camera
core/cameraModes/onboardcore_cameraModes_onboardOnboard camera
core/cameraModes/pathcore_cameraModes_pathPath-following camera
core/cameraModes/relativecore_cameraModes_relativeRelative/physics camera
core/cameraModes/topDowncore_cameraModes_topDownTop-down view
core/cameraModes/trackircore_cameraModes_trackirTrackIR head tracking

Input System

PathExtensionPurpose
core/input/actionscore_input_actionsInput action definitions
core/input/bindingscore_input_bindingsKey/button bindings
core/input/categoriescore_input_categoriesInput category groups
core/input/actionFiltercore_input_actionFilterAction blocking/filtering
core/input/virtualInputcore_input_virtualInputVirtual/controller input
core/input/vehicleSwitchingcore_input_vehicleSwitchingVehicle switch handling

Settings System

PathExtensionPurpose
core/settings/settingscore_settings_settingsBase settings system (aliased as settings global)
core/settings/graphiccore_settings_graphicGraphics settings
core/settings/audiocore_settings_audioAudio settings
core/settings/shadowsQualitycore_settings_shadowsQualityShadow quality
core/settings/textureQualitycore_settings_textureQualityTexture quality
core/settings/meshQualitycore_settings_meshQualityMesh/geometry quality
core/settings/shaderQualitycore_settings_shaderQualityShader quality
core/settings/lightingQualitycore_settings_lightingQualityLighting quality
core/settings/rallycore_settings_rallyRally-specific settings

Vehicle Management

PathExtensionPurpose
core/vehicle/managercore_vehicle_managerVehicle spawn/lifecycle
core/vehiclescore_vehiclesVehicle pool operations
core/vehicleBridgecore_vehicleBridgeGE↔VE communication bridge
core/vehicleActivePoolingcore_vehicleActivePoolingVehicle pooling optimization
core/multiSpawncore_multiSpawnMultiple vehicle spawning
core/multiseatcore_multiseatMulti-seat/multiplayer support

Environment & World

PathExtensionPurpose
core/environmentcore_environmentTime, weather, environment
core/weathercore_weatherWeather system
core/terraincore_terrainTerrain operations
core/forestcore_forestForest/vegetation
core/levelscore_levelsLevel loading/management
core/loadMapCmdcore_loadMapCmdMap load command

Game State & Systems

PathExtensionPurpose
core/gamestatecore_gamestateGame state machine
core/gameContextcore_gameContextContext management
core/activitycore_activityActivity tracking
core/replaycore_replayReplay system
core/snapshotcore_snapshotSave state snapshots
core/metricscore_metricsPerformance metrics
core/modmanagercore_modmanagerMod management
core/onlinecore_onlineOnline services

Navigation & Markers

PathExtensionPurpose
core/groundMarkerscore_groundMarkersGround navigation arrows
core/groundMarkerArrowscore_groundMarkerArrowsArrow visualization
core/checkpointscore_checkpointsRace checkpoints
core/pathscore_pathsPath finding

Audio & FX

PathExtensionPurpose
core/audiocore_audioAudio system
core/soundscore_soundsSound management
core/audioRibboncore_audioRibbonAudio visualization

Utilities

PathExtensionPurpose
core/jobsystemcore_jobsystemAsync job system
core/quickAccesscore_quickAccessQuick access menu
core/commandhandlercore_commandhandlerConsole commands
core/recoveryPromptcore_recoveryPromptRecovery UI prompt
core/highscorescore_highscoresHigh score tracking
core/lapTimescore_lapTimesLap time recording
core/hotlappingcore_hotlappingHotlap mode
core/devicescore_devicesInput device handling

Career System (career.*, career.modules.*)

Core Career

PathExtensionPurpose
career/careercareer_careerCareer lifecycle, activation
career/saveSystemcareer_saveSystemSave/load, autosave

Player Progression

PathExtensionPurpose
career/modules/playerAttributescareer_modules_playerAttributesMoney, XP, stats
career/modules/logbookcareer_modules_logbookActivity log
career/branchescareer_branchesBranch definitions

Economy & Transactions

PathExtensionPurpose
career/modules/paymentcareer_modules_paymentTransaction processing

Vehicle Management

PathExtensionPurpose
career/modules/inventorycareer_modules_inventoryVehicle ownership

Reputation & Organizations

PathExtensionPurpose
career/modules/reputationcareer_modules_reputationOrganization reputation

Gameplay Systems (gameplay.*, gameplay.missions.*)

Mission System

PathExtensionPurpose
gameplay/missions/missionsgameplay_missions_missionsMission registry
gameplay/missions/missionManagergameplay_missions_missionManagerActive mission lifecycle
gameplay/missions/progressgameplay_missions_progressProgress tracking
gameplay/missions/unlocksgameplay_missions_unlocksMission unlocks
gameplay/missions/missionScreengameplay_missions_missionScreenMission UI

Racing Modes

PathExtensionPurpose

World Systems

PathExtensionPurpose
gameplay/trafficgameplay_trafficAI traffic
gameplay/speedTrapsgameplay_speedTrapsSpeed cameras

Freeroam Systems (freeroam.*)

PathExtensionPurpose
freeroam/facilitiesfreeroam_facilitiesGarages, shops, dealers
freeroam/organizationsfreeroam_organizationsDelivery orgs
freeroam/gasStationsfreeroam_gasStationsFuel stations
freeroam/bigMapModefreeroam_bigMapModeBig map mode
freeroam/bigMapMarkersfreeroam_bigMapMarkersBig map markers
freeroam/bigMapPoiProviderfreeroam_bigMapPoiProviderBig map POI data

Global Engine Objects

Always-available globals in GE context:

VariableTypePurposeDoc
beEngineCore engine, vehicles, physicsbe.md
scenetreeEngineScene graph queriesscenetree.md
mapModuleLevel data, road networkmap.md
extensionsModuleExtension loading/hooksextensions.md
guihooksModuleUI communicationguihooks.md

Quick Reference: Common Access Patterns

Check if extension loaded

if extensions.isExtensionLoaded('career_career') and career_career.isActive() then
    -- Career-only logic
end

Access career attributes

local money = career_modules_playerAttributes.getAttributeValue("money")
local xp = career_modules_playerAttributes.getAttributeValue("beamXP")

Get current vehicle

local veh = be:getPlayerVehicle(0)
local vehId = be:getPlayerVehicleID(0)

Camera control

core_camera.setByName('orbit')           -- Switch camera mode
core_camera.setByName('driver')          -- Cockpit view
core_camera.setByName('chase')           -- Chase cam

Ground markers

core_groundMarkers.setFocus(targetPos)   -- Set navigation target
core_groundMarkers.clear()               -- Clear markers

Settings access

local val = settings.getValue('graphicMode')
settings.setValue('graphicMode', 'High')

Extension Loading

-- Load an extension
extensions.load('gameplay_missions_missions')
extensions.load('career_modules_inventory')

-- Reload (hot-reload during development)
extensions.reload('myExtension')

-- Unload
extensions.unload('gameplay_taxi')

See Also

  • Globals - Complete global objects reference
  • Extensions - Extension system documentation
  • be.md - Engine binding reference
  • scenetree.md - Scene graph queries
  • Career Overview - Career system details
  • Missions - Mission system details

GE Global Objects & Functions

Complete reference for global variables, objects, and functions available in the BeamNG Game Engine (GE) Lua context.

SceneTree - Scene Graph Queries

Reference for `scenetree`, the scene graph interface for finding and manipulating engine objects (vehicles, lights, sound emitters, terrain, GUI elements, etc.).

On this page

Path Naming ConventionCore Extensions (extensions.core_*)Camera SystemInput SystemSettings SystemVehicle ManagementEnvironment & WorldGame State & SystemsNavigation & MarkersAudio & FXUtilitiesCareer System (career.*, career.modules.*)Core CareerPlayer ProgressionEconomy & TransactionsVehicle ManagementReputation & OrganizationsGameplay Systems (gameplay.*, gameplay.missions.*)Mission SystemRacing ModesWorld SystemsFreeroam Systems (freeroam.*)Global Engine ObjectsQuick Reference: Common Access PatternsCheck if extension loadedAccess career attributesGet current vehicleCamera controlGround markersSettings accessExtension LoadingSee Also