Template:Varcom/doc: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
1416006136 (talk | contribs) (update) |
||
| Line 1: | Line 1: | ||
{{documentation subpage}} | |||
This template can be used for both console variables and console commands. | This template can be used for both console variables and console commands. | ||
Parameters | == Parameters == | ||
#Name of the variable or command. | #Name of the variable or command. | ||
##To generate the header, put <code>start</code> in this space. | ##To generate the header, put <code>start</code> in this space. | ||
| Line 15: | Line 16: | ||
#Effect of the command or variable. | #Effect of the command or variable. | ||
##If undefined, a TODO will take its place. | ##If undefined, a TODO will take its place. | ||
#Language suffix. | |||
##The parameter - {{param|suf}}. You can specify it to {{para|suf|:<lang code>}} and the template will use the translations (if exist). It should be used for every part of the template if you want to use the other languages. | |||
< | == Examples == | ||
{{varcom|start}} | {{MdCodeBlock|<nowiki>{{varcom|start}} | ||
{{varcom|noclip|||Makes player ignore gravity and all solidity. Useful for observing and debugging.}} | {{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|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|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}} | {{varcom|end}}</nowiki>}} | ||
</ | <div align="center>↓</div> | ||
{{varcom|start}} | {{Doc/PreviewBlock|padding=2px 10px 2px 10px|style=border: 1px solid rgba(255,255,255,.2); box-shadow: 0 5px 10px rgba(0,0,0,.5)|{{varcom|start}} | ||
{{varcom|noclip|||Makes player ignore gravity and all solidity. Useful for observing and debugging.}} | {{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|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|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}} | {{varcom|end}}}} | ||
{{MdCodeBlock|<nowiki>{{varcom|suf=:zh-cn|start}} | |||
{{varcom|suf=:zh-cn|noclip|||Makes player ignore gravity and all solidity. Useful for observing and debugging.}} | |||
{{varcom|suf=:zh-cn|sv_cheats|0|01|<code>1</code> enables cheats on the server, which disables achievement progress and enables many more console commands.}} | |||
{{varcom|suf=:zh-cn|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|suf=:zh-cn|end}}</nowiki>}} | |||
<div align="center>↓</div> | |||
{{Doc/PreviewBlock|padding=2px 10px 2px 10px|style=border: 1px solid rgba(255,255,255,.2); box-shadow: 0 5px 10px rgba(0,0,0,.5)|{{varcom|suf=:zh-cn|start}} | |||
{{varcom|suf=:zh-cn|noclip|||Makes player ignore gravity and all solidity. Useful for observing and debugging.}} | |||
{{varcom|suf=:zh-cn|sv_cheats|0|01|<code>1</code> enables cheats on the server, which disables achievement progress and enables many more console commands.}} | |||
{{varcom|suf=:zh-cn|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|suf=:zh-cn|end}}}} | |||
Revision as of 01:04, 10 January 2023
This is a documentation subpage for Template:Varcom.
Don't forget to purge the contents of the base page upon creating or editing this subpage.
Don't forget to purge the contents of the base page upon creating or editing this subpage.
This template can be used for both console variables and console commands.
Parameters
- Name of the variable or command.
- To generate the header, put
startin this space. - To finish the table, put
end. - If this is not defined, the text NAME MISSING! will appear and forcibly break the table formatting until it is fixed.
- To generate the header, put
- Parameter(s) of the command, or for variables, the default value.
- Optional.
- Put
nullto display the text [blank by default].
- Descriptor for whatever is put in the last space.
- Optional.
- Put
01to quickly indicate boolean convars. - Similarly, use
distfor Hammer units.
- Effect of the command or variable.
- If undefined, a TODO will take its place.
- Language suffix.
- The parameter - {{{suf}}}. You can specify it to
|suf=:<lang code>and the template will use the translations (if exist). It should be used for every part of the template if you want to use the other languages.
- The parameter - {{{suf}}}. You can specify it to
Examples
↓
| 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. |
↓
| 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. |