Campaign System

Core campaign orchestration module. Manages campaign lifecycle, scenario sequencing, location status tracking, rewards, achievements, and UI flow between campaign scenarios and exploration.

Dependencies

M.dependencies = {'scenario_scenarios'}

Overview

Depends on scenario_scenarios. Tracks a single active campaign with subsections containing scenario locations. Handles scenario start/finish events, reward selection, end-screen UI, save/resume, and exploration transitions.

Public API

Campaign State Structure

campaign = {
  meta = {
    title = "Campaign Name",
    subsections = { [key] = { locations = {...}, triggers = {...}, level = "..." } },
    startingLocation = "subsection.location",
    defaultVehicle = { model = "...", config = "...", color = "..." },
    sourceFile = "path/to/campaign.json"
  },
  state = {
    campaignActive = true,
    currentLocation = "subsection.location",
    activeSubsection = "subsectionKey",
    scenarioKey = "locationKey",
    scenarioExecutionOrder = {"scenario1", "scenario2"},
    locationStatus = { ["sub.loc"] = {attempts = 0, state = "ready", medal = ""} },
    selectedRewardIndex = nil
  }
}

Location Status Values

Notes

• Campaigns are mutually exclusive - starting a new one stops the current
• Scenario flow: startScenarioFromKey → scenarioStarted → scenarioFinished → processNextScenario
• End screen buttons are dynamically built based on endOptions in location data
• Comics can play between scenarios via campaign_comics
• Achievements are unlocked via OnlineServiceProvider.unlockAchievement()
• The whiteListActions default is "default_whitelist_campaign"

See Also

• Campaigns Loader - Campaign file loading and save management
• Campaign Exploration - Free-roam between scenarios
• Campaign Comics - Comic cutscene playback
• Campaign Dealer - Vehicle stock management