Template:KeyValue/doc: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
No edit summary
Line 13: Line 13:
! Parameter || Description || Example || Preview
! Parameter || Description || Example || Preview
|-
|-
| <code>deprecated</code> || This Keyvalue is deprecated and should no longer be used. || <code><nowiki>{{KV|I'm deprecated|intn=deprecated|string|Really, don't use me anymore!|deprecated=1}}</nowiki></code> || {{KV|I'm deprecated|intn=deprecated|string|Really, don't use me anymore!|deprecated=1}}
| align="center" | <code>deprecated</code> || This Keyvalue is deprecated and should no longer be used. || <pre style="margin:0">{{KV|I'm deprecated|intn=deprecated|string|Really, don't use me anymore!|deprecated=1}}</pre> || bgcolor="#262626" | {{KV|I'm deprecated|intn=deprecated|string|Really, don't use me anymore!|deprecated=1}}
|-
|-
| <code>nofgd</code> || This Keyvalue isn't available in the official FGD. || <code><nowiki>{{KV|Add me to the FGD|intn=addfgd|boolean|Because I'm not there!|nofgd=1}}</nowiki></code> || {{KV|Add me to the FGD|intn=addfgd|boolean|Because I'm not there!|nofgd=1}}
| align="center" | <code>nofgd</code> || This Keyvalue isn't available in the official FGD. || <pre style="margin:0">{{KV|Add me to the FGD|intn=addfgd|boolean|Because I'm not there!|nofgd=1}}</pre> || bgcolor="#262626" | {{KV|Add me to the FGD|intn=addfgd|boolean|Because I'm not there!|nofgd=1}}
|-
|-
| <code>intn</code> || The internal/engine name for this Keyvalue.<br>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 [[:Category:Valve FGDs|fgds]]. If internal name doesn't need to be specified use <code>intn=0.</code>
| align="center" | <code>intn</code> || The internal/engine name for this Keyvalue.<br>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 [[:Category:Valve FGDs|fgds]]. If internal name doesn't need to be specified use <code>intn=0.</code> || <pre style="margin:0">{{KV|Name|intn=targetname|string|The name that other entities refer to this entity by.}}</nowiki><br/><nowiki>
| <code><nowiki>{{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.}}</pre> || bgcolor="#262626" | {{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.}}</nowiki></code>
| {{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.}}
{{KV|Name|string|The name that other entities refer to this entity by.}}
|-
|-
| <code>since</code> || This Keyvalue is available since this game. Can use either <nowiki>{{<game> add}}</nowiki> or {{tl|Since}} templates. || <code><nowiki>{{KV|I like Alien Swarm|intn=likealienswarm|bool|I'm available in Portal 2, too!|since=AS}}</nowiki></code> || {{KV|I like Alien Swarm|intn=likealienswarm|bool|I'm available in Portal 2, too!|since=AS}}
| align="center" | <code>since</code> || This Keyvalue is available since this game. Can use either <nowiki>{{<game> add}}</nowiki> or {{tl|Since}} templates. || <pre style="margin:0">{{KV|I like Alien Swarm|intn=likealienswarm|bool|I'm available in Portal 2, too!|since=AS}}</pre> || bgcolor="#262626" | {{KV|I like Alien Swarm|intn=likealienswarm|bool|I'm available in Portal 2, too!|since=AS}}
|-
|-
| <code>also</code> || This Keyvalue is also available in this game. Can use either <nowiki>{{<game> also}}</nowiki> or {{tl|Also}} templates. || <code><nowiki>{{KV|I like Alien Swarm|intn=likealienswarm|bool|I'm also available in Garry's Mod!|since=AS|also=GMOD}}</nowiki></code> || {{KV|I like Alien Swarm|intn=likealienswarm|bool|I'm also available in Garry's Mod!|since=AS|also={{GMOD}}}}
| align="center" | <code>also</code> || This Keyvalue is also available in this game. Can use either <nowiki>{{<game> also}}</nowiki> or {{tl|Also}} templates. || <pre style="margin:0">{{KV|I like Alien Swarm|intn=likealienswarm|bool|I'm also available in Garry's Mod!|since=AS|also=GMOD}}</pre> || bgcolor="#262626" | {{KV|I like Alien Swarm|intn=likealienswarm|bool|I'm also available in Garry's Mod!|since=AS|also={{GMOD}}}}
|-
|-
| <code>only</code> || This Keyvalue is available only in this game. Can use either <nowiki>{{<game> only}}</nowiki> or {{tl|Only}} templates. || <code><nowiki>{{KV|I love Alien Swarm|intn=lovealienswarm|integer|I'm only available in Alien Swarm!|only=AS}}</nowiki></code> || {{KV|I love Alien Swarm|intn=lovealienswarm|integer|I'm only available in Alien Swarm!|only=AS}}
| align="center" | <code>only</code> || This Keyvalue is available only in this game. Can use either <nowiki>{{<game> only}}</nowiki> or {{tl|Only}} templates. || <pre style="margin:0">{{KV|I love Alien Swarm|intn=lovealienswarm|integer|I'm only available in Alien Swarm!|only=AS}}</pre> || bgcolor="#262626" | {{KV|I love Alien Swarm|intn=lovealienswarm|integer|I'm only available in Alien Swarm!|only=AS}}
|-
|-
| <code>not</code> || This Keyvalue is not available just in this game. Only uses the template {{tl|Not}}. || <code><nowiki>{{KV|I love Alien Swarm|intn=lovealienswarm|integer|I'm available in Portal 2 too, but not in CS:GO!|since={{as}}|removed={{csgo}}}}</nowiki></code> || {{KV|I love Alien Swarm|intn=lovealienswarm|integer|I'm available in Portal 2 too, but not in CS:GO!|since={{as}}|not={{csgo}}}}
| align="center" | <code>not</code> || This Keyvalue is not available just in this game. Only uses the template {{tl|Not}}. || <pre style="margin:0">{{KV|I love Alien Swarm|intn=lovealienswarm|integer|I'm available in Portal 2 too, but not in CS:GO!|since={{as}}|removed={{csgo}}}}</pre> || bgcolor="#262626" | {{KV|I love Alien Swarm|intn=lovealienswarm|integer|I'm available in Portal 2 too, but not in CS:GO!|since={{as}}|not={{csgo}}}}
|-
|-
| <code>removed</code> || This Keyvalue was removed in this game onwards. Only uses the template {{tl|Removed}}. || <code><nowiki>{{KV|I love Alien Swarm|intn=lovealienswarm|integer|Actually... I'm not here anymore since Portal 2, including CS:GO...|since={{as}}|removed={{csgo}}}}</nowiki></code> || {{KV|I love Alien Swarm|intn=lovealienswarm|integer|Actually... I'm not here anymore since Portal 2, including CS:GO...|since={{as}}|removed={{portal2}}}}
| align="center" | <code>removed</code> || This Keyvalue was removed in this game onwards. Only uses the template {{tl|Removed}}. || <pre style="margin:0">{{KV|I love Alien Swarm|intn=lovealienswarm|integer|Actually... I'm not here anymore since Portal 2, including CS:GO...|since={{as}}|removed={{csgo}}}}</pre> || bgcolor="#262626" | {{KV|I love Alien Swarm|intn=lovealienswarm|integer|Actually... I'm not here anymore since Portal 2, including CS:GO...|since={{as}}|removed={{portal2}}}}
|-
|-
| <code>to</code> || Use this to define a set of Keyvalues with very similar names. Use <code>intn2</code> for the second keyvalue's internal name. || <code><nowiki>{{KV|Sound 01|intn=Sound01|to=Sound 24|intn2=Sound24|string|There are many of us...}}</nowiki></code> || {{KV|Sound 01|intn=Sound01|to=Sound 24|intn2=Sound24|string|There are many of us...}}
| align="center" | <code>to</code> || Use this to define a set of Keyvalues with very similar names. Use <code>intn2</code> for the second keyvalue's internal name. || <pre style="margin:0">{{KV|Sound 01|intn=Sound01|to=Sound 24|intn2=Sound24|string|There are many of us...}}</pre> || bgcolor="#262626" | {{KV|Sound 01|intn=Sound01|to=Sound 24|intn2=Sound24|string|There are many of us...}}
|}
|}


Revision as of 10:15, 2 September 2025

Edit-copy.png
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.

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

Usage

{{KV|<name>|<variable type>|<description>}}
Note.pngNote: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> Obsolete
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 ([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 Alien Swarm)
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 Alien Swarm) (also in Garry's Mod)
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 Alien Swarm)
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 Alien Swarm) (not in Counter-Strike: Global Offensive)
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 Alien Swarm) (removed since Portal 2)
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


Retrieved from "https://developer.valvesoftware.com/w/index.php?title=Template:KeyValue/doc&oldid=487968"