Template:Altnames/doc

From Valve Developer Community
Jump to navigation Jump to search
English (en)Deutsch (de)Esperanto (eo)Español (es)Français (fr)Suomi (fi)Hrvatski (hr)Magyar (hu)Italiano (it)日本語 (ja)한국어 (ko)Nederlands (nl)Polski (pl)Português (pt)Português do Brasil (pt-br)Русский (ru)Slovenčina (sk)Svenska (sv)Türkçe (tr)Українська (uk)Tiếng Việt (vi)中文 (zh)中文(臺灣) (zh-tw)
Edit-copy.png
This is a documentation subpage for Template:Altnames.
Don't forget to purge the contents of the base page upon creating or editing this subpage.  
Inline note templates
Template Pages using it
28 August 2024
{{Note}} 6,436
{{Warning}} 1,253
{{Bug}} 1,192
{{Tip}} 1,516
{{Todo}} 1,628
{{Inline note}} 2,188
{{Confirm}} 672
{{Question}} 11
{{Fix}} 170
{{Important}} 459
{{Clarify}} 169
{{Elaborate}} 18
{{Main}} 143
{{Distinguish}} 85
{{Workaround}} 122
{{Seealso}} 145
{{Which}} 2
{{Why}} 38
{{Idea}} 21
{{PlacementTip}} 13
{{Codenote}} 21
{{Altnames}} 35
{{Deprecated}} 109
{{How}} 23
{{Example}} 16
{{Confusion}} 53
{{Thanks}} 7
{{Code Fix}} 9 + 7 (16)
{{Errornote}} 1
{{Vote}} 4

This template is intended to be used when multiple entity classnames are tied to single C++ class and they are also usable interchangeably with no or very little side effects, especially those that do not appear to serve any purpose other than deprecation.

Best example of this is prop_physics and physics_prop because physics_prop's classname keyvalue is also fixed-up to prop_physics immediately as it spawns before any classname checks can happen. But prop_physics_override which is also fixed-up shortly after spawning to prop_physics would not be marked as altname because the usage of the entity differs and there are checks in code that allowed it to spawn despite the model not having prop data.

Usage

Parameters

  • {{{name1}}} to {{{name8}}} - The alternate classnames.
  • {{{misc}}} - Optional: Use to display additional text in the same note.
  • {{{suf}}} - Optional: This is a suffix that will be added to all elements of the template to display the content in the desired language (if it is translated into it).
    Note.pngNote:There should be a colon before the language code, for example ":es".

Example

{{altnames|name1=x|name2=y|name3=z}} would return as:

AltNames.pngAltNames: This entity is also tied to xy and z.

{{altnames|name1=x|game={{game link|portal}}}} would return as:

AltNames.pngAltNames: In Portal Portal , this entity is also tied to x.