Difference between revisions of "Template:Function"
Jump to navigation
Jump to search
imported>SnakeChomp m (Ok fine, trying <p></p> tags) |
imported>SnakeChomp (Add "arguments" argument to provide arguments using plain text or sub templates) |
||
| Line 15: | Line 15: | ||
returnType = the type of the returned value | 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 | ''referenceType'' = if appropriate, the type of reference that the function may be called on with the dot syntax | ||
''arguments'' = List of arguments specified using the [[Template:FunctionArgumentTest]] template | |||
''arg0'' = the first '''mandatory''' argument | ''arg0'' = the first '''mandatory''' argument | ||
(''arg*'' parameters are optional, not all functions have mandatory arguments) | (''arg*'' parameters are optional, not all functions have mandatory arguments) | ||
| Line 25: | Line 26: | ||
''example'' = optionally, the function used as part of a script to serve as an example | ''example'' = optionally, the function used as part of a script to serve as an example | ||
CategoryList = the list of categories to which the page belongs | CategoryList = the list of categories to which the page belongs | ||
<nowiki>}}</nowiki></noinclude><includeonly><!-- | <nowiki>}}</nowiki> | ||
</noinclude><includeonly><!-- | |||
Back to: link-->{{Bc|Category:Functions}}<!-- | Back to: link-->{{Bc|Category:Functions}}<!-- | ||
| Line 58: | Line 61: | ||
the actual function: | the actual function: | ||
-->{{{name| {{PAGENAME}} }}}<!-- | -->{{{name| {{PAGENAME}} }}}<!-- | ||
arguments | |||
-->{{ #if: {{{arguments|}}} | {{{arguments}}} |}}<!-- | |||
required arguments + types: | required arguments + types: | ||
Revision as of 16:43, 30 January 2009
| 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 TES CS Wiki
origin = whether the function came from the GECK itself or was added by FOSE.
valid values: GECK1 (GECK 1.1), FOSE0001 (FOSE v0001)
summary = description of the function
name = the name of the function, when omitted it's assumed this is the same as the pagename.
shortname = An abbreviated version of the function name that can be
used instead of the long name.
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
arguments = List of arguments specified using the Template:FunctionArgumentTest template
arg0 = the first mandatory argument
(arg* parameters are optional, not all functions have mandatory arguments)
arg1 = the second mandatory argument
... (the template 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
CategoryList = the list of categories to which the page belongs
}}