GE Lua Documentation

onPlayerCameraReady

Definition

-- @/lua/ge/extensions/freeroam/freeroam.lua:121


local function onPlayerCameraReady()
  -- figure out traffic loading and override if set in spawningOptionsHelper
  local loadTraffic = false
  if M.spawningOptionsHelper.trafficMode == "disabled" then
    loadTraffic = false
  elseif M.spawningOptionsHelper.trafficMode == "enabled" then
    loadTraffic = true
  end

  local loadParkedVehicles = settings.getValue('trafficParkedVehicles')
  if M.spawningOptionsHelper.trafficParked == "disabled" then
    loadParkedVehicles = false
  elseif M.spawningOptionsHelper.trafficParked == "enabled" then
    loadParkedVehicles = true
  end

  local trafficAmount, policeRatio, parkedVehiclesAmount = -1,-1,-1
  if M.spawningOptionsHelper.trafficAmount ~= -1 then
    trafficAmount = M.spawningOptionsHelper.trafficAmount
  end
  if M.spawningOptionsHelper.trafficPoliceRatio ~= -1 then
    policeRatio = M.spawningOptionsHelper.trafficPoliceRatio
  end
  if M.spawningOptionsHelper.trafficParkedAmount ~= -1 then
    parkedVehiclesAmount = M.spawningOptionsHelper.trafficParkedAmount
  end

  local levelName = getCurrentLevelIdentifier()
  local level = core_levels.getLevelByName(levelName)
  local supportsTraffic = true
  if level then
    supportsTraffic = level.supportsTraffic
  end

  if not supportsTraffic then
    loadTraffic = false
    loadParkedVehicles = false
  end

  if M.state.freeroamActive then
    if loadTraffic then
      log('I', logTag, string.format('Now spawning traffic for freeroam mode (%s parked vehicles), police ratio: %0.2f', loadParkedVehicles and 'with' or 'without', policeRatio or -1))
      if loadParkedVehicles then
        gameplay_parking.setupVehicles(parkedVehiclesAmount)
      end
      gameplay_traffic.setupTraffic(trafficAmount, policeRatio, {activeAmount = trafficAmount})
    elseif loadParkedVehicles then
      log('I', logTag, string.format('Now spawning parked vehicles only for freeroam mode (%s parked vehicles)', parkedVehiclesAmount))
      gameplay_parking.setupVehicles(parkedVehiclesAmount)
    end
  end
end

Callers

local function onPlayerCameraReady()
  setupTraffic() -- spawns traffic while the loading screen did not fade out yet