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.

Parameters and Examples

*: Necessary parameters.

Parameter	Description	Example	Preview
*{{{type}}}	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, 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).	{{format|type=''incredible entity''|engine=''Mosaic''}} {{format|type=e1|engine=3}} {{format|type=e2|engine=1}} {{format|type=convar|sv_cheats}} {{format|type=s0|LightmappedGeneric}}	Template:Format Template:Format Template:Format Template:Format Template:Format
{{{engine}}}	Which engine the subject belongs to. Default - Source (same as 2) 1, gldsrc - GoldSrc 2, source - Source 3, source2 - Source 2	{{format|type=e1|engine=3}} {{format|type=e1}}	Template:Format Template:Format
{{{except}}}	This is available in all other games except this one. Note:Works without {{{game}}}.	{{format|func_monitor|type=e2|except=Left 4 Dead series}}	Template:Format
{{{since}}}	This is available since this game. Note:Works without {{{game}}}.	{{format|type=e0|info_player_start|engine=1|since=Half-Life}}	Template:Format
{{{1}}}	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.	{{format|type=e0|info_player_start}}	Template:Format
{{{series}}}	The series that the subject is available in.	{{format|type=e2|series=Counter-Strike}}	Template:Format
{{{seriescs}}}	The series of Counter-Strike that the subject is available in.	{{format|type=e3|seriescs=Counter-Strike|game=Counter-Strike: Source}}	Template:Format
{{{game}}}	The game that the subject is available in. Note:Works without {{{series}}}.	{{format|type=e5|game=Team Fortress 2}}	Template:Format
{{{notitlechange}}}	You can prevent title-changing from the template by using this parameter. Used in the /doc page.	{{format|type=e0|notitlechange=1|info_player_start|engine=1|since=Half-Life}}	Template:Format
{{{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.	{{format|internal=1|type=entity}}	Template:Format
{{{cut}}}	If enabled, "cut" will be displayed before "(internal) ... entity"and the page will add to Category:Cut Entities.	{{format|internal=1|type=entity|cut=1}}	Template:Format
{{{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!	{{format|logic_script|sprite=1|type=e0}}	Template:Format
{{{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.)	{{format|info_survivor_position|icon=Left 4 Dead series|type=e0|series=Left 4 Dead}}	Template:Format
{{{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}}}.	{{format|type=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}} {{format|type=e0|info_survivor_position|game=Left 4 Dead|game1=Left 4 Dead 2}}	Template:Format Template:Format
{{{nocat}}}	Don't place any categories.	{{format|info_player_start|type=e0|nocat=1}}	N/A
{{{except-multi}}}	Similar to {{{except}}}, but can specify multiple games simultaneously.	{{format|1|type=e0|except-multi={{l4d}}{{hl2}}{{csgo}}}}	Template:Format
{{{notext}}}	Only change the title (unless {{{notitlechange}}} is 1) and add categories (unless {{{nocat}}} is 1). Useful for the base page of a page using the {{MultiPage}} template. Note:Must come before {{MultiPage}} in order to change the title.	{{format|1|type=e0|notext=1}}	Template:Format

See Also

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