Template:This is a/doc
This template is the master format page for all Entity, Console command/variable, and Shader pages. Each page should have this at the beginning to describe the basic info about each one, such as what they are and their availability.
Usage
This template is usually written in a single line. To use it, insert {{This is a}}
into the desired page and specify the parameters to the right of the template name in the following format: {{This is a|parameter 1 = value|parameter 2 = value}}
.
Parameters and Examples
*: Necessary parameters.
Parameter | Description | Example | Preview |
---|---|---|---|
*
|
The type of the object need to describe. The following types are available:
Console Variables, Commands, QC Commands:
Miscellaneous:
![]() console variable ). |
{{this is a|''incredible entity''}} {{this is a|brush entity|engine=GoldSrc|nocat=1}} {{this is a|console variable|name=sv_cheats|notitlechange=1|nocat=1}} {{this is a|pixel shader|name=LightmappedGeneric|notitlechange=1|nocat=1}} |
Dies ist ein incredible entity verwendbar in alle |
|
The shader that a parameter is in (only works if {{{1}}} is equal to shader parameter ). Extra parameters allow you to specify multiple shaders. |
{{this is a|shader parameter|name=$lightmap|shader=VertexLitGeneric|game=Source 2013 Multiplayer|game1=Garry's Mod}} |
$lightmap ist ein Material Shader-Parameter verwendbar in ![]() ![]() |
|
Add DirectX levels inline text. Available versions:
|
{{this is a|shader parameter|dx=dx8|name=$lightwarptexture|shader=VertexLitGeneric|since=Source 2006}} {{this is a|shader parameter|dx=dx9|name=$lightwarptexture|shader=VertexLitGeneric|since=Source 2006}} {{this is a|shader parameter|dx=dx95|name=$lightwarptexture|shader=VertexLitGeneric|since=Source 2006}} |
|
|
Which engine the subject belongs to. ![]() {{{engine1}}} (secondary engine) and {{{engine2}}} (tertiary engine) with {{{engine}}} (primary engine) at the same time. |
{{this is a|point entity|engine=GoldSrc|engine1=Source}} {{this is a|point entity|engine=GoldSrc|engine1=Source|engine2=Source 2}} |
Dies ist ein Punkt-Objekt verwendbar in alle |
{{{except}}} |
This is available in all other games except this one. ![]() {{{game}}} . |
{{this is a|brush entity|name=func_monitor|except=Left 4 Dead series}} |
func_monitor ist ein Volumen-Objekt verwendbar in alle ![]() ![]() ![]() |
{{{since}}} |
This is available since this game. ![]() {{{game}}} . |
{{this is a|point entity|name=info_player_start|engine=GoldSrc|since=Half-Life}} |
info_player_start ist ein Punkt-Objekt verwendbar in alle ![]() ![]() |
{{{name}}} |
The name of the subject. It will change the title of a page. If unspecified, the sentence will just refer to the subject as "this." | {{this is a|point entity|name=info_player_start}} |
info_player_start ist ein Punkt-Objekt verwendbar in alle ![]() |
{{{this}}} |
If set to 0, false, etc. then the sentence will not start with the word "this." Has no effect if {{{name}}} has been specified. | {{this is a|point entity|this=false}} |
ist ein Punkt-Objekt verwendbar in alle ![]() |
{{{series}}} |
The series that the subject is available in. | {{this is a|brush entity|series=Counter-Strike}} |
Dies ist ein Volumen-Objekt verwendbar in ![]() ![]() |
{{{game}}} |
The game that the subject is available in. ![]() {{{series}}} .![]() hl2 instead of Half-Life 2 ), otherwise the page will be added to Category:Hl2 point entities instead of Category:Half-Life 2 point entities. |
{{this is a|path entity|game=Team Fortress 2}} |
Dies ist ein Pfad-Objekt verwendbar in ![]() |
{{{notitlechange}}} |
You can prevent title-changing from the template by using this parameter. Used in the /doc page. |
{{this is a|point entity|notitlechange=1|name=info_player_start|engine=GoldSrc|since=Half-Life}} |
info_player_start ist ein Punkt-Objekt verwendbar in alle ![]() ![]() |
{{{internal}}} |
If enabled, "cut" will be displayed before "entity" and a category will be added to the page. | {{this is a|entity|internal=1}} |
Dies ist ein internes Objekt verwendbar in alle ![]() |
{{{semi-internal}}} |
If enabled, "cut" will be displayed before "entity" and a category will be added to the page. | {{this is a|entity|semi-internal=1}} |
Dies ist ein Objekt verwendbar in alle ![]() |
{{{cut}}} |
If enabled, "cut" will be displayed before "(internal) ... entity" and a category will be added to the page. | {{this is a|cut=1|internal=1|entity}} |
Dies ist ein entferntes internes Objekt verwendbar in alle ![]() |
{{{sprite}}} |
The icon of the entity:
|
{{this is a|point entity|name=logic_script|sprite=1}} |
![]() logic_script ist ein Punkt-Objekt verwendbar in alle ![]() |
{{{icon}}} |
Make the game icon appear left-aligned.
|
{{this is a|point entity|name=info_survivor_position|icon=Left 4 Dead series|type=point entity|series=Left 4 Dead}} |
![]() ![]() info_survivor_position ist ein Punkt-Objekt verwendbar in ![]() ![]() |
{{{name1}}} ~ {{{name5}}} |
If the entity name is similar to another entity and functions the same, like ![]() {{{name1}}} , the style of the template will be changed. The {{{name}}} is necessary for displaying the first name. |
{{this is a|point entity|name=terrorist_team_intro|name1=counterterrorist_team_intro|game=Counter-Strike 2}} |
terrorist_team_intro und counterterrorist_team_intro ist ein Punkt-Objekt verwendbar in ![]() |
{{{game1}}} ~ {{{game5}}} |
If this is available in multiple games, use these parameters to describe. ![]() {{{game1}}} , the style of the template will be changed. The {{{game}}} is necessary for displaying the first game.![]() {{{series}}} .![]() hl2 instead of Half-Life 2 ), otherwise the page will be added to Category:Hl2 point entities instead of Category:Half-Life 2 point entities. |
{{this is a|point entity|game=Left 4 Dead|game1=Left 4 Dead 2|game2=Portal 2|game3=Team Fortress 2|game4=Portal 2|game5=Counter-Strike: Global Offensive}} |
Dies ist ein Punkt-Objekt verwendbar in ![]() ![]() ![]() ![]() ![]() ![]() |
{{{nocat}}} |
Don't place any categories. | {{this is a|point entity|name=info_player_start|nocat=1}} |
N/A |
{{{no-non-int}}} |
Don't place it in Category:Non-internal {{{in|}}} entities. | {{this is a|point entity|name=info_player_start|no-non-int=1}} |
N/A |
{{{except-multi}}} |
Similar to ![]() |
{{this is a|point entity|name=1|except-multi={{l4d}}{{hl2}}{{csgo}}}} |
1 ist ein Punkt-Objekt verwendbar in alle ![]() ![]() ![]() ![]() |
Components
This template uses components to simplify working with repetitive code. Below is a list of all components included in the template.