View source for Template:This is a/doc

{{Doc/subpage}}
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 ==
<strong style="color:rgb(255,255,0)">'''<nowiki>*</nowiki>'''</strong>: Necessary parameters.</sub>

{{Note|Previews are placed in full-width rows for better readability.}}

{| class=standard-table | style="width:100%;"
|-
! Parameter
! width="45%" | Description
! Example
|-
|align="center"|<strong style="color:rgb(255,255,0)">'''<nowiki>*</nowiki>'''</strong>{{Code|preset=2|{{param|1}}}}
| The type of the object need to describe. The following types are available:<br>
'''Entities:'''
* {{code|entity}} - [[Entity]]
* {{Code|point entity}} - [[Point entity]]
* {{Code|brush entity}} - [[Brush entity]] {{not|{{src2}}}}
* {{Code|mesh entity}} - [[Mesh entity]] ({{source2}})
* {{Code|path entity}} - [[Path entity]] ({{source2}})
'''Console Variables, Commands, QC Commands:'''
* {{Code|console variable}} - [[console variable|Console Variables]]
* {{Code|console command}} - [[Developer_Console#Submitting|Console Commands]]
* {{Code|QC command}} - [[QC command]]
* {{code|pixel shader}} - [[Shader#Pixel shaders]]
* {{code|vertex shader}} - [[Shader#Vertex shaders]]
* {{code|shader parameter}} - [[material]] [[shader]] parameter
Miscellaneous:
* Custom (You can specify the type yourself. See examples)
{{Note|Template will not add entity categories when using non-entity type (such as {{Code|console variable}}).}}
|
{{CodeBlock|<nowiki>{{this is a|''incredible entity''}}</nowiki>}}
{{CodeBlock|<nowiki>{{this is a|brush entity|engine=GoldSrc}}</nowiki>}}
{{CodeBlock|<nowiki>{{this is a|console variable|name=sv_cheats}}</nowiki>}}
{{CodeBlock|<nowiki>{{this is a|pixel shader|name=LightmappedGeneric}}</nowiki>}}
|-
| colspan=3 style="background-color: #2f2f2f" |{{Capsule|style=2|margin=5px|{{this is a|''incredible entity''}}}}
{{Capsule|style=2|margin=5px|{{this is a|brush entity|engine=GoldSrc|nocat=1}}}}
{{Capsule|style=2|margin=5px|{{this is a|console variable|name=sv_cheats|notitlechange=1|nocat=1}}}}
{{Capsule|style=2|margin=5px|{{this is a|pixel shader|name=LightmappedGeneric|notitlechange=1|nocat=1}}}}
|-
|align="center"|{{Code|preset=2|{{param|shader}}}}<br>{{Code|preset=2|{{param|shader1}}}}~{{Code|preset=2|{{param|shader5}}}}
| The shader that a parameter is in (only works if {{param|1}} is equal to {{code|shader parameter}}). Extra parameters allow you to specify multiple shaders.
| {{CodeBlock|<nowiki>{{this is a|shader parameter|name=$lightmap|shader=VertexLitGeneric|game=Source 2013 Multiplayer|game1=Garry's Mod}}</nowiki>}}
|-
| colspan=3 style="background-color: #2f2f2f" | {{Capsule|style=2|margin=5px|{{this is a|shader parameter|name=$lightmap|shader=VertexLitGeneric|game=Source 2013 Multiplayer|game1=Garry's Mod|notitlechange=1|nocat=1}} }}
|-
|align="center"|{{Code|preset=2|{{param|dx}}}}
| Add [[DirectX Versions|DirectX levels]] inline text.
Available versions:
* DirectX 8 - {{code|dx8}}
* DirectX 9 (SM 2.0)- {{code|dx9}}
* DirectX 9.0c (SM 3.0) - {{code|dx95}} or {{code|dx90c}}
| {{CodeBlock|<nowiki>{{this is a|shader parameter|dx=dx8|name=$lightwarptexture|shader=VertexLitGeneric|since=Source 2006}}</nowiki>}}
{{CodeBlock|<nowiki>{{this is a|shader parameter|dx=dx9|name=$lightwarptexture|shader=VertexLitGeneric|since=Source 2006}}</nowiki>}}
{{CodeBlock|<nowiki>{{this is a|shader parameter|dx=dx95|name=$lightwarptexture|shader=VertexLitGeneric|since=Source 2006}}</nowiki>}}
|-
| colspan=3 style="background-color: #2f2f2f" | {{Capsule|style=2|margin=5px|{{this is a|shader parameter|dx=dx8|name=$lightwarptexture|shader=VertexLitGeneric|since=Source 2006|notitlechange=1|nocat=1}} }}
{{Capsule|style=2|margin=5px|{{this is a|shader parameter|dx=dx9|name=$lightwarptexture|shader=VertexLitGeneric|since=Source 2006|notitlechange=1|nocat=1}} }}
{{Capsule|style=2|margin=5px|{{this is a|shader parameter|dx=dx95|name=$lightwarptexture|shader=VertexLitGeneric|since=Source 2006|notitlechange=1|nocat=1}} }}
|-
|align="center"|{{Code|preset=2|{{param|engine}}}}<br>{{Code|preset=2|{{param|engine1}}}}<br>{{Code|preset=2|{{param|engine2}}}}
| Which engine the subject belongs to. 
:* Default - {{source|4}} (same as specifying {{Code|Source}})
:* {{code|GoldSrc}} - {{gldsrc|4}}
:* {{Code|Source}} - {{source|4}}
:* {{Code|Source 2}} - {{source2|4}}
{{Important|'''To add multiple engines''', please use parameter {{Code|preset=2|{{param|engine1}}}} (secondary engine) and {{Code|preset=2|{{param|engine2}}}} (tertiary engine) with {{Code|preset=2|{{param|engine}}}} (primary engine) at the same time.}}
|
{{CodeBlock|<nowiki>{{this is a|point entity|engine=GoldSrc|engine1=Source}}</nowiki>}}
{{CodeBlock|<nowiki>{{this is a|point entity|engine=GoldSrc|engine1=Source|engine2=Source 2}}</nowiki>}}
|-
| colspan=3 style="background-color: #2f2f2f" |{{Capsule|style=2|margin=5px|{{this is a|point entity|engine=GoldSrc|engine1=Source|nocat=1}}}}
{{Capsule|style=2|margin=5px|{{this is a|point entity|engine=GoldSrc|engine1=Source|engine2=Source 2|nocat=1}}}}
|-
|align="center"|{{Code|preset=2|{{param|except}}}}
| This is available in all other games except this one. {{Note|Works without {{Code|preset=2|{{param|game}}}}.}}
| {{CodeBlock|<nowiki>{{this is a|brush entity|name=func_monitor|except=Left 4 Dead series}}</nowiki>}}
|-
| colspan=3 style="background-color: #2f2f2f" | {{Capsule|style=2|margin=5px|{{this is a|brush entity|name=func_monitor|notitlechange=1|except=Left 4 Dead series|nocat=1}}}}
|-
|align="center"|{{Code|preset=2|{{param|since}}}}
| This  is available since this game. {{Note|Works without {{Code|preset=2|{{param|game}}}}.}}
| {{CodeBlock|<nowiki>{{this is a|point entity|name=info_player_start|engine=GoldSrc|since=Half-Life}}</nowiki>}}
|-
| colspan=3 style="background-color: #2f2f2f" | {{Capsule|style=2|margin=5px|{{this is a|point entity|name=info_player_start|notitlechange=1|engine=GoldSrc|since=Half-Life|nocat=1}}}}
|-
|align="center"|{{Code|preset=2|{{param|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."
| {{CodeBlock|<nowiki>{{this is a|point entity|name=info_player_start}}</nowiki>}}
|-
| colspan=3 style="background-color: #2f2f2f" | {{Capsule|style=2|margin=5px|{{this is a|point entity|name=info_player_start|notitlechange=1|nocat=1}}}}
|-
|align="center"|{{Code|preset=2|{{param|this}}}}
| If set to 0, false, etc. then the sentence will not start with the word "this." Has no effect if {{param|name}} has been specified.
| {{CodeBlock|<nowiki>{{this is a|point entity|this=false}}</nowiki>}}
|-
| colspan=3 style="background-color: #2f2f2f" | {{Capsule|style=2|margin=5px|{{this is a|point entity|this=false|notitlechange=1|nocat=1}}}}
|-
|align="center"|{{Code|preset=2|{{param|series}}}}
| The series that the subject is available in.
| {{CodeBlock|<nowiki>{{this is a|brush entity|series=Counter-Strike}}</nowiki>}}
|-
| colspan=3 style="background-color: #2f2f2f" | {{Capsule|style=2|margin=5px|{{this is a|brush entity|series=Counter-Strike|nocat=1}}}}
|-
|align="center"|{{Code|preset=2|{{param|game}}}}
| The game that the subject is available in. {{Note|Works without {{Code|preset=2|{{param|series}}}}.{{Warning|Do not use short name (such as {{code|hl2}} instead of {{code|Half-Life 2}}), otherwise the page will be added to  [[:Category:Hl2 point entities]] instead of [[:Category:Half-Life 2 point entities]].}}}}
| {{CodeBlock|<nowiki>{{this is a|path entity|game=Team Fortress 2}}</nowiki>}}
|-
| colspan=3 style="background-color: #2f2f2f" | {{Capsule|style=2|margin=5px|{{this is a|path entity|game=Team Fortress 2|nocat=1}}}}
|-
|align="center"|{{Code|preset=2|{{param|notitlechange}}}}
| You can prevent title-changing from the template by using this parameter. Used in the {{Code|/doc}} page.
| {{CodeBlock|<nowiki>{{this is a|point entity|notitlechange=1|name=info_player_start|engine=GoldSrc|since=Half-Life}}</nowiki>}}
|-
| colspan=3 style="background-color: #2f2f2f" | {{Capsule|style=2|margin=5px|{{this is a|point entity|notitlechange=1|name=info_player_start|engine=GoldSrc|since=Half-Life|nocat=1}}}}
|-
|align="center"|{{Code|preset=2|{{param|internal}}}}
|If enabled, "cut" will be displayed before "entity" and a category will be added to the page.
|{{CodeBlock|<nowiki>{{this is a|entity|internal=1}}</nowiki>}}
|-
| colspan=3 style="background-color: #2f2f2f" | {{Capsule|style=2|margin=5px|{{this is a|entity|internal=1|nocat=1}}}}
|-
|align="center"|{{Code|preset=2|{{param|semi-internal}}}}
|If enabled, "cut" will be displayed before "entity" and a category will be added to the page.
|{{CodeBlock|<nowiki>{{this is a|entity|semi-internal=1}}</nowiki>}}
|-
| colspan=3 style="background-color: #2f2f2f" | {{Capsule|style=2|margin=5px|{{this is a|entity|semi-internal=1|nocat=1}}}}
|-
|align="center"|{{Code|preset=2|{{param|cut}}}}
|If enabled, "cut" will be displayed before "(internal) ... entity" and a category will be added to the page.
|{{CodeBlock|<nowiki>{{this is a|cut=1|internal=1|entity}}</nowiki>}}
|-
| colspan=3 style="background-color: #2f2f2f" | {{Capsule|style=2|margin=5px|{{this is a|cut=1|internal=1|entity|nocat=1}}}}
|-
|align="center"|{{Code|preset=2|{{param|sprite}}}}
|The icon of the entity:
*If {{Code|1}} is specified, the template will find the entity icon file based on the entity name (parameter {{Code|preset=2|{{param|1}}}}). (Follow the format of {{Code|<nowiki>[[File:<entity name>.png]]</nowiki>}} to find)
*If it is a custom value, the template will find the entity icon file according to the specified value. {{Note|File suffix name is required!}}
|{{CodeBlock|<nowiki>{{this is a|point entity|name=logic_script|sprite=1}}</nowiki>}}
|-
| colspan=3 style="background-color: #2f2f2f" | {{Capsule|style=2|margin=5px|{{this is a|point entity|name=logic_script|sprite=1|notitlechange=1|nocat=1}}}}
|-
|align="center"|{{Code|preset=2|{{param|icon}}}}
|Make the game icon appear left-aligned.
*If {{Code|1}} is specified, the template will use {{Code|preset=2|{{param|tag=kbd|game}}}} instead.
*If it is a custom value, you need to enter the full name of the game. (Case sensitive)
*If {{Code|0}} is specified or the parameter is unused, the icon will appears in the text. (See the examples above.)
|{{CodeBlock|<nowiki>{{this is a|point entity|name=info_survivor_position|icon=Left 4 Dead series|type=point entity|series=Left 4 Dead}}</nowiki>}}
|-
| colspan=3 style="background-color: #2f2f2f" | {{Capsule|style=2|margin=5px|{{this is a|point entity|name=info_survivor_position|notitlechange=1|series=Left 4 Dead|icon=Left 4 Dead series|nocat=1}}}}
|-
|align="center"|{{Code|preset=2|{{param|name1}}}} ~ {{Code|preset=2|{{param|name5}}}}
|If the entity name is similar to another entity and functions the same, like <code>terrorist_team_intro</code> and <code>counterterrorist_team_intro</code>, use these parameters.  {{Note|Once you have used the {{Code|preset=2|{{param|name1}}}}, the style of the template will be changed. '''The {{Code|preset=2|{{param|name}}}} is necessary for displaying the first name.'''}}
|{{CodeBlock|<nowiki>{{this is a|point entity|name=terrorist_team_intro|name1=counterterrorist_team_intro|game=Counter-Strike 2}}</nowiki>}}
|-
| colspan=3 style="background-color: #2f2f2f" | {{Capsule|style=2|{{this is a|point entity|name=terrorist_team_intro|name1=counterterrorist_team_intro|game=Counter-Strike 2|notitlechange=1|nocat=1}}}}
|-
|align="center"|{{Code|preset=2|{{param|game1}}}} ~ {{Code|preset=2|{{param|game5}}}}
|If this is available in multiple games, use these parameters to describe. {{Note|Once you have used the {{Code|preset=2|{{param|game1}}}}, the style of the template will be changed. '''The {{Code|preset=2|{{param|game}}}} is necessary for displaying the first game.'''}}{{Note|Works without {{Code|preset=2|{{param|series}}}}.}}{{Warning|Do not use short name (such as {{code|hl2}} instead of {{code|Half-Life 2}}), otherwise the page will be added to  [[:Category:Hl2 point entities]] instead of [[:Category:Half-Life 2 point entities]].}}
|{{CodeBlock|<nowiki>{{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}}</nowiki>}}
{{CodeBlock|<nowiki>{{this is a|point entity|name=info_survivor_position|game=Left 4 Dead|game1=Left 4 Dead 2}}</nowiki>}}
|-
| colspan=3 style="background-color: #2f2f2f" | {{Capsule|style=2|{{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|nocat=1}}}}
{{Capsule|style=2|{{this is a|point entity|name=info_survivor_position|game=Left 4 Dead|game1=Left 4 Dead 2|notitlechange=1|nocat=1}}}}
|-
|align="center"|{{Code|preset=2|{{param|nocat}}}}
|Don't place any categories.
|{{CodeBlock|<nowiki>{{this is a|point entity|name=info_player_start|nocat=1}}</nowiki>}}
|-
| colspan="3" style="background-color: #2f2f2f" align="center"|N/A
|-
|align="center"|{{Code|preset=2|{{param|no-non-int}}}}
|Don't place it in [[:Category:Non-internal entities|Category:Non-internal <nowiki>{{{in|}}}</nowiki> entities]].
|{{CodeBlock|<nowiki>{{this is a|point entity|name=info_player_start|no-non-int=1}}</nowiki>}}
|-
| colspan="3" style="background-color: #2f2f2f" align="center"|N/A
|-
|align="center"|{{Code|preset=2|{{param|except-multi}}}}
|Similar to {{Code|{{Param|except}}}}, but can specify multiple games simultaneously. {{Note|Unsupport placing categories. }}
|{{CodeBlock|<nowiki>{{this is a|point entity|name=1|except-multi={{l4d}}{{hl2}}{{csgo}}}}</nowiki>}}
|-
| colspan=3 style="background-color: #2f2f2f" | {{Capsule|style=2|{{this is a|point entity|name=1|except-multi={{l4d}}{{hl2}}{{csgo}}|notitlechange=1|nocat=1}}}}
|}