Difference between revisions of "Template:Function"
Jump to navigation
Jump to search
imported>SnakeChomp m (Note on new arguments parameter. CategoryList is technically optional) |
imported>DragoonWraith (testing alternative for alias) |
||
| Line 100: | Line 100: | ||
the actual function: | the actual function: | ||
-->{{{name|{{PAGENAME}}}}}<!-- | -->{{{name|{{PAGENAME}}}}}<!-- | ||
arguments | |||
-->{{ #if: {{{arguments|}}} | {{{arguments}}} |}}<!-- | |||
required arguments + types: | |||
-->{{ #if: {{{arg0|}}} | {{{arg0}}}:{{{arg0Type}}} |}}<!-- | |||
-->{{ #if: {{{arg1|}}} | {{{arg1}}}:{{{arg1Type}}} |}}<!-- | |||
-->{{ #if: {{{arg2|}}} | {{{arg2}}}:{{{arg2Type}}} |}}<!-- | |||
-->{{ #if: {{{arg3|}}} | {{{arg3}}}:{{{arg3Type}}} |}}<!-- | |||
-->{{ #if: {{{arg4|}}} | {{{arg4}}}:{{{arg4Type}}} |}}<!-- | |||
-->{{ #if: {{{arg5|}}} | {{{arg5}}}:{{{arg5Type}}} |}}<!-- | |||
-->{{ #if: {{{arg6|}}} | {{{arg6}}}:{{{arg6Type}}} |}}<!-- | |||
-->{{ #if: {{{arg7|}}} | {{{arg7}}}:{{{arg7Type}}} |}}<!-- | |||
-->{{ #if: {{{arg8|}}} | {{{arg8}}}:{{{arg8Type}}} |}}<!-- | |||
-->{{ #if: {{{arg9|}}} | {{{arg9}}}:{{{arg9Type}}} |}}<!-- | |||
optional arguments + types: | |||
-->{{ #if: {{{optarg0|}}} | ''{{{optarg0}}}:{{{optarg0Type}}}'' |}}<!-- | |||
-->{{ #if: {{{optarg1|}}} | ''{{{optarg1}}}:{{{optarg1Type}}}'' |}}<!-- | |||
-->{{ #if: {{{optarg2|}}} | ''{{{optarg2}}}:{{{optarg2Type}}}'' |}}<!-- | |||
-->{{ #if: {{{optarg3|}}} | ''{{{optarg3}}}:{{{optarg3Type}}}'' |}}<!-- | |||
-->{{ #if: {{{optarg4|}}} | ''{{{optarg4}}}:{{{optarg4Type}}}'' |}}<!-- | |||
-->{{ #if: {{{optarg5|}}} | ''{{{optarg5}}}:{{{optarg5Type}}}'' |}}<!-- | |||
-->{{ #if: {{{optarg6|}}} | ''{{{optarg6}}}:{{{optarg6Type}}}'' |}}<!-- | |||
-->{{ #if: {{{optarg7|}}} | ''{{{optarg7}}}:{{{optarg7Type}}}'' |}}<!-- | |||
-->{{ #if: {{{optarg8|}}} | ''{{{optarg8}}}:{{{optarg8Type}}}'' |}}<!-- | |||
-->{{ #if: {{{optarg9|}}} | ''{{{optarg9}}}:{{{optarg9Type}}}'' |}}<!-- | |||
<!-- FOR ALIAS: return value: | |||
--> {{ #ifeq: {{{returnType}}} | void | |({{ #if: {{{returnVal|}}} | {{{returnVal}}}<nowiki>:</nowiki> |}}<!-- | |||
return type (short, float, base object, ref, something else?): | |||
-->{{ #ifeq: {{{returnType|missing}}} | missing | '''missing return type!''' | {{{returnType}}}) |}} }}<!-- | |||
optional reference type (actor, activator, door, etc.): | |||
-->{{ #if: {{{referenceType|}}} |''{{{referenceType}}}.''|}}<!-- | |||
shortname: | shortname: | ||
Revision as of 16:20, 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. Use this or the arg0-arg9 parameters.
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 Count:int Target:ref (tst) Count:int Target:ref