z_mirror/StatsGui

git clone https://git.raiguard.me/z_mirror/StatsGui

Caleb HeuerUpdate to Factorio 2.17ef4dd02026-10-06

local constants = require("constants")

local player_data = require("scripts.player-data")
local preprocessors = require("scripts.preprocessors")
local sensors = require("scripts.sensors")
local stats_gui = require("scripts.stats-gui")

-- -----------------------------------------------------------------------------
-- EVENT HANDLERS

-- BOOTSTRAP

script.on_init(function()
  storage.players = {}
  storage.research_progress_samples = {}
  storage.research_progress_strings = {}
  for i, player in pairs(game.players) do
    player_data.init(i)
    player_data.refresh(player, storage.players[i])
  end
end)

script.on_configuration_changed(function(e)
  local old_version = e.mod_changes and e.mod_changes[script.mod_name] and e.mod_changes[script.mod_name].old_version
  if not old_version then
    return
  end

  if helpers.compare_versions(old_version, "1.1.0") < 0 then
    storage.research_progress_strings = {}
  end

  storage.research_progress_samples = {}
  for i, player in pairs(game.players) do
    player_data.refresh(player, storage.players[i])
  end
end)

-- PLAYER

script.on_event(defines.events.on_player_created, function(e)
  local player = game.get_player(e.player_index)
  player_data.init(e.player_index)
  player_data.refresh(player, storage.players[e.player_index])
end)

script.on_event(defines.events.on_player_removed, function(e)
  storage.players[e.player_index] = nil
end)

script.on_event(
  { defines.events.on_player_display_resolution_changed, defines.events.on_player_display_scale_changed },
  --- @param e EventData.on_player_display_resolution_changed|EventData.on_player_display_scale_changed
  function(e)
    local player = game.get_player(e.player_index)
    if not player then
      return
    end
    local player_table = storage.players[e.player_index]
    stats_gui.update(player, player_table)
  end
)

-- SETTINGS

script.on_event(defines.events.on_runtime_mod_setting_changed, function(e)
  if string.sub(e.setting, 1, 8) == "statsgui" then
    local player = game.get_player(e.player_index)
    local player_table = storage.players[e.player_index]
    if
      e.setting == "statsgui-single-line"
      or e.setting == "statsgui-adjust-for-fps-ups"
      or e.setting == "statsgui-adjust-for-clock"
    then
      -- recreate the GUI to change the frame direction and/or padding
      player_data.refresh(player, player_table)
    else
      player_data.update_settings(player, player_table)
    end
  end
end)

-- TICK

-- update stats once per second
script.on_nth_tick(60, function()
  -- run preprocessors
  for _, preprocessor in pairs(preprocessors) do
    preprocessor()
  end
  -- update GUIs
  for _, player in pairs(game.connected_players) do
    local player_table = storage.players[player.index]
    stats_gui.update(player, player_table)
  end
end)

-- CONTROLLER

script.on_event(
  { defines.events.on_cutscene_started, defines.events.on_cutscene_finished, defines.events.on_cutscene_cancelled },
  --- @param e EventData.on_cutscene_started|EventData.on_cutscene_finished|EventData.on_cutscene_cancelled
  function(e)
    local player = game.get_player(e.player_index)
    if not player then
      return
    end
    local player_table = storage.players[e.player_index]
    if not player_table then
      return
    end
    player_table.stats_window.visible = player.controller_type ~= defines.controllers.cutscene
  end
)

script.on_event(defines.events.on_player_controller_changed, function(e)
  local player = game.get_player(e.player_index)
  if not player then
    return
  end
  local player_table = storage.players[e.player_index]
  if not player_table then
    return
  end
  stats_gui.update(player, player_table)
end)

script.on_event(
  { defines.events.on_gui_opened, defines.events.on_gui_closed },
  --- @param e EventData.on_gui_opened|EventData.on_gui_closed
  function(e)
    if e.gui_type ~= defines.gui_type.entity or e.entity.type ~= "locomotive" then
      return
    end

    local player = game.get_player(e.player_index)
    if not player then
      return
    end
    local player_table = storage.players[e.player_index]
    if not player_table then
      return
    end
    stats_gui.update(player, player_table)
  end
)

-- -----------------------------------------------------------------------------
-- REMOTE INTERFACE

remote.add_interface("StatsGui", {
  add_preprocessor = function(interface, func)
    -- create a dummy function that calls the specified remote interface and returns what it returns
    preprocessors[#preprocessors + 1] = function()
      return remote.call(interface, func)
    end
  end,
  add_sensor = function(interface, func)
    -- create a dummy function that calls the specified remote interface and returns what it returns
    sensors[#sensors + 1] = function(player)
      return remote.call(interface, func, player)
    end
  end,
  version = function()
    return constants.interface_version
  end,
})