Template:This is a
From Valve Developer Community
Jump to navigation
Jump to search
This template is used on approximately 2,800 pages and changes may be widely noticed.
Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage.Consider discussing changes on the talk page before implementing them.
This is a {{{1}}} available in all 
Source games.
Available doc translations 
This template uses a strings subpage
Please follow the format on this subpage(s) to add translations.
Please follow the format on this subpage(s) to add translations.
Number of strings:32
Approximate status of translation: 96.88% 84.38% 68.75% 53.13% 78.13% 96.88% 81.25% 96.88% 81.25% 84.38%
Approximate status of translation:
96.88% 84.38% 68.75% 53.13% 78.13% 96.88% 81.25% 96.88% 81.25% 84.38% 
This template uses a Testcases subpage
You can test how this page looks with it's different skins and parsers.
You can test how this page looks with it's different skins and parsers.
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.
Parameters and Examples
*: Necessary parameters.
Note:Previews are placed in full-width rows for better readability.| Parameter | Description | Example |
|---|---|---|
| *{{{1}}} | The type of the object need to describe. The following types are available: Entities:
Console Variables, Commands, QC Commands:
Miscellaneous:
Note:Template will not add entity categories when using non-entity type (such as console variable). |
{{this is a|''incredible entity''}} {{this is a|brush entity|engine=GoldSrc}} {{this is a|console variable|name=sv_cheats}} {{this is a|pixel shader|name=LightmappedGeneric}} |
This is a incredible entity available in all
Source games. | ||
| {{{shader}}} {{{shader1}}}~{{{shader5}}} |
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 is a material shader parameter for the VertexLitGeneric shader available in  Source 2013 Multiplayer and  Garry's Mod. | ||
| {{{dx}}} | 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}} |
$lightwarptexture (DX8) is a material shader parameter for the VertexLitGeneric shader available in all Source games since  Source 2006. $lightwarptexture (DX9 SM2) is a material shader parameter for the VertexLitGeneric shader available in all Source games since Source 2006. $lightwarptexture (DX9+ SM3) is a material shader parameter for the VertexLitGeneric shader available in all Source games since Source 2006. | ||
| {{{engine}}} {{{engine1}}} {{{engine2}}} |
Which engine the subject belongs to.
 Important:To add multiple engines, please use parameter {{{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}} |
| {{{except}}} | This is available in all other games except this one. Note:Works without {{{game}}}. |
{{this is a|brush entity|name=func_monitor|except=Left 4 Dead series}} |
| {{{since}}} | This is available since this game. Note:Works without {{{game}}}. |
{{this is a|point entity|name=info_player_start|engine=GoldSrc|since=Half-Life}} |
| {{{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}} |
| {{{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}} |
| {{{series}}} | The series that the subject is available in. | {{this is a|brush entity|series=Counter-Strike}} |
| {{{game}}} | The game that the subject is available in. Note:Works without {{{series}}}. Warning:Do not use short name (such as 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}} |
This is a path entity available in
 Team Fortress 2. | ||
| {{{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}} |
| {{{internal}}} | If enabled, "cut" will be displayed before "entity" and a category will be added to the page. | {{this is a|entity|internal=1}} |
| {{{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}} |
| {{{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}} |
| {{{sprite}}} | The icon of the entity:
|
{{this is a|point entity|name=logic_script|sprite=1}} |
| {{{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}} |
| {{{name1}}} ~ {{{name5}}} | If the entity name is similar to another entity and functions the same, like terrorist_team_intro and counterterrorist_team_intro, use these parameters. Note:Once you have used the {{{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 and counterterrorist_team_intro are point entities available in  Counter-Strike 2. | ||
| {{{game1}}} ~ {{{game5}}} | If this is available in multiple games, use these parameters to describe. Note:Once you have used the {{{game1}}}, the style of the template will be changed. The {{{game}}} is necessary for displaying the first game.Note:Works without {{{series}}}.Warning:Do not use short name (such as 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}} {{this is a|point entity|name=info_survivor_position|game=Left 4 Dead|game1=Left 4 Dead 2}} |
This is a point entity available in
 Left 4 Dead,  Left 4 Dead 2,  Portal 2, Team Fortress 2, Portal 2, and  Counter-Strike: Global Offensive. | ||
| {{{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 {{{except}}}, but can specify multiple games simultaneously. Note:Unsupport placing categories. |
{{this is a|point entity|name=1|except-multi={{l4d}}{{hl2}}{{csgo}}}} |
The above documentation is transcluded from Template:This is a/doc. (Edit | Page history)
Editors can experiment in this template's sandbox (edit) and testcases (edit) pages.
Editors can experiment in this template's sandbox (edit) and testcases (edit) pages.
Hidden category: