Template:Varcom

From Source Entities
Jump to navigation Jump to search

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] if a variable has no default value (very rare).
  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 World units.
    4. rgb: Red Green Blue
    5. rgba: Red Green Blue Alpha
    6. speed: Units per second
    7. accel: Units per second per second
  4. Effect of the command or variable.
    1. If undefined, a TODO will take its place.

Conveniently (but unintentionally), lines with syntax errors may show themselves at the top of the table in plaintext.

{{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 valueParameter TypeEffect
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.