Model entity/Generic Keyvalues, Inputs and Outputs/Keyvalues

From Valve Developer Community
< Model entity‎ | Generic Keyvalues, Inputs and Outputs
Revision as of 01:19, 21 April 2021 by Orinuse (talk | contribs) (KV_SystemLevelChoice)
Jump to navigation Jump to search
Template:KV_BaseEntity

This template is our holder for all keyvalues that are assigned through CBaseAnimating. The template has a very specific syntax that you must follow to apply properly, because new games have added new features throughout the years. See Help:Templates for more info on named parameters. No parameters: display only keyvalues available for ALL games.

{{KV BaseAnimating}}

Base: display keyvalues in a fashion that assumes the entity's orgin game's engine is older than Left 4 Dead.

{{KV BaseAnimating|base=1}}

Game as a parameter: display the keyvalues that base displays, AND keyvalues that were added to the class, by the specified game. You can specify as many games as needed. You must specify ALL the games you want to include (e.g. l4d2 will not automatically include l4d keyvalues as well). This is because there are situations like in Portal 2, where the output OnKilled is not available through CBaseEntity, despite being a far descendant of the L4D branch which added it.

{{KV BaseAnimating|portal2=1}}

All parameters for this template:

  • base - Assumes the entity's game belongs to an engine older than the Left 4 Dead branch (E.g. Portal, Team Fortress 2, Half-Life 2), then hides notes about games past it.
  • portalandsrc13 - Both will cross strike out certain keys that don't exist in their own games. (Specifically the (not in Portal) and (not in Source 2013))
  • l4d - Show Left 4 Dead only key quirks. and display keys added since Left 4 Dead.
  • l4d2 - Show Left 4 Dead 2 only key quirks, and display keys present since Left 4 Dead 2.
  • as - Display keys present since Alien Swarm.
  • portal2 - Display keys present since Portal 2.
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 complex technical reasons.

For full documentation on this family of templates, see FGD Template Prototype. Still confused on something? Ask for help before editing this template.

Note.pngNote:Some keyvalues in this template are actually defined by CBaseEntity. We have listed them here instead because those specific keyvalues were rather un-universal (for example renderfx, which would not have any practical use on point entities that are never seen, or on triggers), and putting them on every entity page would only cause confusion and clutter, the exact opposite goal in mind with this series of templates.
Note.pngNote:Content moved to Rendering and studio model related KIO/Keyvalues for continuation of page history