Template:Function

This article is incomplete. You can help by filling in any blank descriptions. Further information might be found in a section of the discussion page. Please remove this message when no longer necessary.

This is a WIP, feedback is appreciated. To retain readability a lot of HTML comments are used, they shouldn't impact the working of the template, but could add to the confusion a bit. Example in the Sandbox.

{{Function|
 CSWikiPage        = name of corresponding page on the CS Wiki]
 origin            = whether the function came from the GECK itself or was added by FOSE (or anywhere else as becomes appropriate)
 summary           = description of the function
 returnVal         = what the function returns
 returnType        = the type of the returned value
 referenceType     = if appropriate, the type of reference that the function may be called on with the dot syntax
 arg0              = the first mandatory argument
                     (note that this is optional in the template because not all functions have mandatory arguments)
 arg1              = the second mandatory argument
 ...                 (the template currently supports 10 mandatory arguments, arg0 through arg9)
 optArg0           = the first optional argument
                     (this means it is optional for the scripter)
 optArg1           = second optional argument
 ...                 (the template also accepts 10 optional arguments, optArg0 through optArg9)
 example           = optionally, the function used as part of a script to serve as an example
 seeAlso0          = the first page in the See Also list
 seeAlso1          = the second page in the See Also list
 ...                 (the template supports 10 See Also pages, seeAlso0 through seeAlso9)
 CategoryList      = the list of categories to which the page belongs
}}