Template:SC/Helper module/doc

Template documentation (for the above template, sometimes hidden or invisible)

Help out by writing some. There may also be documentation on Wikia Templates which can be copied.

This template currently doesn't have any documentation; you can create it if you know how the template is used. (What is this?)
If you're done making changes, please refresh the text.
Please add categories and interwikis to Template:SC/Helper module/doc/doc. (View all subpages of this page.)

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>
}}