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
*{{{1}}}	The type of the object need to describe. The following types are available: Entities: entity - Entity point entity - Point entity brush entity - Brush entity (not in ) mesh entity - Mesh entity () path entity - Path entity () Console Variables, Commands, QC Commands: console variable - Console Variables console command - Console Commands QC command - QC command pixel shader - Shader#Pixel shaders vertex shader - Shader#Vertex shaders shader parameter - material shader parameter Miscellaneous: Custom (You can specify the type yourself. See examples) お知らせ:Template will not add entity categories and change titles 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}}	UNTRANSLATED string "this is a" see Template:This is a/strings UNTRANSLATED string "this is a" see Template:This is a/strings UNTRANSLATED string "this is a" see Template:This is a/strings UNTRANSLATED string "this is a" see Template:This is a/strings
{{{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 MP|game1=Garry's Mod}}	UNTRANSLATED string "this is a" see Template:This is a/strings
{{{dx}}}	Add DirectX levels inline text. Available versions: DirectX 8 - dx8 DirectX 9 (SM 2.0)- dx9 DirectX 9.0c (SM 3.0) - dx95 or dx90c	{{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}}	UNTRANSLATED string "this is a" see Template:This is a/strings UNTRANSLATED string "this is a" see Template:This is a/strings UNTRANSLATED string "this is a" see Template:This is a/strings
{{{engine}}} {{{engine1}}} {{{engine2}}}	Which engine the subject belongs to. Default - Source (same as specifying Source) GoldSrc - GoldSrc Source - Source Source 2 - Source 2 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}}	UNTRANSLATED string "this is a" see Template:This is a/strings UNTRANSLATED string "this is a" see Template:This is a/strings
{{{except}}}	This is available in all other games except this one. お知らせ:Works without {{{game}}}.	{{this is a|brush entity|name=func_monitor|except=Left 4 Dead series}}	UNTRANSLATED string "this is a" see Template:This is a/strings
{{{since}}}	This is available since this game. お知らせ:Works without {{{game}}}.	{{this is a|point entity|name=info_player_start|engine=GoldSrc|since=Half-Life}}	UNTRANSLATED string "this is a" see Template:This is a/strings
{{{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}}	UNTRANSLATED string "this is a" see Template:This is a/strings
{{{series}}}	The series that the subject is available in.	{{this is a|brush entity|series=Counter-Strike}}	UNTRANSLATED string "this is a" see Template:This is a/strings
{{{game}}}	The game that the subject is available in. お知らせ:Works without {{{series}}}.	{{this is a|path entity|game=Team Fortress 2}}	UNTRANSLATED string "this is a" see Template:This is a/strings
{{{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}}	UNTRANSLATED string "this is a" see Template:This is a/strings
{{{internal}}}	If enabled, "cut" will be displayed before "entity" and a category will be added to the page.	{{this is a|entity|internal=1}}	UNTRANSLATED string "this is a" see Template:This is a/strings
{{{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}}	UNTRANSLATED string "this is a" see Template:This is a/strings
{{{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. お知らせ:File suffix name is required!	{{this is a|point entity|name=logic_script|sprite=1}}	UNTRANSLATED string "this is a" see Template:This is a/strings
{{{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}}	UNTRANSLATED string "this is a" see Template:This is a/strings
{{{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. お知らせ: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}}	UNTRANSLATED string "this is a" see Template:This is a/strings
{{{game1}}} ~ {{{game5}}}	If this is available in multiple games, use these parameters to describe. お知らせ:Once you have used the {{{game1}}}, the style of the template will be changed. The {{{game}}} is necessary for displaying the first game. お知らせ: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}}	UNTRANSLATED string "this is a" see Template:This is a/strings UNTRANSLATED string "this is a" see Template:This is a/strings
{{{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. お知らせ:Unsupport placing categories.	{{this is a|point entity|name=1|except-multi={{l4d}}{{hl2}}{{csgo}}}}	UNTRANSLATED string "this is a" see Template:This is a/strings