Rally Settings Manager
Loads and provides access to mission-level rally settings (notebook filename, selected codriver). Wraps the `MissionSettings` class for convenience.
Loads and provides access to mission-level rally settings (notebook filename, selected codriver). Wraps the MissionSettings class for convenience.
Exports
| Function | Signature | Returns | Description |
|---|---|---|---|
M.load | (notebook) | nil | Loads mission settings for the notebook's mission directory |
M.getMissionSettings | () | MissionSettings | Returns the currently loaded mission settings |
M.loadMissionSettingsForMissionDir | (missionDir) | MissionSettings, string | Loads settings for a specific mission dir; returns nil + error on failure |
M.ensureMissionSettingsFile | - | - | Referenced but implementation is commented out |
M.reset | - | - | Referenced but implementation is commented out |
How It Works
The module maintains a module-level missionSettings variable. Calling load(notebook) constructs a MissionSettings object using the path from rallyUtil.getMissionSettingsFile(notebook:getMissionDir()) and loads it.
The MissionSettings object tracks:
- Selected notebook filename
- Selected codriver name (which determines the language)
local SettingsManager = require('/lua/ge/extensions/gameplay/rally/settingsManager')
-- Load settings for a notebook
SettingsManager.load(notebook)
-- Access the loaded settings
local ms = SettingsManager.getMissionSettings()
-- Or load directly for a mission directory
local ms, err = SettingsManager.loadMissionSettingsForMissionDir(missionDir)Note
Some exported functions (ensureMissionSettingsFile, reset) reference local variables/functions that are commented out, which would cause runtime errors if called. This module appears to be partially deprecated or in transition.
See Also
- Rally Audio Manager - Related reference
- Rally Camera Path Player - Related reference
- Rally Client - Related reference
- Gameplay Systems Guide - Guide
Recce Settings
Persists recce mode settings per-level: last loaded mission, load state, and corner call style. Stored as JSON at the rally settings root.
Snap-to-Road
Provides snap-to-road functionality in the world editor's rally editor. Wraps a driveline (linked list of points) with spatial queries, point partitioning, filtering, camera path playback, and debug v