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 the base

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: e0, point - Point entity e1, int point - Internal point entity e2, brush - Brush entity e3, int brush - Internal brush entity e4, mesh - Mesh entity () e5, path - Path entity () Console Variables, Commands, QC Commands: c2, cvar, convar - Console Variables c1, command - Console Commands c0, QC command - QC command s0, pixel shader - Shader#Pixel shaders s1, vertex shader - Shader#Vertex shaders 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|e1|engine=3}} {{this is a|e2|engine=1}} {{this is a|convar|name=sv_cheats}} {{this is a|s0|name=LightmappedGeneric}}	This is a incredible entity available in all Mosaic games. This is a internal point entity available in all Source 2 games. This is a brush entity available in all GoldSrc games. sv_cheats is a console variable 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|e1|engine=3}} {{this is a|e1}} {{this is a|e0|engine=1|engine1=2}} {{this is a|e0|engine=1|engine1=2|engine2=3}}	This is a internal point entity available in all Source 2 games. This is a internal point entity available in all Source games. This is a point entity available in all GoldSrc and  Source games. This is a point entity available in all GoldSrc,  Source and  Source 2 games.
{{{except}}}	This is available in all other games except this one. Note:Works without {{{game}}}.	{{this is a|e2|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|e0|name=info_player_start|engine=1|since=Half-Life}}	info_player_start is a point entity available in all GoldSrc games since  Half-Life.
{{{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|e0|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|e2|series=Counter-Strike}}	This is a brush entity available in the 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 a internal brush entity available in the Counter-Strike series (since 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 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|e0|notitlechange=1|name=info_player_start|engine=1|since=Half-Life}}	info_player_start is a point entity available in all GoldSrc games since  Half-Life.
{{{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. e0), the parameter is invalid.	{{this is a|entity|internal=1}}	This is a 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|e0|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|e0|name=info_survivor_position|icon=Left 4 Dead series|type=e0|series=Left 4 Dead}}	info_survivor_position is a point entity available in the 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|e0|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|e0|name=info_survivor_position|game=Left 4 Dead|game1=Left 4 Dead 2}}	This is a point entity available in the following Source games or engine branches: 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 the following Source games or engine branches: Left 4 Dead and  Left 4 Dead 2.
{{{nocat}}}	Don't place any categories.	{{this is a|e0|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|e0|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}}