Difference between revisions of "Template:Function"

2,779 bytes removed ,  18:14, 5 February 2009
removed (opt)arg#'s, added some comments to the code
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}}})&nbsp; |}} }}<!--
-->{{ #ifeq: {{{returnType|missing}}} | missing | '''missing return type!''' | {{{returnType}}})&nbsp; }} }}<!--


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 -->}}<!--
 
required arguments + types:
-->{{ #if: {{{arg0|}}} | &nbsp;{{{arg0}}}:{{{arg0Type}}} |}}<!--
-->{{ #if: {{{arg1|}}} | &nbsp;{{{arg1}}}:{{{arg1Type}}} |}}<!--
-->{{ #if: {{{arg2|}}} | &nbsp;{{{arg2}}}:{{{arg2Type}}} |}}<!--
-->{{ #if: {{{arg3|}}} | &nbsp;{{{arg3}}}:{{{arg3Type}}} |}}<!--
-->{{ #if: {{{arg4|}}} | &nbsp;{{{arg4}}}:{{{arg4Type}}} |}}<!--
-->{{ #if: {{{arg5|}}} | &nbsp;{{{arg5}}}:{{{arg5Type}}} |}}<!--
-->{{ #if: {{{arg6|}}} | &nbsp;{{{arg6}}}:{{{arg6Type}}} |}}<!--
-->{{ #if: {{{arg7|}}} | &nbsp;{{{arg7}}}:{{{arg7Type}}} |}}<!--
-->{{ #if: {{{arg8|}}} | &nbsp;{{{arg8}}}:{{{arg8Type}}} |}}<!--
-->{{ #if: {{{arg9|}}} | &nbsp;{{{arg9}}}:{{{arg9Type}}} |}}<!--
 
optional arguments + types:
-->{{ #if: {{{optarg0|}}} | &nbsp;''{{{optarg0}}}:{{{optarg0Type}}}'' |}}<!--
-->{{ #if: {{{optarg1|}}} | &nbsp;''{{{optarg1}}}:{{{optarg1Type}}}'' |}}<!--
-->{{ #if: {{{optarg2|}}} | &nbsp;''{{{optarg2}}}:{{{optarg2Type}}}'' |}}<!--
-->{{ #if: {{{optarg3|}}} | &nbsp;''{{{optarg3}}}:{{{optarg3Type}}}'' |}}<!--
-->{{ #if: {{{optarg4|}}} | &nbsp;''{{{optarg4}}}:{{{optarg4Type}}}'' |}}<!--
-->{{ #if: {{{optarg5|}}} | &nbsp;''{{{optarg5}}}:{{{optarg5Type}}}'' |}}<!--
-->{{ #if: {{{optarg6|}}} | &nbsp;''{{{optarg6}}}:{{{optarg6Type}}}'' |}}<!--
-->{{ #if: {{{optarg7|}}} | &nbsp;''{{{optarg7}}}:{{{optarg7Type}}}'' |}}<!--
-->{{ #if: {{{optarg8|}}} | &nbsp;''{{{optarg8}}}:{{{optarg8Type}}}'' |}}<!--
-->{{ #if: {{{optarg9|}}} | &nbsp;''{{{optarg9}}}:{{{optarg9Type}}}'' |}}<!--


<!-- 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}}})&nbsp; |}} }}<!--
-->{{ #ifeq: {{{returnType|missing}}} | missing | '''missing return type!''' | {{{returnType}}})&nbsp; }} }}<!--


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 -->}}<!--
 
required arguments + types:
-->{{ #if: {{{arg0|}}} | &nbsp;{{{arg0}}}:{{{arg0Type}}} |}}<!--
-->{{ #if: {{{arg1|}}} | &nbsp;{{{arg1}}}:{{{arg1Type}}} |}}<!--
-->{{ #if: {{{arg2|}}} | &nbsp;{{{arg2}}}:{{{arg2Type}}} |}}<!--
-->{{ #if: {{{arg3|}}} | &nbsp;{{{arg3}}}:{{{arg3Type}}} |}}<!--
-->{{ #if: {{{arg4|}}} | &nbsp;{{{arg4}}}:{{{arg4Type}}} |}}<!--
-->{{ #if: {{{arg5|}}} | &nbsp;{{{arg5}}}:{{{arg5Type}}} |}}<!--
-->{{ #if: {{{arg6|}}} | &nbsp;{{{arg6}}}:{{{arg6Type}}} |}}<!--
-->{{ #if: {{{arg7|}}} | &nbsp;{{{arg7}}}:{{{arg7Type}}} |}}<!--
-->{{ #if: {{{arg8|}}} | &nbsp;{{{arg8}}}:{{{arg8Type}}} |}}<!--
-->{{ #if: {{{arg9|}}} | &nbsp;{{{arg9}}}:{{{arg9Type}}} |}}<!--
 
optional arguments + types:
-->{{ #if: {{{optarg0|}}} | &nbsp;''{{{optarg0}}}:{{{optarg0Type}}}'' |}}<!--
-->{{ #if: {{{optarg1|}}} | &nbsp;''{{{optarg1}}}:{{{optarg1Type}}}'' |}}<!--
-->{{ #if: {{{optarg2|}}} | &nbsp;''{{{optarg2}}}:{{{optarg2Type}}}'' |}}<!--
-->{{ #if: {{{optarg3|}}} | &nbsp;''{{{optarg3}}}:{{{optarg3Type}}}'' |}}<!--
-->{{ #if: {{{optarg4|}}} | &nbsp;''{{{optarg4}}}:{{{optarg4Type}}}'' |}}<!--
-->{{ #if: {{{optarg5|}}} | &nbsp;''{{{optarg5}}}:{{{optarg5Type}}}'' |}}<!--
-->{{ #if: {{{optarg6|}}} | &nbsp;''{{{optarg6}}}:{{{optarg6Type}}}'' |}}<!--
-->{{ #if: {{{optarg7|}}} | &nbsp;''{{{optarg7}}}:{{{optarg7Type}}}'' |}}<!--
-->{{ #if: {{{optarg8|}}} | &nbsp;''{{{optarg8}}}:{{{optarg8Type}}}'' |}}<!--
-->{{ #if: {{{optarg9|}}} | &nbsp;''{{{optarg9}}}:{{{optarg9Type}}}'' |}} |}}<!--


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>