Template:This is a/doc

This is a documentation subpage for Template:This is a.
Don't forget to purge the contents of the base page upon creating or editing this subpage.

Purge base's cache

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. It should be placed on the base pages of articles using {{MultiPage}}.

Parameters and Examples

*: Necessary parameters.

Parameter	Description	Example	Preview
*{{{1}}}	The type of the object need to describe. The following types are available: Entities: point entity - Point entity brush entity - Brush entity e3, int brush - Internal brush entity e4, mesh, mesh entity - Mesh entity () e5, path, path entity - Path entity () Console Variables, Commands, QC Commands: c2, cvar, convar, console variable - Console Variables c1, command, console command - Console Commands c0, QC command - QC command pixel shader - Shader#Pixel shaders s1, vertex shader - Shader#Vertex shaders s2, shader parameter - material shader parameter Miscellaneous: Custom (You can specify the type yourself. See examples) Note:Template will not add entity categories and change titles when using non-entity type (such as convar).	{{this is a|''incredible entity''|engine=''Mosaic''}} {{this is a|brush entity|engine=1}} {{this is a|convar|name=sv_cheats}} {{this is a|pixel shader|name=LightmappedGeneric}}	This is a incredible entity available in all Template:''Mosaic'' games.Template:''Mosaic'' topicon Warning: The {{{engine}}} parameter is inconsistent with the name defined by the {{Mosaic}} template. If a parameter is consistent but you're still seeing this warning, it may be an issue with the template itself. Please discuss it on the template's talk page. This is a brush entity available in all Template:1 games.Template:1 topicon Warning: The {{{engine}}} parameter is inconsistent with the name defined by the {{1}} template. If a parameter is consistent but you're still seeing this warning, it may be an issue with the template itself. Please discuss it on the template's talk page. sv_cheats is a convar available in all Source games. LightmappedGeneric is a Pixel shader available in all Source games.
{{{engine}}} {{{engine1}}} {{{engine2}}}	Which engine the subject belongs to. Default - Source (same as 2) 1, gldsrc - GoldSrc 2, source - Source 3, source2 - Source 2 Custom - You can specify any other engine. 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=1|engine1=2}} {{this is a|point entity|engine=1|engine1=2|engine2=3}}	This is a point entity available in all Template:1 and Template:2 games.Template:1 topiconTemplate:2 topicon Warning: The {{{engine}}} parameter is inconsistent with the name defined by the {{1}} template. The {{{engine1}}} parameter is inconsistent with the name defined by the {{2}} template. If a parameter is consistent but you're still seeing this warning, it may be an issue with the template itself. Please discuss it on the template's talk page. This is a point entity available in all Template:1, Template:2, and Template:3 games.Template:1 topiconTemplate:2 topiconTemplate:3 topicon Warning: The {{{engine}}} parameter is inconsistent with the name defined by the {{1}} template. The {{{engine1}}} parameter is inconsistent with the name defined by the {{2}} template. The {{{engine2}}} parameter is inconsistent with the name defined by the {{3}} template. If a parameter is consistent but you're still seeing this warning, it may be an issue with the template itself. Please discuss it on the template's talk page.
{{{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}}	func_monitor is a brush entity available in all Source games 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=1|since=Half-Life}}	info_player_start is a point entity available in all Template:1 games since Half-Life.Template:1 topicon Warning: The {{{engine}}} parameter is inconsistent with the name defined by the {{1}} template. If a parameter is consistent but you're still seeing this warning, it may be an issue with the template itself. Please discuss it on the template's talk page.
{{{name}}}	The name of the subject. It will change the title of a page. The default value is "This". You can specify it to 0 to remove the entity name.	{{this is a|point entity|name=info_player_start}}	info_player_start is a point entity available in all Source games.
{{{series}}}	The series that the subject is available in.	{{this is a|brush entity|series=Counter-Strike}}	This is a brush entity available in Counter-Strike series.
{{{seriescs}}}	The series of Counter-Strike that the subject is available in[Why?].	{{this is a|e3|seriescs=Counter-Strike|game=Counter-Strike: Source}}	This is an e3 available in Counter-Strike: Source.
{{{game}}}	The game that the subject is available in. Note:Works without {{{series}}}.	{{this is a|e5|game=Team Fortress 2}}	This is an e5 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=1|since=Half-Life}}	info_player_start is a point entity available in all Template:1 games since Half-Life.Template:1 topicon Warning: The {{{engine}}} parameter is inconsistent with the name defined by the {{1}} template. If a parameter is consistent but you're still seeing this warning, it may be an issue with the template itself. Please discuss it on the template's talk page.
{{{internal}}}	If enabled (value is 1 or true), the page will be added to Category:Internal entities and "internal" will be displayed before "... entity". Note:If {{{type}}} is a defined value (e.g. point entity), the parameter is invalid.	{{this is a|entity|internal=1}}	This is an internal entity available in all Source games.
{{{cut}}}	If enabled, "cut" will be displayed before "(internal) ... entity"and the page will add to Category:Cut Entities.	{{this is a|cut=1|internal=1|entity}}	This is a cut internal entity available in all Source games.
{{{sprite}}}	The icon of the entity: If 1 is specified, the template will find the entity icon file based on the entity name (parameter {{{1}}}). (Follow the format of [[File:<entity name>.png]] 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!	{{this is a|point entity|name=logic_script|sprite=1}}	logic_script is a point entity available in all Source games.
{{{icon}}}	Make the game icon appear left-aligned. If 1 is specified, the template will use {{{game}}} instead. If it is a custom value, you need to enter the full name of the game. (Case sensitive) If 0 is specified or the parameter is unused, the icon will appears in the text. (See the examples above.)	{{this is a|point entity|name=info_survivor_position|icon=Left 4 Dead series|type=point entity|series=Left 4 Dead}}	info_survivor_position is a point entity available in Left 4 Dead series.
{{{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}}}.	{{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. info_survivor_position is a point entity available in Left 4 Dead and Left 4 Dead 2.
{{{nocat}}}	Don't place any categories.	{{this is a|point entity|name=info_player_start|nocat=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}}}}	1 is a point entity available in all Source games except .

See also

Note:All the entity templates listed below are deprecated.

• {{Entity}}
• {{Format}}
• {{Point ent}}
• {{Base point multi}}
• {{Brush ent}}
• {{Base brush multi}}
• {{Game name}}