Template:KeyValue: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
m (Fix)
m (Misc fixes)
Line 14: Line 14:
! Parameter || Description || Example || Preview
! Parameter || Description || Example || Preview
|-
|-
| <code>deprecated</code> || Used to mark deprecated Keyvalues || <code><nowiki>{{KV|I'm deprecated|string|Really, don't use me anymore!|deprecated=1}}</nowiki></code> || {{KV|I'm deprecated|string|Really, don't use me anymore!|deprecated=1}}
| <code>deprecated</code> || This Keyvalue is deprecated and should no longer be used. || <code><nowiki>{{KV|I'm deprecated|string|Really, don't use me anymore!|deprecated=1}}</nowiki></code> || {{KV|I'm 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|boolean|Because I'm not there!|nofgd=1}}</nowiki></code> || {{KV|Add me to the FGD|boolean|Because I'm not there!|nofgd=1}}
| <code>nofgd</code> || This Keyvalue isn't available in the official FGD. || <code><nowiki>{{KV|Add me to the FGD|boolean|Because I'm not there!|nofgd=1}}</nowiki></code> || {{KV|Add me to the FGD|boolean|Because I'm not there!|nofgd=1}}
Line 20: Line 20:
| <code>since</code> || This Keyvalue is available since this game. Uses the template <nowiki>{{<game> add}}</nowiki>. || <code><nowiki>{{KV|I like Alien Swarm|integer|I'm available in Portal 2, too!|since=AS}}</nowiki></code> || {{KV|I like Alien Swarm|integer|I'm available in Portal 2, too!|since=AS}}
| <code>since</code> || This Keyvalue is available since this game. Uses the template <nowiki>{{<game> add}}</nowiki>. || <code><nowiki>{{KV|I like Alien Swarm|integer|I'm available in Portal 2, too!|since=AS}}</nowiki></code> || {{KV|I like Alien Swarm|integer|I'm available in Portal 2, too!|since=AS}}
|-
|-
| <code>also</code> || This input/output is also available in this game. Uses the template <nowiki>{{<game> also}}</nowiki>. || <code><nowiki>{{KV|I like Alien Swarm|integer|I'm also available in Garry's Mod!|since=AS|also=GMOD}}</nowiki></code> || {{KV|I like Alien Swarm|integer|I'm also available in Garry's Mod!|since=AS|also=GMOD}}
| <code>also</code> || This Keyvalue is also available in this game. Uses the template <nowiki>{{<game> also}}</nowiki>. || <code><nowiki>{{KV|I like Alien Swarm|integer|I'm also available in Garry's Mod!|since=AS|also=GMOD}}</nowiki></code> || {{KV|I like Alien Swarm|integer|I'm also available in Garry's Mod!|since=AS|also=GMOD}}
|-
|-
| <code>only</code> || This Keyvalue is available only in this game. Uses the template <nowiki>{{<game> only}}</nowiki>. || <code><nowiki>{{KV|I love Alien Swarm|integer|I'm only available in Alien Swarm!|only=AS}}</nowiki></code> || {{KV|I love Alien Swarm|integer|I'm only available in Alien Swarm!|only=AS}}
| <code>only</code> || This Keyvalue is available only in this game. Uses the template <nowiki>{{<game> only}}</nowiki>. || <code><nowiki>{{KV|I love Alien Swarm|integer|I'm only available in Alien Swarm!|only=AS}}</nowiki></code> || {{KV|I love Alien Swarm|integer|I'm only available in Alien Swarm!|only=AS}}
|-
|-
| <code>to</code> || Use this to define a set of Keyvalues with very similar names. || <code><nowiki>{{KV|Sound 01|to=Sound 24|string|There're many of us...}}</nowiki></code> || {{KV|Sound 01|to=Sound 24|string|There're many of us...}}
| <code>to</code> || Use this to define a set of Keyvalues with very similar names. || <code><nowiki>{{KV|Sound 01|to=Sound 24|string|There are many of us...}}</nowiki></code> || {{KV|Sound 01|to=Sound 24|string|There are many of us...}}
|}
|}


Revision as of 12:02, 6 June 2019

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

Basic usage

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

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

Named parameters

Parameter Description Example Preview
deprecated This Keyvalue is deprecated and should no longer be used. {{KV|I'm deprecated|string|Really, don't use me anymore!|deprecated=1}}
I'm 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|boolean|Because I'm not there!|nofgd=1}}
Add me to the FGD <boolean> !FGD
Because I'm not there!
since This Keyvalue is available since this game. Uses the template {{<game> add}}. {{KV|I like Alien Swarm|integer|I'm available in Portal 2, too!|since=AS}}
I like Alien Swarm <integer> Template:AS add
I'm available in Portal 2, too!
also This Keyvalue is also available in this game. Uses the template {{<game> also}}. {{KV|I like Alien Swarm|integer|I'm also available in Garry's Mod!|since=AS|also=GMOD}}
I like Alien Swarm <integer> Template:AS add Template:GMOD also
I'm also available in Garry's Mod!
only This Keyvalue is available only in this game. Uses the template {{<game> only}}. {{KV|I love Alien Swarm|integer|I'm only available in Alien Swarm!|only=AS}}
I love Alien Swarm <integer> Template:AS only
I'm only available in Alien Swarm!
to Use this to define a set of Keyvalues with very similar names. {{KV|Sound 01|to=Sound 24|string|There are many of us...}}
Sound 01 to Sound 24 <string>
There are many of us...

See also

{{{1}}}
Todo: add description
Retrieved from "https://developer.valvesoftware.com/w/index.php?title=Template:KeyValue&oldid=224945"