Template:This is a/doc: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
(Created page with "{{documentation subpage}} This template has two purposes. See the following for details. == Parameters and Examples == {{Note|The template has still the old code of {{tl|point...")
 
mNo edit summary
Line 21: Line 21:
:* You can specify the entity type yourself. (See examples)
:* You can specify the entity type yourself. (See examples)
|
|
# {{CodeBlock|<nowiki>{{ent|mode=entity|type=''incredible entity''|engine=''Mosaic''}}</nowiki>}}
# {{CodeBlock|<nowiki>{{entity|mode=entity|type=''incredible entity''|engine=''Mosaic''}}</nowiki>}}
# {{CodeBlock|<nowiki>{{ent|mode=entity|type=e1|engine=3}}</nowiki>}}<br>
# {{CodeBlock|<nowiki>{{entity|mode=entity|type=e1|engine=3}}</nowiki>}}<br>
# {{CodeBlock|<nowiki>{{ent|mode=entity|type=e2|engine=1}}</nowiki>}}
# {{CodeBlock|<nowiki>{{entity|mode=entity|type=e2|engine=1}}</nowiki>}}
|
|
# {{Doc/PreviewBlock|{{ent|mode=entity|type=''incredible entity''|engine=''Mosaic''}}}}
# {{Doc/PreviewBlock|{{entity|mode=entity|type=''incredible entity''|engine=''Mosaic''}}}}
# {{Doc/PreviewBlock|{{ent|mode=entity|type=e1|engine=3}}}}
# {{Doc/PreviewBlock|{{entity|mode=entity|type=e1|engine=3}}}}
# {{Doc/PreviewBlock|{{ent|mode=entity|type=e2|engine=1}}}}
# {{Doc/PreviewBlock|{{entity|mode=entity|type=e2|engine=1}}}}
|-
|-
|align="center"|{{Code|{{param|engine}}}}
|align="center"|{{Code|{{param|engine}}}}
Line 36: Line 36:
:* Default - {{source|4}}
:* Default - {{source|4}}
|
|
# {{CodeBlock|<nowiki>{{ent|mode=entity|type=e1|engine=3}}</nowiki>}}
# {{CodeBlock|<nowiki>{{entity|mode=entity|type=e1|engine=3}}</nowiki>}}
# {{CodeBlock|<nowiki>{{ent|mode=entity|type=e1}}</nowiki>}}
# {{CodeBlock|<nowiki>{{entity|mode=entity|type=e1}}</nowiki>}}
|
|
# {{Documentation/PreviewBlock|{{ent|mode=entity|type=e1|engine=3}}}}
# {{Doc/PreviewBlock|{{entity|mode=entity|type=e1|engine=3}}}}
# {{Documentation/PreviewBlock|{{ent|mode=entity|type=e1}}}}
# {{Doc/PreviewBlock|{{entity|mode=entity|type=e1}}}}
|-
|-
|align="center"|{{Code|{{param|since}}}}
|align="center"|{{Code|{{param|since}}}}
| This entity is available since this game. {{Note|Should be the full name of the game, not a abbreviation (So templates can link to multilingual pages according to the language suffix).}}
| This entity is available since this game. {{Note|Should be the full name of the game, not a abbreviation (So templates can link to multilingual pages according to the language suffix).}}
| {{CodeBlock|<nowiki>{{ent|mode=entity|type=e0|info_player_start|engine=1|since=Half-Life}}</nowiki>}}
| {{CodeBlock|<nowiki>{{entity|mode=entity|type=e0|info_player_start|engine=1|since=Half-Life}}</nowiki>}}
| {{Documentation/PreviewBlock|{{ent|mode=entity|type=e0|notitlechange=1|info_player_start|engine=1|since=Half-Life}}}}
| {{Doc/PreviewBlock|{{entity|mode=entity|type=e0|notitlechange=1|info_player_start|engine=1|since=Half-Life}}}}
|-
|-
|align="center"|{{Code|{{param|1}}}}
|align="center"|{{Code|{{param|1}}}}
| The name of the entity. It will change the title of a page. {{Note|The template can't change the title when the {{tl|lang|}} is in use. }}{{workaround|Specify the {{param|title|tag=kbd}} of {{tl|lang}} to {{Code|<nowiki>{{Code|selected=1|<entity name>}}</nowiki>}}.}}
| The name of the entity. It will change the title of a page. {{Note|The template can't change the title when the {{tl|lang|}} is in use. }}{{workaround|Specify the {{param|title|tag=kbd}} of {{tl|lang}} to {{Code|<nowiki>{{Code|selected=1|<entity name>}}</nowiki>}}.}}
| {{CodeBlock|<nowiki>{{ent|mode=entity|type=e0|info_player_start}}</nowiki>}}
| {{CodeBlock|<nowiki>{{entity|mode=entity|type=e0|info_player_start}}</nowiki>}}
| {{Documentation/PreviewBlock|{{ent|mode=entity|type=e0|notitlechange=1|info_player_start}}}}
| {{Doc/PreviewBlock|{{entity|mode=entity|type=e0|notitlechange=1|info_player_start}}}}
|-
|-
|align="center"|{{Code|{{param|series}}}}
|align="center"|{{Code|{{param|series}}}}
| The series that the entity is available in.
| The series that the entity is available in.
| {{CodeBlock|<nowiki>{{ent|mode=entity|type=e2|series=Counter-Strike}}</nowiki>}}
| {{CodeBlock|<nowiki>{{entity|mode=entity|type=e2|series=Counter-Strike}}</nowiki>}}
| {{Documentation/PreviewBlock|{{ent|mode=entity|type=e2|series=Counter-Strike}}}}
| {{Doc/PreviewBlock|{{entity|mode=entity|type=e2|series=Counter-Strike}}}}
|-
|-
|align="center"|{{Code|{{param|seriescs}}}}
|align="center"|{{Code|{{param|seriescs}}}}
| The series of Counter-Strike that the entity is available in.
| The series of Counter-Strike that the entity is available in.
| {{CodeBlock|<nowiki>{{ent|mode=entity|type=e3|seriescs=Counter-Strike|game=Counter-Strike: Source}}</nowiki>}}
| {{CodeBlock|<nowiki>{{entity|mode=entity|type=e3|seriescs=Counter-Strike|game=Counter-Strike: Source}}</nowiki>}}
| {{Documentation/PreviewBlock|{{ent|mode=entity|type=e3|seriescs=Counter-Strike|game=Counter-Strike: Source}}}}
| {{Doc/PreviewBlock|{{entity|mode=entity|type=e3|seriescs=Counter-Strike|game=Counter-Strike: Source}}}}
|-
|-
|align="center"|{{Code|{{param|game}}}}
|align="center"|{{Code|{{param|game}}}}
| The game that the entity is available in. {{Note|Should be the full name of the game, not a abbreviation (So templates can link to multilingual pages according to the language suffix).}}
| The game that the entity is available in. {{Note|Should be the full name of the game, not a abbreviation (So templates can link to multilingual pages according to the language suffix).}}
| {{CodeBlock|<nowiki>{{ent|mode=entity|type=e5|game=Team Fortress 2}}</nowiki>}}
| {{CodeBlock|<nowiki>{{entity|mode=entity|type=e5|game=Team Fortress 2}}</nowiki>}}
| {{Documentation/PreviewBlock|{{ent|mode=entity|type=e5|game=Team Fortress 2}}}}
| {{Doc/PreviewBlock|{{entity|mode=entity|type=e5|game=Team Fortress 2}}}}
|-
|-
|align="center"|{{Code|{{param|notitlechange}}}}
|align="center"|{{Code|{{param|notitlechange}}}}
| You can prevent title-changing from the template by using this parameter. Used in the {{Code|/doc}} page.
| You can prevent title-changing from the template by using this parameter. Used in the {{Code|/doc}} page.
| {{CodeBlock|<nowiki>{{ent|mode=entity|type=e0|notitlechange=1|info_player_start|engine=1|since=Half-Life}}</nowiki>}}
| {{CodeBlock|<nowiki>{{entity|mode=entity|type=e0|notitlechange=1|info_player_start|engine=1|since=Half-Life}}</nowiki>}}
| {{Documentation/PreviewBlock|{{ent|mode=entity|type=e0|notitlechange=1|info_player_start|engine=1|since=Half-Life}}}}
| {{Doc/PreviewBlock|{{entity|mode=entity|type=e0|notitlechange=1|info_player_start|engine=1|since=Half-Life}}}}
|-
|-
|align="center"|{{Code|{{param|suf}}}}
|align="center"|{{Code|{{param|suf}}}}
| Specify the language suffix. The template supports multi-language and you can add more languages that the template supports.
| Specify the language suffix. The template supports multi-language and you can add more languages that the template supports.
|
|
# {{CodeBlock|<nowiki>{{ent|mode=entity|suf=:zh-cn|type=e0|info_player_start|engine=1|since=Half-Life}}</nowiki>}}
# {{CodeBlock|<nowiki>{{entity|mode=entity|suf=:zh-cn|type=e0|info_player_start|engine=1|since=Half-Life}}</nowiki>}}
# {{CodeBlock|<nowiki>{{ent|mode=entity|suf=:ru|type=e0|info_player_start|engine=1|since=Half-Life}}</nowiki>}}
# {{CodeBlock|<nowiki>{{entity|mode=entity|suf=:ru|type=e0|info_player_start|engine=1|since=Half-Life}}</nowiki>}}
|
|
# {{Documentation/PreviewBlock|{{ent|mode=entity|suf=:zh-cn|type=e0|notitlechange=1|info_player_start|engine=1|since=Half-Life}}}}
# {{Doc/PreviewBlock|{{entity|mode=entity|suf=:zh-cn|type=e0|notitlechange=1|info_player_start|engine=1|since=Half-Life}}}}
# {{Documentation/PreviewBlock|{{ent|mode=entity|suf=:ru|type=e0|notitlechange=1|info_player_start|engine=1|since=Half-Life}}}}
# {{Doc/PreviewBlock|{{entity|mode=entity|suf=:ru|type=e0|notitlechange=1|info_player_start|engine=1|since=Half-Life}}}}
|}
|}



Revision as of 04:05, 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.

This template has two purposes. See the following for details.

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|mode=entity|type=''incredible entity''|engine=''Mosaic''}}
  2. {{entity|mode=entity|type=e1|engine=3}}

  3. {{entity|mode=entity|type=e2|engine=1}}
{{{engine}}} Which engine the entity belongs to.
  1. {{entity|mode=entity|type=e1|engine=3}}
  2. {{entity|mode=entity|type=e1}}
{{{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|mode=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|mode=entity|type=e0|info_player_start}}
{{{series}}} The series that the entity is available in.
{{entity|mode=entity|type=e2|series=Counter-Strike}}
{{{seriescs}}} The series of Counter-Strike that the entity is available in.
{{entity|mode=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|mode=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|mode=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|mode=entity|suf=:zh-cn|type=e0|info_player_start|engine=1|since=Half-Life}}
  2. {{entity|mode=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}}