Module:LuaCall/doc

MyWikiBiz, Author Your Legacy — Friday May 03, 2024
Jump to navigationJump to search

This is the documentation page for Module:LuaCall

Template:Module rating

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.

The module may generate script errors -- whenever your call isn't valid Lua code, you see the error you would normally have. For example,

Template:Demo inline

because the second value is lacking. No effort is made to trap these.

Usage

{{#invoke:LuaCall|main|''arbitrary variables''|''parameters''|''function''}}

The arbitrary variables are any key of your choice = any value of your choice. Values are interpreted as strings unless tonumber(value) is not NaN - 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 function 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

Template:Demo inline

Template:Demo inline

Template:Demo inline

Template:Demo inline

Template:Demo inline

Template:Demo inline

Template:Demo inline

Template:Demo inline

Template:Demo inline

Template:Demo inline