Template:Varcom: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
m (standard-table --> wikitable with color edits to the header. This means no more huge color contrast with the background.)
No edit summary
 
(13 intermediate revisions by 6 users not shown)
Line 1: Line 1:
{{#switch:{{{1|{{style|color:#f00|'''VARIABLE NAME MISSING!'''}}}}} | start = <!--
{{doc}}
--><table class="wikitable"><!--
-----><tr><!--
--------><th style="background-color:#222;">ConVar/Command</th><!--
--------><th style="background-color:#222;>Parameters or default value</th><!--
--------><th style="background-color:#222;>Descriptor</th><!--
--------><th style="background-color:#222;>Effect</th><!--
-----></tr> | end = </table> | <!--
-----><tr><!--
--------><td><code>{{{1|</code>{{style|color:#f00|'''NAME MISSING!'''}}</td></tr></table><code>}}}</code></td><!--
--------><td><code>{{#ifeq:{{{2|}}}|null|</code>''[blank by default]''<code>|{{{2|}}}}}</code></td><!--
--------><td><strong>{{#ifeq:{{{3|}}}|01|0 disables, 1 enables|<!--
-------------------->{{#ifeq:{{{3|}}}|dist|[[Hammer units]]|<!--
-------------------->{{{3|}}}}}}}</strong></td><!--
--------><td>{{{4|{{todo|Effect description.}}}}}</td><!--
-----></tr>}}<noinclude>
----
This template can be used for both console variables and console commands.


Parameters:
<includeonly>
#Name of the variable or command.
##To generate the header, put <code>start</code> in this space.
##To finish the table, put <code>end</code>.
##If this is not defined, the text {{style|color:#f00|'''NAME MISSING!'''}} will appear and forcibly break the table formatting until it is fixed.
#Parameter(s) of the command, or for variables, the default value.
##Optional.
##Put <code>null</code> to display the text ''[blank by default]''.
#Descriptor for whatever is put in the last space.
##Optional.
##Put <code>01</code> to quickly indicate boolean convars.
##Similarly, use <code>dist</code> for [[Hammer units]].
#Effect of the command or variable.
##If undefined, a TODO will take its place.


<pre>
<onlyinclude>{{#switch: {{{1|{{style|color:#f00|'''VARIABLE NAME MISSING!'''}}}}}
{{varcom|start}}
| start =
{{varcom|noclip|||Makes player ignore gravity and all solidity. Useful for observing and debugging.}}
<table class="wikitable">
{{varcom|sv_cheats|0|01|<code>1</code> enables cheats on the server, which disables achievement progress and enables many more console commands.}}
<tr>
{{varcom|setpos|x y <z optional>|coordinates|Puts the player at the coordinate triplet entered. If <code>z</code> is not specified, the player will maintain their current z position.}}
<th style="background-color:#222;">{{#switch: {{language}}
{{varcom|end}}
| #default = Cvar/Command
</pre>
| zh = 控制台变量/命令
{{varcom|start}}
}}</th>
{{varcom|noclip|||Makes player ignore gravity and all solidity. Useful for observing and debugging.}}
<th style="background-color:#222;">{{#switch: {{language}}
{{varcom|sv_cheats|0|01|<code>1</code> enables cheats on the server, which disables achievement progress and enables many more console commands.}}
| #default = Parameters or default value
{{varcom|setpos|x y <z optional>|coordinates|Puts the player at the coordinate triplet entered. If <code>z</code> is not specified, the player will maintain their current z position.}}
| zh = 参数或默认值
{{varcom|end}}</noinclude>
}}</th>
<th style="background-color:#222;">{{#switch: {{language}}
| #default = Descriptor
| zh = 描述符
}}</th>
<th style="background-color:#222;">{{#switch: {{language}}
| #default = Effect
| zh = 效果
}}</th>
</tr>
| end = </table>
| #default =
<tr>
<td><tt>{{{1|</tt>{{style|color:#f00|'''NAME MISSING!'''}}</td></tr></table><tt>}}}</tt></td>
<td><tt>{{#ifeq: {{{2|}}} | null
| </tt>''[{{#switch: {{language}}
| #default = blank by default
| zh = 默认为空
}}]''<tt>
| {{{2|}}}
}}</tt></td>
<td><strong>{{#switch: {{{3|}}}
| 01 = 0 disables, 1 enables
| dist = [[Hammer units|{{#switch: {{language}}
| #default = Hammer units
| zh = Hammer 单位
}}]]
| #default = {{{3|}}}
}}
</strong></td>
<td>{{{4|{{#switch: {{language}}
| #default = {{todo|Effect description.}}
| zh = {{todo|效果描述。}}
}}}}}</td>
</tr>}}</onlyinclude>
 
</includeonly>
 
<noinclude>[[Category:Templates]]</noinclude>

Latest revision as of 12:16, 9 March 2025

English (en)Deutsch (de)Esperanto (eo)Español (es)Français (fr)Suomi (fi)Hrvatski (hr)Magyar (hu)Italiano (it)日本語 (ja)한국어 (ko)Nederlands (nl)Polski (pl)Português (pt)Português do Brasil (pt-br)Русский (ru)Slovenčina (sk)Svenska (sv)Türkçe (tr)Українська (uk)Tiếng Việt (vi)中文 (zh)中文（臺灣） (zh-tw)
Curly brackets white.pngTemplate Documentation [view] [edit]
Icon-translate.png Available doc translations
View
Page history
…

This template can be used for both console variables (var) and console commands (com).

Parameters

  1. Name of the variable or command.
    1. To generate the header, put start in this space.
    2. To finish the table, put end.
    3. If this is not defined, the text NAME MISSING! will appear and forcibly break the table formatting until it is fixed.
  2. Parameter(s) of the command, or for variables, the default value.
    1. Optional.
    2. Put null to display the text [blank by default].
  3. Descriptor for whatever is put in the last space.
    1. Optional.
    2. Put 01 to quickly indicate boolean convars.
    3. Similarly, use dist for Hammer units.
  4. Effect of the command or variable.
    1. If undefined, a TODO will take its place.

Examples

{{varcom|start}} {{varcom|noclip|||Makes player ignore gravity and all solidity. Useful for observing and debugging.}} {{varcom|sv_cheats|0|01|<code>1</code> enables cheats on the server, which disables achievement progress and enables many more console commands.}} {{varcom|setpos|x y <z optional>|coordinates|Puts the player at the coordinate triplet entered. If <code>z</code> is not specified, the player will maintain their current z position.}} {{varcom|end}}
↓
Cvar/Command Parameters or default value Descriptor Effect
noclip Makes player ignore gravity and all solidity. Useful for observing and debugging.
sv_cheats 0 0 disables, 1 enables 1 enables cheats on the server, which disables achievement progress and enables many more console commands.
setpos x y <z optional> coordinates Puts the player at the coordinate triplet entered. If z is not specified, the player will maintain their current z position.
The above documentation is transcluded from Template:Varcom/doc. (Edit | Page history)
Editors can experiment in this template's sandbox (create | mirror) and testcases (create) pages.
Retrieved from "https://developer.valvesoftware.com/w/index.php?title=Template:Varcom&oldid=466221"