Template:CLParam/doc: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
m (Nescius moved page Template:CLIO/doc to Template:CLParam/doc without leaving a redirect)
mNo edit summary
Line 15: Line 15:


== example ==
== example ==
<code><nowiki>{{CLIO|something|param=int|This param does something idk|game={{only|{{csgo}}}}}}</nowiki></code>
<code><nowiki>{{CLParam|something|param=int|This param does something idk|game={{only|{{csgo}}}}}}</nowiki></code>
{{CLIO|something|param=int|This param does something idk|game={{only|{{csgo}}}}}}
{{CLParam|something|param=int|This param does something idk|game={{only|{{csgo}}}}}}

Revision as of 00:31, 21 March 2025

Template meant to be used for Command line options.

  • {{{1}}} - name of the CLI option, symbol "-" automatically added before it
  • {{{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