Factorio Forums

apriori wrote:

Code: Select all

data:extend({
  {
    type = "custom-input",
    name = "modname-hotkey-main-window",
    key_sequence = "Y",
    consuming = "script-only"
  }
})

{"auto-trash-tooltip-pause"}

auto-trash-tooltip-pause = (__CONTROL__autotrash_pause__)

Choumiko wrote:

Code: Select all

auto-trash-tooltip-pause = (__CONTROL__autotrash_pause__)

aubergine18 wrote:Wow, the __CONTROL__ thing already existed?! Where do people get this information - I couldn't find this anywhere in API guide or wiki. @apriori do you have access to source code or something? Where did you find the infos?

DedlySpyder wrote:Factorio IRC is normally the best place to get undocumented information. I believe that's where we got the pastebin for custom inputs when they first came out.

apriori wrote:Got it!

First of all you should "create" key sequence. You can do it in data.lua or in another lua (for example "prototypes/hotkey.lua") file and include it using require("prototypes.hotkey"):

data.lua

Code: Select all

data:extend({
  {
    type = "custom-input",
    name = "teleportation-hotkey-main-window",
    key_sequence = "Y",
    consuming = "script-only"
  },
  {
    type = "custom-input",
    name = "teleportation-hotkey-activate-closest-beacon",
    key_sequence = "CONTROL + Y",
    consuming = "script-only"
  }
})

[Optional] Then you create an event handler for your hotkey. And make a function to show LuaGuiElement with required tooltip/text:

control.lua

Code: Select all

--Handles hot key
script.on_event("teleportation-hotkey-main-window", function(event)
  local player_index = event.player_index
  SwitchMainWindow(game.players[player_index])
end)

--Handles hot key
script.on_event("teleportation-hotkey-activate-closest-beacon", function(event)
  local player_index = event.player_index
  ActivateNearestBeacon(game.players[player_index])
end)

--Shows main button, that shows tooltip when mouse hovers it
function ShowMainButton(player)
  if player ~= nil and player.valid and player.connected then
    local gui = player.gui.top
    if not gui.teleportation_main_button then
      local button = gui.add({type="button", name="teleportation_main_button", style = "teleportation_sprite_button_style"})
      button.tooltip = {"tooltip-button-main"}
    end
  end
end

Now you can include key sequence into locale:

locale.cfg

Code: Select all

--For localizing tooltip
tooltip-button-main = "__CONTROL__teleportation-hotkey-main-window__" - switch list of beacons visibility \n"__CONTROL__teleportation-hotkey-activate-closest-beacon__" - jump to the closest beacon
[controls] --Text for "game menu -> controls -> mods"
teleportation-hotkey-main-window = Toggle list of teleporter beacons visibility
teleportation-hotkey-activate-closest-beacon = Jump to the closest Beacon

It works!

result

2016-08-30 17-31-28 Скриншот экрана.png

PS: I dunno what will be in this tooltip if I'll change key sequence using game menu... Maybe, old sequence will be shown.

apriori wrote:...

Yes, old sequence is being shown.

DedlySpyder wrote: Meaning that the tooltip doesn't update? How much have you tested it? I assume a restart wouldn't change it, but does redrawing the GUI update it?