Difference between revisions of "Template:Function"

From the Fallout3 GECK Wiki
Jump to navigation Jump to search
imported>SnakeChomp
m (Try to remove extraneous newline before function origin)
imported>SnakeChomp
(Small documentation update/format fix)
Line 6: Line 6:
  <nowiki>{{Function|</nowiki>
  <nowiki>{{Function|</nowiki>
   ''CSWikiPage''        = name of corresponding page on the [http://cs.elderscrolls.com/constwiki/index.php/Category:Functions TES CS Wiki]
   ''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)
   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
   summary          = description of the function
   name              = the name of the function
   name              = the name of the function
Line 13: Line 14:
   ''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
   ''arg0''              = the first '''mandatory''' argument
   ''arg0''              = the first '''mandatory''' argument
                       (note that this is optional in the template because not all functions have mandatory arguments)
                       (''arg*'' parameters are optional, not all functions have mandatory arguments)
   ''arg1''              = the second mandatory argument
   ''arg1''              = the second mandatory argument
   ...                (the template currently supports 10 mandatory arguments, arg0 through arg9)
   ...                (the template supports 10 mandatory arguments, arg0 through arg9)
   ''optArg0''          = the first '''optional''' argument
   ''optArg0''          = the first '''optional''' argument
                       (this means it is optional for the scripter)
                       (this means it is optional for the scripter)

Revision as of 12:56, 16 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
 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
                     (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
}}