Template:This is a/doc

From Valve Developer Community
Jump to navigation Jump to search
Edit-copy.png
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.

The template is the first sentence on each entity page that describes the basic information of an entity.
In addition, it can create basic information that describes things like console variables.

Parameters and Examples

*: Necessary parameters.

Parameter Description Example Preview
*{{{type}}} The type of the entity. The following types are available:
{{entity|type=''incredible entity''|engine=''Mosaic''}}
{{entity|type=e1|engine=3}}

{{entity|type=e2|engine=1}}
{{entity|type=convar|sv_cheats}}
{{{engine}}} Which engine the entity belongs to.
{{entity|type=e1|engine=3}}
{{entity|type=e1}}
{{{except}}} This entity is available in all other games except this one.
Note.pngNote:Should be the full name of the game, not a abbreviation (So templates can link to multilingual pages according to the language suffix).
Note.pngNote:Works without {{{game}}}.
{{entity|func_monitor|type=e2|except=Left 4 Dead series}}
{{{since}}} This entity is available since this game.
Note.pngNote:Should be the full name of the game, not a abbreviation (So templates can link to multilingual pages according to the language suffix).
Note.pngNote:Works without {{{game}}}.
{{entity|type=e0|info_player_start|engine=1|since=Half-Life}}
{{{1}}} The name of the entity. It will change the title of a page. The default value is "This". You can specify it to 0 to remove the entity name.
{{entity|type=e0|info_player_start}}
{{{series}}} The series that the entity is available in.
{{entity|type=e2|series=Counter-Strike}}
{{{seriescs}}} The series of Counter-Strike that the entity is available in.
{{entity|type=e3|seriescs=Counter-Strike|game=Counter-Strike: Source}}
{{{game}}} The game that the entity is available in.
Note.pngNote:Should be the full name of the game, not a abbreviation (So templates can link to multilingual pages according to the language suffix).
Note.pngNote:Works without {{{series}}}.
{{entity|type=e5|game=Team Fortress 2}}
{{{notitlechange}}} You can prevent title-changing from the template by using this parameter. Used in the /doc page.
{{entity|type=e0|notitlechange=1|info_player_start|engine=1|since=Half-Life}}
*{{{suf}}} Specify the language suffix. The template supports multi-language and you can add more languages that the template supports. The following languages are available:
  • English English: Default (Specify the value to none to force the template be in English)
  • Русский Russian:
ru (need update)
  • 简体中文 Simplified Chinese:
zh-cn
Note.pngNote:Some of the translations may be not fully complete.

If not specified, the template automatically selects the language. This parameter is necessary if you need to add a page to the corresponding language category.

{{entity|suf=:zh-cn|type=e0|info_player_start|engine=1|since=Half-Life}}
{{entity|suf=:ru|type=e0|info_player_start|engine=1|since=Half-Life}}
{{{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.pngNote:If {{{type}}} is a defined value (e.g. e0), the parameter is invalid.
{{entity|internal=1|type=entity}}
{{{cut}}} If enabled, "cut" will be displayed before "(internal) ... entity"and the page will add to Category:Cut Entities.
{{entity|internal=1|type=entity|cut=1}}
{{{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.pngNote:File suffix name is required!
{{entity|logic_script|sprite=1|type=e0}}
{{{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.)
{{entity|info_survivor_position|icon=Left 4 Dead series|type=e0|series=Left 4 Dead}}
{{{game1}}} ~ {{{game5}}} If this entity is available in multiple games, use these parameters to describe.
Note.pngNote:Once you have used the {{{game1}}}, the style of the template will be changed. The {{{game}}} is necessary for displaying the first game.
Note.pngNote:Works without {{{series}}}.
{{entity|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}}
{{entity|type=e0|info_survivor_position|game=Left 4 Dead|game1=Left 4 Dead 2}}

See Also

Template:ModernNote

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