replace all tparam

This commit is contained in:
Insality
2024-11-07 18:34:27 +01:00
parent 999c6222a0
commit 620facbe1f
15 changed files with 281 additions and 281 deletions

View File

@@ -38,10 +38,10 @@ local M = component.create("hotkey")
--- The Hotkey constructor
-- @tparam Hotkey self Hotkey
-- @tparam string[]|string keys The keys to be pressed for trigger callback. Should contains one key and any modificator keys
-- @tparam function callback The callback function
-- @tparam any|nil callback_argument The argument to pass into the callback function
---@param self Hotkey Hotkey
---@param keys string[]|string The keys to be pressed for trigger callback. Should contains one key and any modificator keys
---@param callback function The callback function
---@param callback_argument any|nil The argument to pass into the callback function
function M:init(keys, callback, callback_argument)
self.druid = self:get_druid()
@@ -73,9 +73,9 @@ end
--- Add hotkey for component callback
-- @tparam Hotkey self Hotkey
-- @tparam string[]|hash[]|string|hash keys that have to be pressed before key pressed to activate
-- @tparam any|nil callback_argument The argument to pass into the callback function
---@param self Hotkey Hotkey
---@param keys string[]|hash[]|string|hash that have to be pressed before key pressed to activate
---@param callback_argument any|nil The argument to pass into the callback function
-- @treturn Hotkey Current instance
function M:add_hotkey(keys, callback_argument)
keys = keys or {}
@@ -174,8 +174,8 @@ end
--- If true, the callback will be triggered on action.repeated
-- @tparam Hotkey self Hotkey
-- @tparam bool is_enabled_repeated The flag value
---@param self Hotkey Hotkey
---@param is_enabled_repeated bool The flag value
-- @treturn Hotkey
function M:set_repeat(is_enabled_repeated)
self._is_process_repeated = is_enabled_repeated