Extension:VariablesLua

From MediaWiki.org
Jump to navigation Jump to search
MediaWiki extensions manual
Crystal Clear action run.svg
VariablesLua
Release status: beta
Implementation Parser extension
Description Provides support for the Variables extension in Lua modules by the Scribunto extension
Author(s) Alex Winkler
Latest version 1.4.0 (2018-08-29)
MediaWiki 1.28+
License MIT License
Download
Hooks used
ScribuntoExternalLibraries
Translate the VariablesLua extension if it is available at translatewiki.net
Check usage and version matrix.

The VariablesLua extension provides support for the Variables extension in Lua modules by the Scribunto extension.

Bugs and Feature Requests
Issues at Github

Usage[edit]

Manual: Liquipedia Help

The extension can be loaded in Lua modules by the Scribunto extension like this:

VariablesLua = mw.ext.VariablesLua

Functions[edit]

Functions are based on the ones provided by the Variables extension, adding some more utility.

VariablesLua.vardefine[edit]

VariablesLua.vardefine( name, value )

Stores the given value under the given name. If the value is nil, an empty string is stored.

VariablesLua.vardefineecho[edit]

VariablesLua.vardefineecho( name, value )

Identical to VariablesLua.vardefine, but returns the value after storing it.

VariablesLua.var[edit]

VariablesLua.var( name, default )

Retrieve a variable stored under the given name.

VariablesLua.varexists[edit]

VariablesLua.varexists( name )

Checks if a variable exists. Returns a boolean value.

VariablesLua.var_final[edit]

VariablesLua.var_final( name, default )

Returns the last value stored (i.e. the last VariablesLua.vardefine or #vardefine in the code). The value can only be returned and not be used in the Lua code itself.

Installation[edit]

  • Add the following code at the bottom of your LocalSettings.php:
    wfLoadExtension( 'VariablesLua' );
    
  • Yes Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Version history[edit]

1.0.0
  • Initial release.
1.1.0
1.2.0
  • Added argument type checking.
1.2.1
  • Bug fixes.
1.3.0
  • Added mw.ext.VariablesLua.var_table().
1.4.0
  • Removed mw.ext.VariablesLua.var_table() due to changes in Extension:Variables.

See also[edit]