Template:CLParam/doc: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
mNo edit summary
(CLA's don't always start with a hyphen)
Line 1: Line 1:
Template meant to be used for Command line options.
Template meant to be used for Command line options.


* {{param|1}} - name of the CLI option, symbol "-" automatically added before it
* {{param|1}} - name of the CLI option
* {{param|2}} - description
* {{param|2}} - description
* {{param|param}} - parameter type see {{T|VT}} for possible choices
* {{param|param}} - parameter type see {{T|VT}} for possible choices
Line 10: Line 10:
format of this template
format of this template
<pre>
<pre>
  -{{{1}}} <{{{param}}}> {{{game}}}
  {{{1}}} <{{{param}}}> {{{game}}}
     {{{2}}}
     {{{2}}}
</pre>
</pre>

Revision as of 08:23, 23 March 2025

Template meant to be used for Command line options.

  • {{{1}}} - name of the CLI option
  • {{{2}}} - description
  • {{{param}}} - parameter type see {{VT}} for possible choices
  • {{{game}}} - what games/source version is the option available in use, specify using {{only}}, {{in}}, {{also}}, {{since}} or {{not}} templates

game={{since|{{csgo}}}}{{also|{{tf2}}{{l4d2}}}} (in all games since Counter-Strike: Global Offensive)(also in Team Fortress 2Left 4 Dead 2)

  • {{{deprecated}}} - mark as deprecated

format of this template

 {{{1}}} <{{{param}}}> {{{game}}}
    {{{2}}}

example

{{CLParam|something|param=int|This param does something idk|game={{only|{{csgo}}}}}}

something <integer> (only in Counter-Strike: Global Offensive)
This param does something idk