Template:Function
Revision as of 18:17, 5 February 2009 by imported>DragoonWraith (pre tags instead of leading space)
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
{{ #ifeq: {{{returnType}}} | void |<!-- no Return Value -->|({{ #if: {{{returnVal|}}} | {{{returnVal}}}: |}}<!-- 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}}}.''|<!-- no Reference Type -->}}<!-- the actual function: -->{{{name|{{PAGENAME}}}}}<!-- arguments -->{{ #if: {{{arguments|}}} | {{{arguments}}} |<!-- no Arguments -->}}
Or:
{{ #ifeq: {{{returnType}}} | void |<!-- no Return Value -->|({{ #if: {{{returnVal|}}} | {{{returnVal}}}: |}}<!-- 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}}}.''|<!-- no Reference Type -->}}<!-- shortname: -->{{{shortname}}}<!-- arguments -->{{ #if: {{{arguments|}}} | {{{arguments}}} |<!-- no Arguments -->}}