Template:Varcom: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
(added a thing for convars that don't have any default value (yes, that's a thing apparently))
m (removed odd formatting stuff)
Line 3: Line 3:
-----><tr><!--
-----><tr><!--
--------><th>ConVar/Command</th><!--
--------><th>ConVar/Command</th><!--
--------><th>Parameters or<br /><!--
--------><th>Parameters or default value</th><!--
-------->default value</th><!--
--------><th>Descriptor</th><!--
--------><th style="width:15em">Descriptor</th><!--
--------><th>Effect</th><!--
--------><th>Effect</th><!--
-----></tr> | end = </table> | <!--
-----></tr> | end = </table> | <!--

Revision as of 00:54, 7 September 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 valueDescriptorEffect
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.