Template:This is a/doc

这是 Template:This is a 的文档子页面。

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.

Usage

This template is usually written in a single line. To use it, insert {{This is a}} into the desired page and specify the parameters to the right of the template name in the following format: {{This is a|parameter 1 = value|parameter 2 = value}}.

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 (不存在于 ) `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 when using non-entity type (such as `console variable`).	{{this is a\|''incredible entity''}} {{this is a\|brush entity\|engine=GoldSrc\|nocat=1}} {{this is a\|console variable\|name=sv_cheats\|notitlechange=1\|nocat=1}} {{this is a\|pixel shader\|name=LightmappedGeneric\|notitlechange=1\|nocat=1}}	这是一个incredible entity，可在所有的 Source 游戏中使用。这是一个固体实体(en)，可在所有的 GoldSrc 游戏中使用。 `sv_cheats`是一个控制台变量(en)，可在所有的 Source 游戏中使用。 `LightmappedGeneric`是一个像素着色器(en)，可在所有的 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 Multiplayer\|game1=Garry's Mod}}	`$lightmap`是一个用于着色器 VertexLitGeneric 的材质(en)着色器(en)参数，可在 Source 2013 Multiplayer 和 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)是一个用于着色器 VertexLitGeneric 的材质(en)着色器(en)参数，可在所有的 Source 游戏，自从 Source 2006 以来中使用。 `$lightwarptexture`(DX9 SM2)是一个用于着色器 VertexLitGeneric 的材质(en)着色器(en)参数，可在所有的 Source 游戏，自从 Source 2006 以来中使用。 `$lightwarptexture`(DX9+ SM3)是一个用于着色器 VertexLitGeneric 的材质(en)着色器(en)参数，可在所有的 Source 游戏，自从 Source 2006 以来中使用。
`{{{engine}}}` `{{{engine1}}}` `{{{engine2}}}`	Which engine the subject belongs to. Default - Source (same as specifying `Source`) `GoldSrc` - GoldSrc `Source` - Source `Source 2` - 起源2 重要: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}}	这是一个点实体(en)，可在所有的 GoldSrc 和 Source 游戏中使用。这是一个点实体(en)，可在所有的 GoldSrc、 Source 和起源2 游戏中使用。
`{{{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}}	`func_monitor`是一个固体实体(en)，可在所有的 Source 游戏，除了求生之路系列中使用。
`{{{since}}}`	This is available since this game. 注意:Works without `{{{game}}}`.	{{this is a\|point entity\|name=info_player_start\|engine=GoldSrc\|since=Half-Life}}	`info_player_start`是一个点实体(en)，可在所有的 GoldSrc 游戏，自从 Half-Life 以来中使用。
`{{{name}}}`	The name of the subject. It will change the title of a page. If unspecified, the sentence will just refer to the subject as "this."	{{this is a\|point entity\|name=info_player_start}}	`info_player_start`是一个点实体(en)，可在所有的 Source 游戏中使用。
`{{{this}}}`	If set to 0, false, etc. then the sentence will not start with the word "this." Has no effect if `{{{name}}}` has been specified.	{{this is a\|point entity\|this=false}}	是一个点实体(en)，可在所有的 Source 游戏中使用。
`{{{series}}}`	The series that the subject is available in.	{{this is a\|brush entity\|series=Counter-Strike}}	这是一个固体实体(en)，可在 Counter-Strike series中使用。
`{{{game}}}`	The game that the subject is available in. 注意:Works without `{{{series}}}`. Warning:Do not use short name (such as `hl2` instead of `Half-Life 2`), otherwise the page will be added to Category:Hl2 point entities instead of Category:Half-Life 2 point entities.	{{this is a\|path entity\|game=Team Fortress 2}}	这是一个路径实体(en)，可在 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`是一个点实体(en)，可在所有的 GoldSrc 游戏，自从 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}}	这是一个内部的(en)实体(en)，可在所有的 Source 游戏中使用。
`{{{semi-internal}}}`	If enabled, "cut" will be displayed before "entity" and a category will be added to the page.	{{this is a\|entity\|semi-internal=1}}	这是一个实体(en)，可在所有的 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}}	这是一个被移除的内部的(en)实体(en)，可在所有的 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. 注意:File suffix name is required!	{{this is a\|point entity\|name=logic_script\|sprite=1}}	`logic_script`是一个点实体(en)，可在所有的 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`是一个点实体(en)，可在求生之路系列中使用。
`{{{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}}	`terrorist_team_intro` 和 `counterterrorist_team_intro`是一个点实体(en)，可在 Counter-Strike 2中使用。
`{{{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}}}`. Warning:Do not use short name (such as `hl2` instead of `Half-Life 2`), otherwise the page will be added to Category:Hl2 point entities instead of Category:Half-Life 2 point entities.	{{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}}	这是一个点实体(en)，可在 Left 4 Dead、求生之路2、 Portal 2、 Team Fortress 2、 Portal 2 和 Counter-Strike: Global Offensive中使用。
`{{{nocat}}}`	Don't place any categories.	{{this is a\|point entity\|name=info_player_start\|nocat=1}}	N/A
`{{{no-non-int}}}`	Don't place it in Category:Non-internal {{{in\|}}} entities.	{{this is a\|point entity\|name=info_player_start\|no-non-int=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}}}}	`1`是一个点实体(en)，可在所有的 Source 游戏，除了中使用。