Template:Varcom: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
(eliminating that "arbitrary number" junk)
(added a thing for convars that don't have any default value (yes, that's a thing apparently))
Line 10: Line 10:
-----><tr><!--
-----><tr><!--
--------><td><code>{{{1|</code>{{style|color:#f00|'''NAME MISSING!'''}}</td></tr></table><code>}}}</code></td><!--
--------><td><code>{{{1|</code>{{style|color:#f00|'''NAME MISSING!'''}}</td></tr></table><code>}}}</code></td><!--
--------><td><code>{{{2|}}}</code></td><!--
--------><td><code>{{#ifeq:{{{2|}}}|null|</code>''[blank by default]''<code>|{{{2|}}}}}</code></td><!--
--------><td><strong>{{#ifeq:{{{3|}}}|01|0 disables, 1 enables|{{{3|}}}}}</strong></td><!--
--------><td><strong>{{#ifeq:{{{3|}}}|01|0 disables, 1 enables|{{{3|}}}}}</strong></td><!--
--------><td>{{{4|{{todo|Effect description.}}}}}</td><!--
--------><td>{{{4|{{todo|Effect description.}}}}}</td><!--
Line 24: Line 24:
#Parameter(s) of the command, or for variables, the default value.
#Parameter(s) of the command, or for variables, the default value.
##Optional.
##Optional.
##Put <code>null</code> to display the text ''[blank by default]''.
#Descriptor for whatever is put in the last space.
#Descriptor for whatever is put in the last space.
##Optional.
##Optional.

Revision as of 19:42, 29 August 2018

NAME MISSING!

Todo: Effect description.

This template can be used for both console variables and console commands.

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.
  4. Effect of the command or variable.
    1. If undefined, a TODO will take its place.
{{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}}
ConVar/CommandParameters or
default value
DescriptorEffect
noclipMakes player ignore gravity and all solidity. Useful for observing and debugging.
sv_cheats00 disables, 1 enables1 enables cheats on the server, which disables achievement progress and enables many more console commands.
setposx y <z optional>coordinatesPuts the player at the coordinate triplet entered. If z is not specified, the player will maintain their current z position.