upstream/wesnoth
1
0
Fork 0
mirror of https://github.com/wesnoth/wesnoth synced 2025-04-17 14:10:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

Address review comment about API function parameter name

Browse Source
This commit is contained in:
Celtic Minstrel 2025-01-14 21:27:49 -05:00 committed by Celtic Minstrel
parent 57c74d41b3
commit 1e0bab4a04
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
data/lua/core/plugin.lua
View File

@ -41,13 +41,13 @@ if wesnoth.kernel_type() == "Application Lua Kernel" then
---Waits until the plugin reaches a specified context.
---Unless the idle function returns true, the context returned from this function is
---guaranteed to have the expected value.
---@param ctx string The context to wait for.
---@param ctx_name string The context to wait for.
---@param idle plugin_idle_function A function that will be called on each slice, taking as argument the events since the previous slice, and the name of the latest context. It can return true to break out of the wait.
---@return WMLTable #All the events that occurred while waiting
---@return plugin_context #The most recent context
---@return plugin_info #The most recent info
function wesnoth.plugin.wait_until(ctx, idle)
return wait_until(function(info) return info.name == ctx end, idle)
function wesnoth.plugin.wait_until(ctx_name, idle)
return wait_until(function(info) return info.name == ctx_name end, idle)
end
---Waits until the plugin reaches one of several specified contexts.