Template:This is a/doc: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
Line 1: Line 1:
{{documentation subpage}}
{{documentation subpage}}
The template is the first sentence on each entity page that describes the basic information of an entity.
The template is the first sentence on each [[Entity Article Template|entity page]] that describes the basic information of an [[entity]].


== Parameters and Examples ==
== Parameters and Examples ==

Revision as of 17:04, 24 January 2023

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.

Parameters and Examples

Note.pngNote:The template has still the old code of {{point ent}} for compatibility with those page having not updated.
Parameter Description Example Preview
{{{type}}} The type of the entity. The following types are available:
  1. {{entity|type=''incredible entity''|engine=''Mosaic''}}
  2. {{entity|type=e1|engine=3}}

  3. {{entity|type=e2|engine=1}}
{{{engine}}} Which engine the entity belongs to.
  1. {{entity|type=e1|engine=3}}
  2. {{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).
{{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).
{{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.
Note.pngNote:The template can't change the title when the {{lang}} is in use.
PlacementTip.pngWorkaround:Specify the {{{title}}} of {{lang}} to {{Code|selected=1|<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).
{{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.
  1. {{entity|suf=:zh-cn|type=e0|info_player_start|engine=1|since=Half-Life}}
  2. {{entity|suf=:ru|type=e0|info_player_start|engine=1|since=Half-Life}}

See Also

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