diff --git a/docs/index.html b/docs/index.html index 4ba128b7c..034a6adfe 100644 --- a/docs/index.html +++ b/docs/index.html @@ -10765,17 +10765,17 @@

ImGuiIO

keydown -Returns true if key or chord (e.g `KEY.X \ +Returns true if key or chord is down.
bool keydown(KEY keychord)
bool keydown(char key)
keypressed -Returns true if key or chord (e.g `KEY.X \ +Returns true if key or chord was pressed this GUIFRAME.
bool keypressed(KEY keychord, bool repeat = false)
bool keypressed(char key, bool repeat = false)
keyreleased -Returns true if key or chord (e.g `KEY.X \ +Returns true if key or chord was released this GUIFRAME.
bool keyreleased(KEY keychord)
bool keyreleased(char key)
bool @@ -10800,7 +10800,7 @@

ImGuiIO

modifierdown -bool modifierdown(KEY keychord)
Returns true if modifiers in chord (e.g. `KEY.OL_MOD_CTRL \ +bool modifierdown(KEY keychord)
Returns true if modifiers in chord are down, ignores other keys in chord.
diff --git a/docs/light.html b/docs/light.html index 3337d0cb3..573c27f1e 100644 --- a/docs/light.html +++ b/docs/light.html @@ -10765,17 +10765,17 @@

ImGuiIO

keydown -Returns true if key or chord (e.g `KEY.X \ +Returns true if key or chord is down.
bool keydown(KEY keychord)
bool keydown(char key)
keypressed -Returns true if key or chord (e.g `KEY.X \ +Returns true if key or chord was pressed this GUIFRAME.
bool keypressed(KEY keychord, bool repeat = false)
bool keypressed(char key, bool repeat = false)
keyreleased -Returns true if key or chord (e.g `KEY.X \ +Returns true if key or chord was released this GUIFRAME.
bool keyreleased(KEY keychord)
bool keyreleased(char key)
bool @@ -10800,7 +10800,7 @@

ImGuiIO

modifierdown -bool modifierdown(KEY keychord)
Returns true if modifiers in chord (e.g. `KEY.OL_MOD_CTRL \ +bool modifierdown(KEY keychord)
Returns true if modifiers in chord are down, ignores other keys in chord.
diff --git a/docs/src/includes/_types.md b/docs/src/includes/_types.md index 0ac75217d..01bf3445b 100644 --- a/docs/src/includes/_types.md +++ b/docs/src/includes/_types.md @@ -1098,14 +1098,14 @@ Type | Name | Description float | [framerate](https://github.com/spelunky-fyi/overlunky/search?l=Lua&q=framerate) | | [wantkeyboard](https://github.com/spelunky-fyi/overlunky/search?l=Lua&q=wantkeyboard) | True if anyone else (i.e. some input box, OL hotkey) is already capturing keyboard or reacted to this keypress and you probably shouldn't.
Set this to true every GUIFRAME while you want to capture keyboard and disable UI key bindings and game keys. Won't affect UI or game keys on this frame though, that train has already sailed. Also see [Bucket](#Bucket)::[Overlunky](#Overlunky) for other ways to override key bindings.
Do not set this to false, unless you want the player input to bleed through input fields.
bool | [keys[ImGuiKey_COUNT]](https://github.com/spelunky-fyi/overlunky/search?l=Lua&q=keys) | ZeroIndexArray of currently held keys, indexed by [KEY](#KEY) <= 0xFF
- | [keydown](https://github.com/spelunky-fyi/overlunky/search?l=Lua&q=keydown) | Returns true if key or chord (e.g `KEY.X \| KEY.OL_MOD_CTRL`) is down.
bool keydown(KEY keychord)
bool keydown(char key)
- | [keypressed](https://github.com/spelunky-fyi/overlunky/search?l=Lua&q=keypressed) | Returns true if key or chord (e.g `KEY.X \| KEY.OL_MOD_CTRL`) was pressed this GUIFRAME.
bool keypressed(KEY keychord, bool repeat = false)
bool keypressed(char key, bool repeat = false)
- | [keyreleased](https://github.com/spelunky-fyi/overlunky/search?l=Lua&q=keyreleased) | Returns true if key or chord (e.g `KEY.X \| KEY.OL_MOD_CTRL`) was released this GUIFRAME.
bool keyreleased(KEY keychord)
bool keyreleased(char key)
+ | [keydown](https://github.com/spelunky-fyi/overlunky/search?l=Lua&q=keydown) | Returns true if key or chord is down.
bool keydown([KEY](#KEY) keychord)
bool keydown(char key)
+ | [keypressed](https://github.com/spelunky-fyi/overlunky/search?l=Lua&q=keypressed) | Returns true if key or chord was pressed this GUIFRAME.
bool keypressed([KEY](#KEY) keychord, bool repeat = false)
bool keypressed(char key, bool repeat = false)
+ | [keyreleased](https://github.com/spelunky-fyi/overlunky/search?l=Lua&q=keyreleased) | Returns true if key or chord was released this GUIFRAME.
bool keyreleased([KEY](#KEY) keychord)
bool keyreleased(char key)
bool | [keyctrl](https://github.com/spelunky-fyi/overlunky/search?l=Lua&q=keyctrl) | bool | [keyshift](https://github.com/spelunky-fyi/overlunky/search?l=Lua&q=keyshift) | bool | [keyalt](https://github.com/spelunky-fyi/overlunky/search?l=Lua&q=keyalt) | bool | [keysuper](https://github.com/spelunky-fyi/overlunky/search?l=Lua&q=keysuper) | - | [modifierdown](https://github.com/spelunky-fyi/overlunky/search?l=Lua&q=modifierdown) | bool modifierdown([KEY](#KEY) keychord)
Returns true if modifiers in chord (e.g. `KEY.OL_MOD_CTRL \| KEY.OL_MOD_SHIFT \| KEY.OL_MOD_ALT`) are down, ignores other keys in chord.
+ | [modifierdown](https://github.com/spelunky-fyi/overlunky/search?l=Lua&q=modifierdown) | bool modifierdown([KEY](#KEY) keychord)
Returns true if modifiers in chord are down, ignores other keys in chord.
| [wantmouse](https://github.com/spelunky-fyi/overlunky/search?l=Lua&q=wantmouse) | True if anyone else (i.e. hovering some window) is already capturing mouse and you probably shouldn't.
Set this to true if you want to capture mouse and override UI mouse binding.
[Vec2](#Vec2) | [mousepos](https://github.com/spelunky-fyi/overlunky/search?l=Lua&q=mousepos) | bool | [mousedown[5]](https://github.com/spelunky-fyi/overlunky/search?l=Lua&q=mousedown) |