Template:Helper module

Template documentation[view] [edit] [history] [purge]

The above documentation is transcluded from Template:Helper module/doc. (edit | history)
Editors can experiment in this template's sandbox (create | mirror) and testcases (create) pages.
Add categories to the /doc subpage. Subpages of this template.

Provides documentation for functions of modules that contain functions useful for other modules. This template should be part of the modules documentation. There is no limit to the number of functions this template can list.

This template is called by Star Citizen:Lua/Helper modules to help produce a dynamic table.

{{Helper module
|name = Name of the module (no namespace prefix)
|fname1 = Name of first function as it is called in modules. If the function has multiple versions they can be split up using <code>;;</code> as a separator.
|ftype1 = Argument types of parameters
|fuse1 = Purpose of the function
...
|fname# = Name of tenth function as it is called in modules
|ftype# = Argument types of parameters
|fuse# = Purpose of the function
|example = <syntaxhighlight lang='lua'>
-- Code
</syntaxhighlight>
}}