Template:Entity

From Valve Developer Community
Jump to: navigation, search
View Edit Page history
Curly brackets white.pngTemplate Documentation
English (en)Esperanto (eo)中文 (zh)

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}}
This is a incredible entity available in all Mosaic games.
This is a internal point entity available in all Source 2 Source 2 games.
This is a brush entity available in all GoldSrc GoldSrc games.
sv_cheats is a console variable available in all Source Source games.
{{{engine}}} Which engine the entity belongs to.
{{entity|type=e1|engine=3}}
{{entity|type=e1}}
This is a internal point entity available in all Source 2 Source 2 games.
This is a internal point entity available in all Source Source games.
{{{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}}
func_monitor is a brush entity available in all Source Source games except Left 4 Dead series 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}}
info_player_start is a point entity available in all GoldSrc GoldSrc games since Half-Life 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}}
info_player_start is a point entity available in all Source Source games.
{{{series}}} The series that the entity is available in.
{{entity|type=e2|series=Counter-Strike}}
This is a brush entity available in the Counter-Strike series.
{{{seriescs}}} The series of Counter-Strike that the entity is available in.
{{entity|type=e3|seriescs=Counter-Strike|game=Counter-Strike: Source}}
This is a internal brush entity available in the Counter-Strike series (since Counter-Strike: Source 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}}
This is a path entity available in Team Fortress 2 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}}
info_player_start is a point entity available in all GoldSrc GoldSrc games since Half-Life 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}}
info_player_start是一个点实体存在于所有的 GoldSrc GoldSrc 游戏自从 Half-Life Half-Life 以来。
info_player_start — это точечная сущность, доступная во всех играх на движке GoldSrc GoldSrc, начиная сHalf-Life 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}}
This is a internal entity available in all Source Source games.
{{{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}}
This is a cut internal entity available in all Source Source games.
{{{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}}
Logic script.png
logic_script is a point entity available in all Source Source games.
{{{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}}
Left 4 Dead series info_survivor_position is a point entity available in the Left 4 Dead series.
{{{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}}
This is a point entity available in the following Source Source games:
Left 4 Dead Left 4 DeadLeft 4 Dead 2 Left 4 Dead 2Portal 2 Portal 2Team Fortress 2 Team Fortress 2Portal 2 Portal 2 and Counter-Strike: Global Offensive Counter-Strike: Global Offensive.
info_survivor_position is a point entity available in the following Source Source games:
Left 4 Dead Left 4 Dead and Left 4 Dead 2 Left 4 Dead 2.

See Also

Note.pngNote: All the entity listed below are deprecated.