0ct0pu5/wesnoth
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

LuaDoc: Document the new WFL function table

Browse source
This commit is contained in:
Celtic Minstrel 2024-10-02 22:17:49 -04:00
parent cf5e2b1d2c
commit db48a98f12
1 changed files with 11 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
utils/emmylua/wesnoth.lua
View file

@ -82,12 +82,21 @@ function wesnoth.name_generator(type, definition) end
---@return fun():string ---@return fun():string
function wesnoth.name_generator(type, definition, chain_size, max_length) end function wesnoth.name_generator(type, definition, chain_size, max_length) end
---@alias formula fun(variables:WML):any ---@class formula
---@field functions formula_function_table
---@overload fun(variables:WML):any
---@class formula_function
---@overload fun(variables:WML, ...):any,string?
---@class formula_function_table
---@field [string] formula_function
---Compile a WFL formula into a Lua function ---Compile a WFL formula into a Lua function
---@param formula string A WFL formula ---@param formula string A WFL formula
---@param functions? formula_function_table Additional functions to be defined for the formula
---@return formula ---@return formula
function wesnoth.compile_formula(formula) end function wesnoth.compile_formula(formula, functions) end
---Evaluate a WFL formula ---Evaluate a WFL formula
---@param formula string|formula A WFL formula ---@param formula string|formula A WFL formula