GE Lua Documentation

onClientStartMission

Definition

-- @/lua/ge/extensions/scenario/scenarios.lua:945

-- this function is called when the level that the scenario needs loaded successfully
local function onClientStartMission(levelPath)
  -- cleanup any remaining scenario objects by deleting the whole group
  -- cleanup needs to happen here not on endmission as they are not called in the correct order
  --log('D', logTag, 'executing TS: ' .. ts)
  if(scenetree.ScenarioObjectsGroup) then scenetree.ScenarioObjectsGroup:delete() end
  spawn.preventPlayerSpawning = nil
  if scenario == nil then
    --log('D', logTag, 'no scenario loaded')
    return
  end


  core_environment.reset_init()
  inputActionFilter.clear(0)


  log('D', logTag, 'Starting scenario : '..tostring(translateLanguage(scenario.name, scenario.name)))
  log('D', logTag, 'Scenario path : '..tostring(scenario.sourceFile))

  -- create the special simgroup where we put all objects of the scenario in
  --log('D', logTag, 'executing TS: ' .. ts)
  --TODO need to change player delete() for carrier mode
  if(scenetree.thePlayer) then scenetree.thePlayer:delete() end
  local ScenarioObjectsGroup = createObject('SimGroup')
  if not ScenarioObjectsGroup then
    log('E', logTag, 'ScenarioObjectsGroup not existing')
    return
  end

  local MissionGroup = scenetree.MissionGroup
  if not MissionGroup then
    log('E', logTag, 'MissionGroup not existing')
    return
  end

  ScenarioObjectsGroup:registerObject('ScenarioObjectsGroup')
  ScenarioObjectsGroup.canSave = false
  MissionGroup:addObject(ScenarioObjectsGroup.obj)

  -- spawn the prefabs of the scenario
  log('D', logTag, 'spawning prefabs ...')
  for i, filename in ipairs(scenario.prefabs) do
    local _, objNameNew, _ = path.splitWithoutExt(filename, ".prefab.json")
    local _, objNameOld, _ = path.splitWithoutExt(filename, ".prefab")
    local objName = string.lower(objNameNew or objNameOld)
    if not scenetree.findObject(objName) then
      local prefabObj = spawnPrefab(objName, filename, '0 0 0', '0 0 1 0', '1 1 1')
      ScenarioObjectsGroup:addObject(prefabObj.obj)
    else
      log('E', logTag, 'Prefab: '..objName..' already exist in level. Rejecting loading of duplicate.')
    end
  end

  -- TODO(AK): this is only here to fix http://home/redmine/issues/2863 - [QA] Prefab loose collisions on campaign mode
  -- We do not ultimately want this here. This should be part of the flow and not in a callback.
  be:physicsStartSimulation()

  -- Spawn any user selected vehicles
  if scenario.userSelectedVehicle then

    local model = scenario.userSelectedVehicle.model
    local config = scenario.userSelectedVehicle.config
    if scenario.userSelectedVehicle.color then
      scenario.userSelectedVehicle.color = validateVehicleDataColor(scenario.userSelectedVehicle.color)
    end
    local color = scenario.userSelectedVehicle.color
    local licenseText = scenario.userSelectedVehicle.licenseText
    scenario.userSpawningData = createPlayerSpawningData(model, config, color, licenseText)
    local spawnedVehicle = nil
    local playerVehicle = getPlayerVehicle(0)
    if playerVehicle then
      spawnedVehicle = core_vehicles.replaceVehicle(scenario.userSpawningData.model, scenario.userSpawningData.options)
    else
      spawnedVehicle = core_vehicles.spawnNewVehicle(scenario.userSpawningData.model, scenario.userSpawningData.options)
    end
    if spawnedVehicle then
      scenario.userSelectedVehicle.returnedVehicleId = spawnedVehicle:getID()
    end
  end

  extensions.hook('onLoadCustomPrefabs', scenario)

  changeState('pre-start')
end

Callers

local function onClientStartMission()
  selectPath(nil)

local function onClientStartMission(levelPath)
  loadSaveData()

local function onClientStartMission()
  done = false

local function onClientStartMission()
  if isStateFreeroam() then

local function onClientStartMission(levelPath)
  local levelInfo = getObject("LevelInfo")

local function onClientStartMission()
  if state == 'off' then

local function onClientStartMission()
    vehicleToLoad = 1

function C:onClientStartMission()
  self.objID = nil

local function onClientStartMission(levelPath)
  -- Disclaimer message for campaign mode.

-- resets the app on level load
local function onClientStartMission()
  M.stopHotlapping()

local function onClientStartMission(levelPath)
  if vehicleToLoad then

local function onClientStartMission()
  if not sites then

local function onClientStartMission(levelPath)
  if career_career.isActive() then

local function onClientStartMission(levelPath)
  dump(levelPath)

local function onClientStartMission()
  terrainSize = nil

end
local function onClientStartMission()
  notifyUnclaimedMilestonesCount()

local function onClientStartMission()
  editor.initialized = false

local function onClientStartMission()
  setupTraffic()

local function onClientStartMission()
  loadTriggers()

local function onClientStartMission(levelPath)
  clearBlacklist()

local function onClientStartMission(levelPath)
  local path, file, ext = path.splitWithoutExt(levelPath)

local function onClientStartMission()
end

  if data.windowOpen ~= nil then windowOpen[0] = data.windowOpen end
  if data.currentLevel then M.onClientStartMission() end
  if fileDataCareer then

local function onClientStartMission(levelPath)
  startActivity(levelPath)

local function onClientStartMission()

local function onClientStartMission()
  if M.requestedEditor then

local function onClientStartMission(levelPath)
  if not setDisplayPrices() then

  else
    onClientStartMission(getCurrentLevelIdentifier())
  end

local function onClientStartMission(levelPath)
  setupSounds()

local function onClientStartMission()
  loadSignals()

local function onClientStartMission(levelPath)
  loadSites()

local function onClientStartMission(levelPath)
  if levelPath == testLevel then

local function onClientStartMission(levelPath)
  setActive(false)

local function onClientStartMission(levelPath)
  if careerActive then

local function onClientStartMission(levelPath)
  if tableIsEmpty(milestoneConfigs) then

local function onClientStartMission()
    loaded = true

local function onClientStartMission()
  local camPathFolder = (path.split(getMissionFilename()) or '') .. "camPaths"

local function onClientStartMission()
  vehiclesInShop = {}

local function onClientStartMission(levelPath)
  setupInventory()

local function onClientStartMission()
  table.clear(flaggedVehicles)