Generic Keyvalues, Inputs and Outputs/Keyvalues: Difference between revisions
m (An incorrect comment corrected x2) |
m (Swapped the headers around in the params documentation seciton) |
||
| Line 2: | Line 2: | ||
__NOTOC__ | __NOTOC__ | ||
This template is our holder for all [[keyvalues]] that are assigned through {{ent|CBaseEntity}}. 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. | This template is our holder for all [[keyvalues]] that are assigned through {{ent|CBaseEntity}}. 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 keyvalues for ALL games. | |||
<pre>{{KV BaseEntity}}</pre> | <pre>{{KV BaseEntity}}</pre> | ||
''' | '''Base:''' display keyvalues that have only existed since whatever game added the class (most have existed since HL2, the first Source game). | ||
<pre>{{KV BaseEntity|base=1}}</pre> | <pre>{{KV BaseEntity|base=1}}</pre> | ||
''' | '''Game as a parameter:''' display the keyvalues that <code>base</code> 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. <code>l4d2</code> will not automatically include <code>l4d</code> keyvalues as well). This is because there are situations like in Portal 2, where the output <code>OnKilled</code> is not available through <code>CBaseEntity</code>, despite being a far descendant of the L4D branch which added it. | ||
<pre>{{KV BaseEntity|l4d2=1}}</pre> | <pre>{{KV BaseEntity|l4d2=1}}</pre> | ||
All parameters for this template: | All parameters for this template: | ||
Revision as of 04:16, 11 April 2021
This template is our holder for all keyvalues that are assigned through CBaseEntity. 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 keyvalues for ALL games.
{{KV BaseEntity}}
Base: display keyvalues that have only existed since whatever game added the class (most have existed since HL2, the first Source game).
{{KV BaseEntity|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 BaseEntity|l4d2=1}}
All parameters for this template:
base- (Use if the entity was available before L4D2.)l4d- (DEPRECATED 9/21/18: Found out these keyvalues only work with renderable things. They have been migrated to visiblebrush and BaseAnimating KV templates. This is completely removed from the template and won't affect anything.)l4d2csgocss-(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.) (24/3/2021 brought back for theteamnumkey)brush- (This adds things common for all brush entities, visible or not. For visible ones, use Template:KV visiblebrush in conjunction.)tf2- AlterTeamNumkeyvalue to show TF2 specific information. Usetf2=teamnum_dont_put_nofgdto remove the !FGD tag.
Note: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.Note:Some CBaseEntity keyvalues are not covered here. See the talk page.