Template:KeyValue: Difference between revisions

Revision as of 08:32, 5 March 2023

Template Documentation [view] [edit]

Available doc translations

…

This template uses a strings subpage
Please follow the format on this subpage(s) to add translations.

Shortcut

KV
kv

This template is used to generate Keyvalue definitions on entity pages.

Usage

{{KV|<name>|<variable type>|<description>}}

Note:Don't forget to use Template:= to escape any "=" characters in the text.

Examples and Parameters

Parameter	Description	Example	Preview
`deprecated`	This Keyvalue is deprecated and should no longer be used.	{{KV\|I'm deprecated\|intn=deprecated\|string\|Really, don't use me anymore!\|deprecated=1}}	~~I'm deprecated `(deprecated)` `<string>`~~ Deprecated. Really, don't use me anymore!
`nofgd`	This Keyvalue isn't available in the official FGD.	{{KV\|Add me to the FGD\|intn=addfgd\|boolean\|Because I'm not there!\|nofgd=1}}	Add me to the FGD `(addfgd)` `<boolean>` !FGD Because I'm not there!
`intn`	The internal/engine name for this Keyvalue. Required; if absent, the page will display green todo text and applies Category:Pages with undefined internal keyvalue names. You can look for internal names in fgds. If internal name doesn't need to be specified use `intn=0.`	{{KV\|Name\|intn=targetname\|string\|The name that other entities refer to this entity by.}}</nowiki><br/><nowiki> {{KV\|Name\|string\|The name that other entities refer to this entity by.}}	Name `(targetname)` `<string>` The name that other entities refer to this entity by. Name `<string>` The name that other entities refer to this entity by.
`since`	This Keyvalue is available since this game. Can use either {{<game> add}} or `{{Since}}` templates.	{{KV\|I like Alien Swarm\|intn=likealienswarm\|bool\|I'm available in Portal 2, too!\|since=AS}}	I like Alien Swarm `(likealienswarm)` `<boolean>` (in all games since AS) I'm available in Portal 2, too!
`also`	This Keyvalue is also available in this game. Can use either {{<game> also}} or `{{Also}}` templates.	{{KV\|I like Alien Swarm\|intn=likealienswarm\|bool\|I'm also available in Garry's Mod!\|since=AS\|also=GMOD}}	I like Alien Swarm `(likealienswarm)` `<boolean>` (in all games since AS) (also in ) I'm also available in Garry's Mod!
`only`	This Keyvalue is available only in this game. Can use either {{<game> only}} or `{{Only}}` templates.	{{KV\|I love Alien Swarm\|intn=lovealienswarm\|integer\|I'm only available in Alien Swarm!\|only=AS}}	I love Alien Swarm `(lovealienswarm)` `<integer>` (only in AS) I'm only available in Alien Swarm!
`not`	This Keyvalue is not available just in this game. Only uses the template `{{Not}}`.	{{KV\|I love Alien Swarm\|intn=lovealienswarm\|integer\|I'm available in Portal 2 too, but not in CS:GO!\|since={{as}}\|removed={{csgo}}}}	I love Alien Swarm `(lovealienswarm)` `<integer>` (in all games since ) (not in ) I'm available in Portal 2 too, but not in CS:GO!
`removed`	This Keyvalue was removed in this game onwards. Only uses the template `{{Removed}}`.	{{KV\|I love Alien Swarm\|intn=lovealienswarm\|integer\|Actually... I'm not here anymore since Portal 2, including CS:GO...\|since={{as}}\|removed={{csgo}}}}	I love Alien Swarm `(lovealienswarm)` `<integer>` (in all games since ) (removed since ) Actually... I'm not here anymore since Portal 2, including CS:GO...
`to`	Use this to define a set of Keyvalues with very similar names. Use `intn2` for the second keyvalue's internal name.	{{KV\|Sound 01\|intn=Sound01\|to=Sound 24\|intn2=Sound24\|string\|There are many of us...}}	Sound 01 `(Sound01)` to Sound 24 `(Sound24)` `<string>` There are many of us...

@@ Line 26: / Line 26: @@
 -->{{#if:{{{new|}}}|<tr bgcolor="#{{#switch:{{{deprecated|}}}|true=423333|3a3a3a}}" style="{{#switch:{{{deprecated|}}}|true=cursor:help|}}" {{#switch:{{{deprecated|}}}|true=title="Deprecated."|}}>
-	<td align="center">{{{1|}}}{{#if:{{{intn2|}}}|&nbsp;<span style="opacity:.7">to</span> {{{intn2|}}}|}}</td>
+	<td align="center"><kbd>{{{1|}}}{{#if:{{{intn2|}}}|&nbsp;<span style="opacity:.7">to</span> {{{intn2|}}}|}}</kbd></td>
 	<td align="center">{{KV Type|{{{2}}}}}</td>
 	<td align="center">{{#if:{{{base|}}}|Delivered from '''{{{base|}}}'''|}}</td>
@@ Line 37: / Line 37: @@
 | start = <table cellpadding="4" width="100%" style="border:1px solid #525252">
 	<tr style="background-color:#949494; color:#141414">
-	<th width=8%>Key</th>
+	<th>Key <span style="opacity:.7; user-select:none; cursor:help" title="The internal name for this keyvalue; this is what the engine knows this keyvalue as. These display in Hammer for keyvalues when SmartEdit is disabled, or for keyvalues not in the FGD.">(?)</span></th>
-	<th width=8%>Variable</th>
+	<th>Variable</th>
-	<th width=15%>Delivery <span style="opacity:.7; user-select:none; cursor:help" title="If the keyvalues were specified in FGD using base(), then it will be written below what exactly delivers these keyvalues.">(?)</span></th>
+	<th>Delivery <span style="opacity:.7; user-select:none; cursor:help" title="If the keyvalues were specified in FGD using base(), then it will be written below what exactly delivers these keyvalues.">(?)</span></th>
-	<th width=20%>Property Name</th>
+	<th>Property Name</th>
-	<th width=10%>Default Value</th>
+	<th>Default Value</th>
-	<th width=40%>Description</th>
+	<th>Description</th>
 	</tr>|}}<!--

Template:KeyValue: Difference between revisions

Revision as of 08:32, 5 March 2023

Usage

Examples and Parameters

See also

Navigation menu

Template:KeyValue: Difference between revisions

Revision as of 08:32, 5 March 2023

Usage

Examples and Parameters

See also

Navigation menu

Search