Template:KeyValue: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
(Added obsolete icon for deprecated keyvalues)
m (Added MatParam to see also, removed todo for keyvalues with no description)
Line 29: Line 29:
== See also ==
== See also ==
* [[Template:IO]]
* [[Template:IO]]
* [[Template:MatParam]]


<hr>
<hr>
</noinclude>; {{#if: {{{deprecated|}}} | <del> }}{{{1}}} {{#if: {{{to|}}} | <span style="font-weight: normal;">to</span> {{{to}}} }} {{#if: {{{2|}}} | {{KV Type|{{{2}}}}} }}{{#if: {{{deprecated|}}} | </del> }}{{#if: {{{since|}}} | &nbsp;{{{{{since}}} add}} }}{{#if: {{{only|}}} | &nbsp;{{{{{only}}} only}} }}{{#if: {{{also|}}} | &nbsp;{{{{{also}}} also}} }}{{#if: {{{nofgd|}}} | &nbsp;{{Not in FGD}} }}{{#if: {{{deprecated|}}} | &nbsp;{{obs}} }}
</noinclude>; {{#if: {{{deprecated|}}} | <del> }}{{{1}}} {{#if: {{{to|}}} | <span style="font-weight: normal;">to</span> {{{to}}} }} {{#if: {{{2|}}} | {{KV Type|{{{2}}}}} }}{{#if: {{{deprecated|}}} | </del> }}{{#if: {{{since|}}} | &nbsp;{{{{{since}}} add}} }}{{#if: {{{only|}}} | &nbsp;{{{{{only}}} only}} }}{{#if: {{{also|}}} | &nbsp;{{{{{also}}} also}} }}{{#if: {{{nofgd|}}} | &nbsp;{{Not in FGD}} }}{{#if: {{{deprecated|}}} | &nbsp;{{obs}} }}
: {{#if: {{{deprecated|}}} | Deprecated.&nbsp; }}{{#if: {{{3|}}} | {{{3}}} | {{todo|add description}} }}<noinclude>
: {{#if: {{{deprecated|}}} | Deprecated.&nbsp; }}{{#if: {{{3|}}} | {{{3}}}}}<noinclude>
[[Category:FGD Templates]]
[[Category:FGD Templates]]
</noinclude>
</noinclude>

Revision as of 14:16, 28 August 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> Obsolete
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}}}