Difference between revisions of "Template:Function"

From the Fallout3 GECK Wiki
Jump to navigation Jump to search
imported>SnakeChomp
(Update returnType docs to indicate its optional and don't mention void anymore.)
imported>Illyism
(changed FOSE to final version, V1)
Line 8: Line 8:
   ''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), FOSE1 (FOSE v1)
   summary          = description of the function
   summary          = description of the function
   ''name''              = the name of the function. The page name is the default value.
   ''name''              = the name of the function. The page name is the default value.
Line 66: Line 66:
-->{{ #if: {{{CSWikiPage|}}} | Link to TES4 Construction Set Wiki: [http://cs.elderscrolls.com/constwiki/index.php/{{{CSWikiPage}}} {{{CSWikiPage}}}].|<!-- no CSwiki page -->}}<!--
-->{{ #if: {{{CSWikiPage|}}} | Link to TES4 Construction Set Wiki: [http://cs.elderscrolls.com/constwiki/index.php/{{{CSWikiPage}}} {{{CSWikiPage}}}].|<!-- no CSwiki page -->}}<!--


line about the origin of the function (GECK1, FOSE0001)
line about the origin of the function (GECK1, FOSE1)
-->
-->
{{ #switch: {{{origin}}}
{{ #switch: {{{origin}}}
| GECK1    = A function included in the GECK version 1.1.0.36.
| GECK1    = A function included in the GECK version 1.1.0.36.
| FOSE0001 = A function added by the [[Fallout Script Extender]].
| FOSE1 = A function added by the [[Fallout Script Extender]].
| #default = {{Error|missing function origin info}}
| #default = {{Error|missing function origin info}}
}}<!--
}}<!--

Revision as of 10:22, 24 February 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), FOSE1 (FOSE v1)
 summary           = description of the function
 name              = the name of the function. The page name is the default value.
 alias             = 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:FunctionArgument template,
                     or any other wiki syntax.
 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
|alias = 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 Count:int Target:ref 

Or:

tst Count:int Target:ref