z_mirror/EditorExtensions

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

Caleb HeuerFix warnings8a6b6a9

trunk
branches1.14Quezler/patch-1hidden-itemstrunkall refs →
3.1 KiB98 linesraw
1--- @class Util
2local util = {}
3
4local coreutil = require("__core__.lualib.util")
5util.parse_energy = coreutil.parse_energy
6
7--- @param handler flib.GuiElemHandler
8function util.close_button(handler)
9  return {
10    type = "sprite-button",
11    style = "frame_action_button",
12    sprite = "utility/close",
13    -- hovered_sprite = "utility/close_black",
14    -- clicked_sprite = "utility/close_black",
15    tooltip = { "gui.close-instruction" },
16    mouse_button_filter = { "left" },
17    handler = { [defines.events.on_gui_click] = handler },
18  }
19end
20
21--- @param mode string
22--- @param handler flib.GuiElemHandler
23--- @return flib.GuiElemDef
24function util.mode_radio_button(mode, handler)
25  return {
26    type = "radiobutton",
27    name = "mode_radio_button_" .. string.gsub(mode, "%-", "_"),
28    caption = { "gui-infinity-container." .. mode },
29    tooltip = { "gui-infinity-pipe." .. mode .. "-tooltip" },
30    state = false,
31    tags = { mode = mode },
32    handler = { [defines.events.on_gui_checked_state_changed] = handler },
33  }
34end
35
36function util.pusher()
37  return { type = "empty-widget", style = "flib_horizontal_pusher", ignored_by_interaction = true }
38end
39
40--- @return boolean
41function util.in_debug_world()
42  if not settings.global["ee-override-debug-world"].value then
43    return false
44  end
45  if script.level.mod_name ~= "base" or script.level.level_name ~= "freeplay" then
46    return false
47  end
48  local nauvis = game.get_surface("nauvis")
49  if not nauvis then
50    return false
51  end
52  local mps = nauvis.map_gen_settings
53  return mps.height == 50 and mps.width == 50
54end
55
56--- @return boolean
57function util.in_testing_scenario()
58  return script.level.mod_name == "EditorExtensions" and script.level.level_name == "testing"
59end
60
61--- @param player LuaPlayer
62--- @param message LocalisedString
63--- @param play_sound boolean?
64--- @param position MapPosition?
65function util.flying_text(player, message, play_sound, position)
66  player.create_local_flying_text({
67    text = message,
68    create_at_cursor = not position,
69    position = position,
70  })
71  if play_sound then
72    player.play_sound({ path = "utility/cannot_build" })
73  end
74end
75
76--- @param player LuaPlayer
77--- @param to_state boolean?
78--- @return boolean
79function util.player_can_use_editor(player, to_state)
80  local can_use_editor = to_state
81  if can_use_editor == nil then
82    local permission_group = player.permission_group
83    if permission_group then
84      can_use_editor = permission_group.allows_action(defines.input_action.toggle_map_editor)
85      if not can_use_editor and player.controller_type == defines.controllers.editor then
86        player.print({ "message.ee-cannot-use-map-editor" })
87        -- XXX: We need to re-enable the capability in order to get them out of the editor
88        permission_group.set_allows_action(defines.input_action.toggle_map_editor, true)
89        player.toggle_map_editor()
90        permission_group.set_allows_action(defines.input_action.toggle_map_editor, false)
91      end
92    end
93  end
94  player.set_shortcut_available("ee-toggle-map-editor", can_use_editor or false)
95  return can_use_editor and player.admin or false
96end
97
98return util