-Search script examples for set_hotkey
Returns unique id >= 0 for the callback to be used in clear_callback or -1 if the key could not be registered.
Add callback function to be called on a hotkey, using Windows hotkey api. These hotkeys will override all game and UI input and can work even when the game is unfocused. They are by design very intrusive and won't let anything else use the same key combo. Can't detect if input is active in another instance, use ImGuiIO if you need Playlunky hotkeys to react to Overlunky input state. Key is a KEY combo (e.g. KEY.OL_MOD_CTRL | KEY.X), possibly returned by GuiDrawContext:key_picker. Doesn't work with mouse buttons.
The callback signature is nil on_hotkey(KEY key)
-Search script examples for key_name
-- set the level string shown in hud, journal and game over
+string key_name()
+Returns human readable string from KEY chord (e.g. "Ctrl+X", "Unknown" or "None")
+set_level_string
-- set the level string shown in hud, journal and game over
-- also change the one used in transitions for consistency
set_callback(function()
if state.screen_next == SCREEN.LEVEL then
diff --git a/docs/light.html b/docs/light.html
index 431612bd8..c2e0deec5 100644
--- a/docs/light.html
+++ b/docs/light.html
@@ -5468,7 +5468,7 @@ set_hotkey
Search script examples for set_hotkey
-CallbackId set_hotkey(
+CallbackId set_hotkey(function cb, KEY key, HOTKEY_TYPE flags = HOTKEY_TYPE.NORMAL)
Returns unique id >= 0 for the callback to be used in clear_callback or -1 if the key could not be registered.
Add callback function to be called on a hotkey, using Windows hotkey api. These hotkeys will override all game and UI input and can work even when the game is unfocused. They are by design very intrusive and won't let anything else use the same key combo. Can't detect if input is active in another instance, use ImGuiIO if you need Playlunky hotkeys to react to Overlunky input state. Key is a KEY combo (e.g. KEY.OL_MOD_CTRL | KEY.X), possibly returned by GuiDrawContext:key_picker. Doesn't work with mouse buttons.
The callback signature is nil on_hotkey(KEY key)
@@ -6518,7 +6518,9 @@ key_name
Search script examples for key_name
-nil key_name()
set_level_string
-- set the level string shown in hud, journal and game over
+string key_name()
+Returns human readable string from KEY chord (e.g. "Ctrl+X", "Unknown" or "None")
+set_level_string
-- set the level string shown in hud, journal and game over
-- also change the one used in transitions for consistency
set_callback(function()
if state.screen_next == SCREEN.LEVEL then