GE Lua Documentation

startWithFade

Definition

-- @/lua/ge/extensions/gameplay/missions/missionManager.lua:754


local function startWithFade(mission, userSettings, startingOptions)
  if not mission then
    log("E", logTag, "Couldn't start mission, mission id not found. " .. dumpsz(mission, 2))
    return true
  end
  if mission._isOngoing then
    log("E", logTag, "Couldn't start mission, it's already ongoing: "..dumpsz(mission, 2))
    return true
  end
  if taskData.active then
    log("W", logTag, "Attempting to start mission while there is an active task: " .. dumpsz(taskData, 3))
    return
  end
  userSettings = userSettings or {}
  startingOptions = startingOptions or {}

  taskData.data = {mission = mission, userSettings = userSettings, startingOptions = startingOptions}
  taskData.type = "start"
  taskData.steps = {
    {
      name = "taskStartFadeStep",
      processTask = taskStartFadeStep,
      timeout = 10
    }, {
      name = "taskStartRemoveVehicles",
      processTask = taskStartRemoveVehicles
    }, {
      name = "taskStartPreMissionHandling",
      processTask = taskStartPreMissionHandling
    }, {
      name = "taskStartVehicleStep",
      processTask = taskStartVehicleStep
    }, {
      name = "taskStartStartingOptionRepairStep",
      processTask = taskStartStartingOptionRepairStep
    },
  }

  if not startingOptions.skipPartConditionSnapshot then
    table.insert(taskData.steps, {
      name = "taskStartTakePartConditionSnapshot",
      processTask = taskStartTakePartConditionSnapshot
    })
  end

  arrayConcat(taskData.steps, {
     {
      name = "taskStartTrafficStep",
      processTask = taskStartTrafficStep
    }, {
      name = "taskStartMissionStep",
      processTask = taskStartMissionStep
    }}
  )

  taskData.active = true
  taskData.currentStep = 1
  log("I", logTag, "Starting mission with fade.")
  extensions.hook("onMissionStartWithFade", mission, userSettings)
end

Callers

      end
      gameplay_missions_missionManager.startWithFade(m, flatSettings, startingOptions or {})
      return