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
Career BranchesCareer System CoreCareer Save System
Career Computer MenuCareer Fuel SystemInspect VehicleVehicle InventoryLinear TutorialLoaner VehiclesCareer LogLogbookMarketplaceMission WrapperCareer Painting ModuleCareer Part Inventory ModuleCareer Part Shopping ModuleCareer Payment ModuleCareer Permissions ModuleCareer Playbook Writer ModuleCareer Player Abstract ModuleCareer Player Attributes ModuleCareer Player Driving ModuleCareer Quick Travel ModuleCareer Rentals ModuleCareer Reputation ModuleCareer Spawn Points ModuleCareer Speed Traps ModuleCareer Test Drive ModuleCareer Tether ModuleCareer Tuning ModuleCareer UI Utils ModuleCareer Unlock Flags ModuleCareer Value Calculator ModuleVehicle Class GroupingVehicle Deletion ServiceVehicle PerformanceVehicle Shopping

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 Extensionscareermodules

Linear Tutorial

M.dependencies = {'career_career'}

Dependencies

M.dependencies = {'career_career'}

Manages the career tutorial system including linear step-based tutorial progression, intro popup splashscreens, tutorial flags, and flowgraph-driven tutorial sequences.


Internal State

FieldTypeDescription
M.allTutorialFlagsvariesAssigned as {insuranceFlag, bigmapFlag, refuelFlag, missionFlag, dealershipFlag, inventor...
M.bounceBigmapIconsvariesAssigned as false
M.tutorialEnabledvariesAssigned as -1

Public API - Tutorial State

FunctionSignatureDescription
M.getLinearStep() → numberCurrent linear tutorial step (-1 = complete)
M.isLinearTutorialActive() → boolWhether linear tutorial steps are in progress
M.getTutorialFlag(key) → boolGet named tutorial flag state
M.setTutorialFlag(key, value)Set named tutorial flag
M.getTutorialData() → tableFull save data including flags
M.endTutorial()End tutorial, enable autosave, reset state

| M.getCustomTowHookLabel | () | - |

Public API - Step Control

FunctionSignatureDescription
M.beginLinearStep(step)Load and start flowgraph for given step
M.completeLinearStep(nextStep)Advance to next tutorial step

Public API - Intro Popups

FunctionSignatureDescription
M.introPopup(id, force)Show intro popup from HTML template if not seen
M.wasIntroPopupsSeen(pages) → boolCheck if all listed popups were seen
M.showNonTutorialWelcomeSplashscreen()Show welcome popups for non-tutorial career start
M.showAllSplashscreensAndLogbookEntries()Debug: show all popups
M.drawDebugFunctions()ImGui debug menu for intro popups
M.onExtensionUnloaded()-

Auto-Generated Popup Hooks

These are dynamically created from introPopupTable:

FunctionTriggers Popup(s)

Traffic Helpers

FunctionDescription
M.setTrafficForTutorialScatter traffic, disable police
M.setTrafficAfterTutorialRestore normal traffic with police

Hook Handlers

HookPurpose
M.onExtensionLoadedLoad tutorial save data
M.onSaveCurrentSaveSlotPersist tutorial data
M.onCareerActiveDisable autosave during tutorial
M.onClientStartMissionBegin current linear step
M.onCareerModulesActivatedBegin current linear step

Tutorial Flags

Key boolean flags tracked in saveData.flags: towToRoadEnabled, towToGarageEnabled, customTowHookEnabled, completedTutorialMission, arrivedAtFuelstation, arrivedAtGarage, purchasedFirstCar, partShoppingComplete, tuningComplete, modifiedFirstCar, spawnPointDiscoveryEnabled, earnedFirstStar


See Also

  • logbook - Tutorial entries appear in logbook
  • career - Career activation and tutorial flag

Vehicle Inventory

M.dependencies = {'career_career', "career_modules_log", "render_renderViews", "util_screenshotCreator"}

Loaner Vehicles

M.dependencies = {"util_stepHandler"}

On this page

DependenciesInternal StatePublic API - Tutorial StatePublic API - Step ControlPublic API - Intro PopupsAuto-Generated Popup HooksTraffic HelpersHook HandlersTutorial FlagsSee Also