Difference between revisions of "Template:Function"

From the Fallout3 GECK Wiki
Jump to navigation Jump to search
imported>SnakeChomp
m (Move the beginning space out of the check for void type)
imported>SnakeChomp
(Whitespace fix when name is omitted. Documentation beautification.)
Line 5: Line 5:
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]].
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>
  <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.
   origin            = whether the function came from the GECK itself or was added by FOSE.
                       valid values: GECK1 (GECK 1.1), FOSE0001 (FOSE v0001)
                       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, when omitted it's assumed this is the same as the pagename.
   ''name''              = the name of the function. The page name is the default value.
   ''shortname''        = An abbreviated version of the function name that can be
   ''shortname''        = An abbreviated version of the function name that can be
                          used instead of the long name.
                      used instead of the long name.
   ''returnVal ''        = what the function returns
   ''returnVal ''        = what the function returns
   returnType        = the type of the returned value
   returnType        = the type of the returned value. Use void if there is no return 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
   ''arguments''        = List of arguments specified using the [[Template:FunctionArgument]] template, or anything else really.
                      on with the dot syntax
   ''arguments''        = List of arguments specified using the [[Template:FunctionArgument]] template,
                      or any other wiki syntax.
   ''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 38: Line 40:
|returnType = void
|returnType = void
|arguments = {{FunctionArgument
|arguments = {{FunctionArgument
  |Name = Count
    |Name = Count
  |Type = int
    |Type = int
}}{{FunctionArgument
  }}{{FunctionArgument
  |Name = Target
    |Name = Target
  |Type = ref
    |Type = ref
  |Optional = y
    |Optional = y
}}
  }}
}}</pre>
}}</pre>


Line 56: Line 58:
|returnType = void
|returnType = void
|arguments = {{FunctionArgument
|arguments = {{FunctionArgument
  |Name = Count
    |Name = Count
  |Type = int
    |Type = int
}}{{FunctionArgument
  }}{{FunctionArgument
  |Name = Target
    |Name = Target
  |Type = ref
    |Type = ref
  |Optional = y
    |Optional = y
}}
  }}
}}
}}


Line 97: Line 99:


the actual function:
the actual function:
-->{{{name| {{PAGENAME}} }}}<!--
-->{{{name|{{PAGENAME}}}}}<!--


shortname:
shortname:

Revision as of 18:41, 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. The page name is the default value.
 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. Use void if there is no return 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:FunctionArgument template,
                     or any other wiki 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
}}

Example

{{Function
|name = Test
|origin = GECK1
|shortname = tst
|summary = Does stuff
|returnType = void
|arguments = {{FunctionArgument
    |Name = Count
    |Type = int
  }}{{FunctionArgument
    |Name = Target
    |Type = ref
    |Optional = y
  }}
}}

Result

A function included in the GECK version 1.1.0.36.

Description

Does stuff

Syntax

Test(tst) Count:int Target:ref