Difference between revisions of "Template:Function"
Jump to navigation
Jump to search
imported>DragoonWraith |
imported>DragoonWraith (removed (opt)arg#'s, added some comments to the code) |
||
| Line 64: | Line 64: | ||
link to the CS Wiki page | link to the CS Wiki page | ||
-->{{ #if: {{{CSWikiPage|}}} | Link to TES4 Construction Set Wiki: [http://cs.elderscrolls.com/constwiki/index.php/{{{CSWikiPage}}} {{{CSWikiPage}}}].|}}<!-- | -->{{ #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, FOSE0001) | ||
| Line 82: | Line 82: | ||
<!-- return value: | <!-- return value: | ||
--> {{ #ifeq: {{{returnType}}} | void | |({{ #if: {{{returnVal|}}} | {{{returnVal}}}<nowiki>:</nowiki> |}}<!-- | --> {{ #ifeq: {{{returnType}}} | void |<!-- no Return Value -->|({{ #if: {{{returnVal|}}} | {{{returnVal}}}<nowiki>:</nowiki> |}}<!-- | ||
return type (short, float, base object, ref, something else?): | return type (short, float, base object, ref, something else?): | ||
-->{{ #ifeq: {{{returnType|missing}}} | missing | '''missing return type!''' | {{{returnType}}}) | -->{{ #ifeq: {{{returnType|missing}}} | missing | '''missing return type!''' | {{{returnType}}}) }} }}<!-- | ||
optional reference type (actor, activator, door, etc.): | optional reference type (actor, activator, door, etc.): | ||
-->{{ #if: {{{referenceType|}}} |''{{{referenceType}}}.''|}}<!-- | -->{{ #if: {{{referenceType|}}} |''{{{referenceType}}}.''|<!-- no Reference Type -->}}<!-- | ||
the actual function: | the actual function: | ||
| Line 94: | Line 94: | ||
arguments | arguments | ||
-->{{ #if: {{{arguments|}}} | {{{arguments}}} | | -->{{ #if: {{{arguments|}}} | {{{arguments}}} |<!-- no Arguments -->}}<!-- | ||
--> | |||
<!-- FOR ALIAS: return value: | <!-- FOR ALIAS: return value: | ||
-->{{ #if: {{{shortname|}}} | | -->{{ #if: {{{shortname|}}} | | ||
Or: | Or: | ||
{{ #ifeq: {{{returnType}}} | void | |({{ #if: {{{returnVal|}}} | {{{returnVal}}}<nowiki>:</nowiki> |}}<!-- | {{ #ifeq: {{{returnType}}} | void |<!-- no Return Value -->|({{ #if: {{{returnVal|}}} | {{{returnVal}}}<nowiki>:</nowiki> |}}<!-- | ||
return type (short, float, base object, ref, something else?): | return type (short, float, base object, ref, something else?): | ||
-->{{ #ifeq: {{{returnType|missing}}} | missing | '''missing return type!''' | {{{returnType}}}) | -->{{ #ifeq: {{{returnType|missing}}} | missing | '''missing return type!''' | {{{returnType}}}) }} }}<!-- | ||
optional reference type (actor, activator, door, etc.): | optional reference type (actor, activator, door, etc.): | ||
-->{{ #if: {{{referenceType|}}} |''{{{referenceType}}}.''|}}<!-- | -->{{ #if: {{{referenceType|}}} |''{{{referenceType}}}.''|<!-- no Reference Type -->}}<!-- | ||
shortname: | shortname: | ||
| Line 135: | Line 111: | ||
arguments | arguments | ||
-->{{ #if: {{{arguments|}}} | {{{arguments}}} | | -->{{ #if: {{{arguments|}}} | {{{arguments}}} |<!-- no Arguments -->}} |<!-- no Alias -->}}<!-- | ||
--> | |||
--> | |||
example: --> | example: --> | ||
{{ #if: {{{example|}}} | == Example == | {{ #if: {{{example|}}} | == Example == | ||
{{{example}}} |}}<!-- | {{{example}}} |<!-- no Example -->}}<!-- | ||
categorization code (needs something clever): -->{{{CategoryList|}}}</includeonly> | categorization code (needs something clever): -->{{{CategoryList|}}}</includeonly> | ||
Revision as of 17:14, 5 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), 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.
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 Count:int Target:refOr: tst Count:int Target:ref