Difference between revisions of "Template:Modarg"

From DoomRL Wiki

Jump to: navigation, search
m (removing second arg (will be placed into moddef instead)
m (added explanation)
Line 1: Line 1:
 +
<noinclude>
 +
Whenever an input or output argument is required for an API function, one should use <nowiki>{{modarg|arg}}</nowiki> to express it. This also handles cases where links are required. Some examples:
 +
*<nowiki>{{modarg|integer}}</nowiki> &rarr; {{modarg|integer}}
 +
*<nowiki>{{modarg|Being}}</nowiki> &rarr; {{modarg|Being}}
 +
*<nowiki>{{modarg|CoordList}}</nowiki> &rarr; {{modarg|CoordList}}
 +
If there are more links required, feel free to add a line to the template.
 +
</noinclude>
 +
<!--
 
{{#switch: {{{1}}}
 
{{#switch: {{{1}}}
 
   | {{#if: {{#pos:{{{1}}}|Coord}} |{{{1}}} }} =  '''[[Modding:Coord|{{{1}}}]]'''
 
   | {{#if: {{#pos:{{{1}}}|Coord}} |{{{1}}} }} =  '''[[Modding:Coord|{{{1}}}]]'''
Line 8: Line 16:
 
   | '''{{{1}}}'''
 
   | '''{{{1}}}'''
 
}}
 
}}
 +
-->

Revision as of 19:20, 26 January 2012

Whenever an input or output argument is required for an API function, one should use {{modarg|arg}} to express it. This also handles cases where links are required. Some examples:

  • {{modarg|integer}} → integer
  • {{modarg|Being}} → Being
  • {{modarg|CoordList}} → CoordList

If there are more links required, feel free to add a line to the template.


Personal tools