Template:This is a/doc/zh

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

此模板是所有实体、控制台命令/变量和着色器页面的主格式页面。每个页面应该在开头包含此内容，以描述每个项目的基本信息，例如它们的含义和可用性。

参数和示例

*: 必要的参数。

参数	描述	示例	预览
*{{{1}}}	对象的类型。以下类型可用： 实体: point entity - 点实体 brush entity - 固实体 mesh entity - 网格实体 () path entity - 路径实体 () 控制台变量、控制台命令和 QC 命令： console variable - 控制台变量 command - 控制台命令 QC command - QC 命令 pixel shader - 像素着色器 vertex shader - 顶点着色器 shader parameter - 材质着色器参数 其他： 自定义 (你可以自己指定对象类型。详见示例) 注意:当使用非实体类型时（例如 console variable），模板不会添加实体分类和改变页面标题。	{{this is a|point entity|internal=1|engine=Source 2}} {{this is a|brush entity|engine=GoldSrc}} {{this is a|console variable|name=sv_cheats}} {{this is a|pixel shader|name=LightmappedGeneric}}	这是一个内部的(en)点实体(en)，可在所有的 起源2 游戏中使用。 这是一个固体实体(en)，可在所有的 GoldSrc 游戏中使用。 sv_cheats是一个控制台变量(en)，可在所有的 Source 游戏中使用。 LightmappedGeneric是一个像素着色器(en)，可在所有的 Source 游戏中使用。
{{{shader}}}	参数所在的着色器（仅当 {{{1}}} 等于 shader parameter 时起作用）。	{{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中使用。
{{{engine}}} {{{engine1}}} {{{engine2}}}	对象应该属于哪个引擎。 缺省值 - Source （和 Source 一致） GoldSrc - GoldSrc Source - Source Source 2 - 起源2 重要:要添加多个引擎，请把参数 {{{engine1}}} (第二引擎) 和 {{{engine2}}} (第三引擎) 与参数 {{{engine}}} (第一引擎) 一同使用。	{{this is a|point entity|internal=1|engine=Source 2}} {{this is a|point entity|internal=1}} {{this is a|point entity|engine=GoldSrc|engine1=Source}} {{this is a|point entity|engine=GoldSrc|engine1=Source|engine2=Source 2}}	这是一个内部的(en)点实体(en)，可在所有的 起源2 游戏中使用。 这是一个内部的(en)点实体(en)，可在所有的 Source 游戏中使用。 这是一个点实体(en)，可在所有的 GoldSrc 和 Source 游戏中使用。 这是一个点实体(en)，可在所有的 GoldSrc、 Source 和 起源2 游戏中使用。
{{{except}}}	该对象存在于其他所有游戏除了这个游戏外。 注意:应该在此处填写游戏的全称而不是简称，以便模板根据语言后缀连接多语言页面。 注意:仅在不使用 {{{game}}} 的情况下有效。	{{this is a|name=func_monitor|brush entity|except=Left 4 Dead series}}	func_monitor是一个固体实体(en)，可在所有的 Source 游戏，除了 求生之路系列中使用。
{{{since}}}	这个对象自从这个游戏中可用。 注意:应该在此处填写游戏的全称而不是简称，以便模板根据语言后缀连接多语言页面。 注意:仅在不使用 {{{game}}} 的情况下有效。	{{this is a|point entity|name=info_player_start|engine=GoldSrc|since=Half-Life}}	info_player_start是一个点实体(en)，可在所有的 GoldSrc 游戏，自从 Half-Life 以来中使用。
{{{name}}}	对象的名称。它会更改页面名称。默认值为“这”。将其指定为 0 可以移除对象名称。	{{this is a|point entity|name=info_player_start}}	info_player_start是一个点实体(en)，可在所有的 Source 游戏中使用。
{{{series}}}	对象存在于的系列游戏。	{{this is a|brush entity|series=Counter-Strike}}	这是一个固体实体(en)，可在 Counter-Strike series中使用。
{{{game}}}	对象可用于的游戏。 注意:应该在此处填写游戏的全称而不是简称，以便模板根据语言后缀连接多语言页面。 注意:仅在不使用 {{{series}}} 的情况下有效。	{{this is a|path entity|game=Team Fortress 2}}	这是一个路径实体(en)，可在 Team Fortress 2中使用。
{{{notitlechange}}}	你可以通过这个参数来防止模板更改页面标题。用于 /doc 页面。	{{this is a|point entity|notitlechange=1|name=info_player_start|engine=GoldSrc|since=Half-Life}}	info_player_start是一个点实体(en)，可在所有的 GoldSrc 游戏，自从 Half-Life 以来中使用。
{{{internal}}}	如果启用 (值为 1 或 true)，则分类页面，并且在“……实体”前显示“内部的”。	{{this is a|internal=1|实体}}	这是一个内部的(en)实体，可在所有的 Source 游戏中使用。
{{{cut}}}	如果启用，则在“(内部的)……实体”前显示“被移除的”。同时把页面分类。	{{this is a|internal=1|type=实体|cut=1}}	这是一个被移除的内部的(en)实体，可在所有的 Source 游戏中使用。
{{{sprite}}}	实体的图标： 如果指定为 1，则模板将根据实体名称 (参数 {{{1}}}) 查找实体图标文件。(遵循 [[File:<实体名称>.png]] 格式查找) 如果为自定值，则模板将根据指定的值查找实体图标文件。 注意:需要填入后缀名！	{{this is a|name=logic_script|sprite=1|point entity}}	logic_script是一个点实体(en)，可在所有的 Source 游戏中使用。
{{{icon}}}	使游戏图标显示在左边。 如果为 1，则模板将使用 {{{game}}} 参数的值。 如果为自定值，则需要填写游戏的全称。 如果为 0 或当不使用该参数时，图标显示在文本之中。(请参阅以上示例)	{{this is a|name=info_survivor_position|icon=Left 4 Dead series|point entity|series=Left 4 Dead}}	info_survivor_position是一个点实体(en)，可在 求生之路系列中使用。
{{{game1}}} ~ {{{game5}}}	如果对象存在于多个游戏，用这些参数进行描述。 注意:一旦使用了 {{{game1}}}，模板的样式会改变。{{{game}}} 是必要的，以显示第一个游戏。 注意:仅在不使用 {{{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|info_survivor_position|game=Left 4 Dead|game1=Left 4 Dead 2}}	这是一个点实体(en)，可在 Left 4 Dead、 求生之路2、 Portal 2、 Team Fortress 2、 Portal 2 和 Counter-Strike: Global Offensive中使用。 这是一个点实体(en)，可在 Left 4 Dead 和 求生之路2中使用。
{{{nocat}}}	不添加任何分类。	{{this is a|name=info_player_start|point entity|nocat=1}}	不适用
{{{except-multi}}}	与 {{{except}}} 相似，但可以同时指定多个游戏。 注意:不支持添加分类。	{{this is a|name=1|point entity|except-multi={{l4d}}{{hl2}}{{csgo}}}}	1是一个点实体(en)，可在所有的 Source 游戏，除了 中使用。

另请参阅

注意:以下实体模板已全部弃用。

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