Template:Ent/doc: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
No edit summary
 
(8 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Doc/subpage}}
{{Doc/subpage}}
This template is a faster and cleaner way of marking text as both a link and code. Its primary use is on entity names. See the following for its syntax.
This template is a faster and cleaner way of marking text as both a link and code. It should be used only on entity names. See the following for its syntax.


== Parameters and Examples ==
== Parameters and Examples ==
{{todo|document {{param|eng}}.}}
{| class=standard-table | style="width:100%"
{| class=standard-table | style="width:100%"
|-
|-
Line 11: Line 10:
! Preview
! Preview
|-
|-
| align=center |{{Code|{{Param}}}}
| align="center" | <code>{{Param}}</code>
|The entity name should link and show.
| The entity name should link and show.
|{{CodeBlock|<nowiki>{{ent|logic_relay}}</nowiki>}}
| <pre>{{ent|logic_relay}}</pre>
|{{Capsule|{{ent|logic_relay}}}}
| bgcolor="#262626" | {{ent|logic_relay}}
|-
|-
| align=center |{{Code|{{Param|2}}}}
| align="center" | <code>{{Param|game}}</code>
|Optionally, you can specify a second field of text to not be counted as a link.
| Game name. Appends <code>' ({{param|game}})'</code> to the link.
| {{CodeBlock|<nowiki>{{ent|sv_cheats|1}}</nowiki>}}
| <pre>{{ent|player|game=Left 4 Dead series}}</pre>
| {{Capsule|{{ent|sv_cheats|1}}}}
| bgcolor="#262626" | {{ent|player|game=Left 4 Dead series}}
|-
|-
| align=center |{{Code|{{Param|alt}}}}
| align="center" | <code>{{Param|engine}}</code>
|The entity name should show. Additionally, you can specify {{Param|alt}} as a different name to show.
| Engine name. Specifying
|{{CodeBlock|<nowiki>{{ent|Team Fortress 2.fgd|alt=tf.fgd}}</nowiki>}}
* 0 or goldsrc appends ' (GoldSrc)' to the link
|{{Capsule|{{ent|Team Fortress 2.fgd|alt=tf.fgd}}}}
* 1 or source appends ' (Source)' to the link
* 2 or source 2 appends ' (Source 2)' to the link
| <pre>{{ent|func_pushable|engine=goldsrc}}</pre>
| bgcolor="#262626" | {{ent|func_pushable|engine=goldsrc}}
|-
|-
|}
|}


== See also ==
== See also ==
* {{T|matparam}}
* {{T|cmd}}
* {{T|cmd}}



Latest revision as of 10:17, 24 August 2025

Edit-copy.png
This is a documentation subpage for Template:Ent.
Don't forget to purge the contents of the base page upon creating or editing this subpage.

This template is a faster and cleaner way of marking text as both a link and code. It should be used only on entity names. See the following for its syntax.

Parameters and Examples

Parameter Description Example Preview
{{{1}}} The entity name should link and show.
{{ent|logic_relay}}
logic_relay
{{{game}}} Game name. Appends ' ({{{game}}})' to the link.
{{ent|player|game=Left 4 Dead series}}
player
{{{engine}}} Engine name. Specifying
  • 0 or goldsrc appends ' (GoldSrc)' to the link
  • 1 or source appends ' (Source)' to the link
  • 2 or source 2 appends ' (Source 2)' to the link
{{ent|func_pushable|engine=goldsrc}}
func_pushable

See also