Difference between revisions of "Template:Function"
Jump to navigation
Jump to search
updated documentation
imported>DragoonWraith (adding See Also list) |
imported>DragoonWraith (updated documentation) |
||
| Line 2: | Line 2: | ||
{{Incomplete}} | {{Incomplete}} | ||
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_Template_Test|Sandbox]].</noinclude><includeonly><!-- | 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_Template_Test|Sandbox]]. | ||
<nowiki>{{Function|</nowiki> | |||
CSWikiPage = name of corresponding page on the [http://cs.elderscrolls.com/constwiki/index.php/Category:Functions|TES 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 | |||
<nowiki>}}</nowiki></noinclude><includeonly><!-- | |||
link to the CS Wiki page | link to the CS Wiki page | ||