Template:KeyValue/doc

This is a documentation subpage for Template:KeyValue.
Don't forget to purge the contents of the base page upon creating or editing this subpage.  

Purge base's cache

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.}} {{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 ([todo internal name (i)]) <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 ) 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 ) (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 ) 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...

See also

• Template:IO
• Template:Fl
• Template:MatParam