From 4bad35e608179e74c9ce186fa2038573055e574b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E6=9C=80=E8=90=8C=E5=B0=8F=E6=B1=90?= Date: Tue, 20 Jul 2021 16:40:27 +0800 Subject: first step of love2d-api --- meta/3rd/love2d/library/love.keyboard.lua | 73 +++++++++++++++++++++++++++++++ 1 file changed, 73 insertions(+) create mode 100644 meta/3rd/love2d/library/love.keyboard.lua (limited to 'meta/3rd/love2d/library/love.keyboard.lua') diff --git a/meta/3rd/love2d/library/love.keyboard.lua b/meta/3rd/love2d/library/love.keyboard.lua new file mode 100644 index 00000000..a1d06596 --- /dev/null +++ b/meta/3rd/love2d/library/love.keyboard.lua @@ -0,0 +1,73 @@ +---@class love.keyboard +love.keyboard = {} + +--- +---Gets the key corresponding to the given hardware scancode. +--- +---Unlike key constants, Scancodes are keyboard layout-independent. For example the scancode 'w' will be generated if the key in the same place as the 'w' key on an American keyboard is pressed, no matter what the key is labelled or what the user's operating system settings are. +--- +---Scancodes are useful for creating default controls that have the same physical locations on on all systems. +--- +---@param scancode Scancode # The scancode to get the key from. +---@return KeyConstant key # The key corresponding to the given scancode, or 'unknown' if the scancode doesn't map to a KeyConstant on the current system. +function love.keyboard.getKeyFromScancode(scancode) end + +--- +---Gets the hardware scancode corresponding to the given key. +--- +---Unlike key constants, Scancodes are keyboard layout-independent. For example the scancode 'w' will be generated if the key in the same place as the 'w' key on an American keyboard is pressed, no matter what the key is labelled or what the user's operating system settings are. +--- +---Scancodes are useful for creating default controls that have the same physical locations on on all systems. +--- +---@param key KeyConstant # The key to get the scancode from. +---@return Scancode scancode # The scancode corresponding to the given key, or 'unknown' if the given key has no known physical representation on the current system. +function love.keyboard.getScancodeFromKey(key) end + +--- +---Gets whether key repeat is enabled. +--- +---@return boolean enabled # Whether key repeat is enabled. +function love.keyboard.hasKeyRepeat() end + +--- +---Gets whether screen keyboard is supported. +--- +---@return boolean supported # Whether screen keyboard is supported. +function love.keyboard.hasScreenKeyboard() end + +--- +---Gets whether text input events are enabled. +--- +---@return boolean enabled # Whether text input events are enabled. +function love.keyboard.hasTextInput() end + +--- +---Checks whether a certain key is down. Not to be confused with love.keypressed or love.keyreleased. +--- +---@param key KeyConstant # The key to check. +---@return boolean down # True if the key is down, false if not. +function love.keyboard.isDown(key) end + +--- +---Checks whether the specified Scancodes are pressed. Not to be confused with love.keypressed or love.keyreleased. +--- +---Unlike regular KeyConstants, Scancodes are keyboard layout-independent. The scancode 'w' is used if the key in the same place as the 'w' key on an American keyboard is pressed, no matter what the key is labelled or what the user's operating system settings are. +--- +---@param scancode Scancode # A Scancode to check. +---@param ... Scancode # Additional Scancodes to check. +---@return boolean down # True if any supplied Scancode is down, false if not. +function love.keyboard.isScancodeDown(scancode, ...) end + +--- +---Enables or disables key repeat for love.keypressed. It is disabled by default. +--- +---@param enable boolean # Whether repeat keypress events should be enabled when a key is held down. +function love.keyboard.setKeyRepeat(enable) end + +--- +---Enables or disables text input events. It is enabled by default on Windows, Mac, and Linux, and disabled by default on iOS and Android. +--- +---On touch devices, this shows the system's native on-screen keyboard when it's enabled. +--- +---@param enable boolean # Whether text input events should be enabled. +function love.keyboard.setTextInput(enable) end -- cgit v1.2.3