Module:LuaCall/doc
This is the documentation page for Module:LuaCall
This module is rated as alpha. It is ready for third-party input, and may be used on a few pages to see if problems arise, but should be watched. Suggestions for new features or changes in their input and output mechanisms are welcome. |
This module allows you to call any one single preinstalled Lua function, so that you don't need to write a module for one desired feature.
Usage[edit source]
Main[edit source]
{{#invoke:LuaCall|main|arbitrary variables|parameters|functioncall}}
The arbitrary variables are any key of your choice =
any value of your choice. Values are interpreted as strings unless tonumber(value)
isn't nil
, i.e. numbers should be converted to the numeric type. No effort is made to interpret tables.
The parameters all begin with reserved_
, which arbitrary variable should use.
reserved_return
sets which output from the function you want, and defaults to 1. For example, setting it to 2 for mw.ustring.gsub will return the number of replacements made.reserved_debug
- nonzero value forces display of a not particularly useful debug text
The functioncall is written as some.function.name(a,b,c)
where some.function.name means something in the Extension:Scribunto/Lua reference manual and a,b,c are the arbitrary variable names you've chosen.
Examples[edit source]
Main[edit source]
- Template:Demo inline
- Template:Demo inline
- Template:Demo inline
- Template:Demo inline
- Template:Demo inline
- Template:Demo inline
- Template:Demo inline
Call[edit source]
Errors[edit source]
The module may generate script errors — whenever your call is not valid Lua code, you see the error you would normally have. For example,
because the second value is lacking. No effort is made to trap these.