Template:KV BaseEntity/doc: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
m (see also, and formatting fix for code tag)
m (Removed KV_BaseEntity at the very bottom)
Line 15: Line 15:
| Show Deprecated: }}
| Show Deprecated: }}


These must be used in a specific syntax; All the parameters must be given a value of 1, like for example:<code>l4d2=1</code>for {{l4d2}} specific info. Refer to the [[#Examples|Examples]] section.
These must be used in a specific syntax; All the parameters must be given a value of 1, like for example:<code>l4d2=1</code>for {{l4d2}} specific info. Only one game parameter can be used at once.
 
Refer to the [[#Examples|Examples]] section for samples.
== Examples ==
== Examples ==
=== Show info specific to a game {{csgo}} ===
=== Show info specific to a game {{csgo}} ===
Line 46: Line 48:
* {{tl|I BaseAnimating}}
* {{tl|I BaseAnimating}}
----
----
{{KV BaseEntity}}
<includeonly>
<includeonly>
<!--{{otherlang2
<!--{{otherlang2

Revision as of 05:08, 17 May 2021

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

Info holder for all keyvalues that inherit theCBaseEntity class. Parameters are vital to display the appropiate info, because new games have added new features throughout the years. See Help:Templates for more info on named parameters.

Note.pngNote:If you want to edit something on this template, please make sure you edit it in both places. Per-game keyvalues are duplicated, for technical reasons. Also see FGD Template Prototype.
Note.pngNote:Some CBaseEntity keyvalues are not covered here. See the talk page.

Usage

All parameters for this template:

  • base- Shows only information relevant to when it was initially added for the first time
  • l4d2- Include info specific to Left 4 Dead 2 (VScripts)
  • csgo- Include info specific to Counter-Strike: Global Offensive (Auto-aim targets)
  • brush- Include info specific to all sorts of brushes. For extra keys applicable only to visible brushes, use Template:KV visiblebrush in conjunction.
Show Deprecated:  
  • css- (DEPRECATED 10/1/18: Previously used for a notice that was thought to apply to all entities in CS:S. The purpose of this now exists in Template:PreservedEnt. This is completely removed from the template and won't affect anything.) (DEPRECATED 24/3/2021 was brought back for info specific to theteamnumkey. Use {{KV TeamNum}} instead.)
  • l4d- (DEPRECATED 9/21/18: Found out these keyvalues only work with renderable things (cpu / gpu level). They have been migrated to visiblebrush and BaseAnimating KV templates. This is completely removed from the template and won't affect anything.)
  • tf2- (DEPRECATED 20/4/2021: Was only used to showTeamNumkeyvalue's TF2 specific information. Use {{KV TeamNum}} instead.)

These must be used in a specific syntax; All the parameters must be given a value of 1, like for example:l4d2=1for Left 4 Dead 2 specific info. Only one game parameter can be used at once.

Refer to the Examples section for samples.

Examples

Show info specific to a game Counter-Strike: Global Offensive

This makes information relevant only to Counter-Strike: Global Offensive be displayed.

{{KV BaseEntity|csgo=1}}
will: 

Show info for its base

Information relevant only to this key at / before Half-Life 2: Episode Two is displayed.

{{KV BaseEntity|base=1}}
will: 

Show info related to brushes

Extra brush related keyvalues are displayed with this.

{{KV BaseEntity|brush=1}}
will: 

Show information for all games

Shows every game information for this key that this template can display. (Except for brush related)

{{KV BaseEntity}}
will: 

See Also

  • {{KV BaseAnimating}}
  • {{I BaseEntity}}
  • {{I BaseAnimating}}