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 (não em ) 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) Nota: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}}	Esse é um incredible entity disponível em todos os jogos Source. Esse é um entidade de brush(en) disponível em todos os jogos GoldSrc. sv_cheats é um variáveis do console(en) disponível em todos os jogos Source. LightmappedGeneric é um pixel shader(en) disponível em todos os jogos Source.
{{{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}}	$lightmap é um material(en) shader(en) parametro para o VertexLitGeneric shader disponível em Source 2013 Multiplayer e Garry's Mod.
{{{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}}	$lightwarptexture (DX8) é um material(en) shader(en) parametro para o VertexLitGeneric shader disponível em todos os jogos Source desde Source 2006. $lightwarptexture (DX9 SM2) é um material(en) shader(en) parametro para o VertexLitGeneric shader disponível em todos os jogos Source desde Source 2006. $lightwarptexture (DX9+ SM3) é um material(en) shader(en) parametro para o VertexLitGeneric shader disponível em todos os jogos Source desde Source 2006.
{{{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}}	Esse é um ponto de entidade(en) disponível em todos os jogos GoldSrc e Source. Esse é um ponto de entidade(en) disponível em todos os jogos GoldSrc, Source, e Source 2.
{{{except}}}	This is available in all other games except this one. Nota:Works without {{{game}}}.	{{this is a|brush entity|name=func_monitor|except=Left 4 Dead series}}	func_monitor é um entidade de brush(en) disponível em todos os jogos Source exceto Left 4 Dead series.
{{{since}}}	This is available since this game. Nota:Works without {{{game}}}.	{{this is a|point entity|name=info_player_start|engine=GoldSrc|since=Half-Life}}	info_player_start é um ponto de entidade(en) disponível em todos os jogos GoldSrc desde 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|point entity|name=info_player_start}}	info_player_start é um ponto de entidade(en) disponível em todos os jogos Source.
{{{series}}}	The series that the subject is available in.	{{this is a|brush entity|series=Counter-Strike}}	Esse é um entidade de brush(en) disponível em Counter-Strike series.
{{{game}}}	The game that the subject is available in. Nota:Works without {{{series}}}.	{{this is a|path entity|game=Team Fortress 2}}	Esse é um caminho de entidade(en) disponível em 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=GoldSrc|since=Half-Life}}	info_player_start é um ponto de entidade(en) disponível em todos os jogos GoldSrc desde Half-Life.
{{{internal}}}	If enabled, "cut" will be displayed before "entity" and a category will be added to the page.	{{this is a|entity|internal=1}}	Esse é um interno(en) UNTRANSLATED string "entity" see Template:This is a/strings disponível em todos os jogos Source.
{{{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}}	Esse é um corte interno(en) UNTRANSLATED string "entity" see Template:This is a/strings disponível em todos os jogos Source.
{{{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. Nota:File suffix name is required!	{{this is a|point entity|name=logic_script|sprite=1}}	logic_script é um ponto de entidade(en) disponível em todos os jogos Source.
{{{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 é um ponto de entidade(en) disponível em Left 4 Dead series.
{{{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. Nota: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}}	terrorist_team_intro e counterterrorist_team_intro é um ponto de entidade(en) disponível em Counter-Strike 2.
{{{game1}}} ~ {{{game5}}}	If this is available in multiple games, use these parameters to describe. Nota:Once you have used the {{{game1}}}, the style of the template will be changed. The {{{game}}} is necessary for displaying the first game. Nota: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}}	Esse é um ponto de entidade(en) disponível em Left 4 Dead, Left 4 Dead 2, Portal 2, Team Fortress 2, Portal 2, e Counter-Strike: Global Offensive. info_survivor_position é um ponto de entidade(en) disponível em Left 4 Dead e 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. Nota:Unsupport placing categories.	{{this is a|point entity|name=1|except-multi={{l4d}}{{hl2}}{{csgo}}}}	1 é um ponto de entidade(en) disponível em todos os jogos Source exceto .