Key modifiers in on_gui_click

[apriori]

It would be great if we could know which mouse button and key modifier were pressed in on_gui_click:

example

Code: Select all

script.on_event(defines.events.on_gui_click, function(event)
  if event.element.name == "gui_name" then
    if event.mouse_button == 1 then
      if not event.key_modifier then
        JustDoIt()
      elseif event.key_modifier == "shift" then
        DoItALot()
      end
    elseif event.mouse_button == 2 then
      DoItSmartly()
    end
  end
end)

[aubergine18]

+1

Only tweak I'd make is for consistency with way mods define keyboard shortcuts: capitalise first letter, eg. "Shift" instead of "shift"

[apriori]

+1

Only tweak I'd make is for consistency with way mods define keyboard shortcuts: capitalise first letter, eg. "Shift" instead of "shift"

"SHIFT" - as when defining hotkeys. =)

Code: Select all

data:extend({
  {
    type = "custom-input",
    name = "my-mod-hot-key",
    key_sequence = "SHIFT + Y",
    consuming = "script-only"
  }
})

[aubergine18]

yes, you are correct

[bobingabout]

The ability to scan the keyboard in scripts to determine if a key is pressed or not would definitely be useful (even outside of on_gui_click), I can't remember what it was right now, but I remember I wanted to program something in where if you did something while holding a key, it would do it differently (I think it was a settings copy script if you placed an entity while holding a key)

[kiba]

+1

Only tweak I'd make is for consistency with way mods define keyboard shortcuts: capitalise first letter, eg. "Shift" instead of "shift"

"SHIFT" - as when defining hotkeys. =)

Code: Select all

data:extend({
  {
    type = "custom-input",
    name = "my-mod-hot-key",
    key_sequence = "SHIFT + Y",
    consuming = "script-only"
  }
})

What does "consuming" means? I can't find hotkey definitions anywhere in the lua-api doc.

[mknejp]

Instead of having key_modifier be a single value make it a dictionary to support combinations

Code: Select all

if(event.key_modifiers.SHIFT and event.key_modifiers.ALT) then
 ...

[Supercheese]

What does "consuming" means? I can't find hotkey definitions anywhere in the lua-api doc.

See: http://pastebin.com/raw/k44Ed5Gz

[Mooncat]

I second this. And I think mknejp's solution works better.

[Rseding91]

The current system for detecting input actions and firing events in Factorio doesn't preserve data like this.

When the button is clicked it sends a 4 byte event "button clicked" - none of the data about which button or what keys are held down is stored in that event. It works this way because those events are saved in replays and are sent over the network for Multiplayer games. If the entire keyboard state was stored in those events it would be crazy.

Because of that, this isn't likely to ever happen.

[credomane]

Would just adding another byte (really just 3 bits) to the event to keep track of modifier keys like SHIFT, CONTROL, ALT be too much?

Perhaps 1 more bit to say it was a right click otherwise assume left click (even for a middle click or mice with 4+ buttons on them).

[Rseding91]

Would just adding another byte (really just 3 bits) to the event to keep track of modifier keys like SHIFT, CONTROL, ALT be too much?

Perhaps 1 more bit to say it was a right click otherwise assume left click (even for a middle click or mice with 4+ buttons on them).

If *all* you want is those modifier keys then sure I guess it wouldn't be out of the question to add those.

[credomane]

If *all* you want is those modifier keys then sure I guess it wouldn't be out of the question to add those.

It is certainly all I want. Knowing if any modifier keys were held on click and if the click was left or right click would be absolutely amazing.

The only thing I could see others wanting would be to know if the SHIFT, CONTROL, and ALT modifiers were the left or right side of the keyboard.

As for all other keys on a keyboard I dunno why anyone would want the letter "K" as a modifier for a left click on a button. That even looks weird typing it out like I did.

[apriori]

You are already using modifiers and mouse buttons in GUIs: in grids of inventories. I vote for the same in custom GUIs. That's all.

[bobingabout]

Well, I wanted somethng crazy like "L", but, I could work with the standard 3 key modifiers.

[aubergine18]

Just having standard key modifiers (Control, Shift, Alt) would suffice IMO. Addition of being able to determine if it was left or right mouse click would be icing on cake.

[credomane]

Well, I wanted somethng crazy like "L", but, I could work with the standard 3 key modifiers.

Of-course Bob does. Should have known.