Difference between revisions of "Template:KV"

From Valve Developer Community
Jump to: navigation, search
(Added support for Template:Removed)
m (hi not)
 
Line 1: Line 1:
; {{#if: {{{deprecated|}}} | <del> }}{{{1}}} {{#if: {{{intn|}}} | <span style="font-weight: normal;"><code>{{Hover info|dotted=no|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.|({{{intn}}})}}</code></span> }} {{#if: {{{to|}}}{{{intn2|}}} | <span style="font-weight: normal;">to</span> {{{to}}}{{#if:{{{intn2|}}} | &nbsp;<span style="font-weight: normal;"><code>{{Hover info|dotted=no|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.|({{{intn2}}})}}</code></span>}} }} {{#if: {{{2|}}} | {{KV Type|{{{2}}}}} }}{{#if: {{{deprecated|}}} | </del> }}{{#if: {{{only|}}} | &nbsp;{{#ifexist: Template:{{{only}}} only | {{{{{only}}} only}} | {{only|{{{only}}}}}}} }}{{#if: {{{since|}}} | &nbsp;{{#ifexist: Template:{{{since}}} add | {{{{{since}}} add}} | {{since|{{{since}}}}}}} }}{{#if: {{{removed|}}} | &nbsp;{{removed|{{{removed}}}}} }}{{#if: {{{also|}}} | &nbsp;{{#ifexist: Template:{{{also}}} also | {{{{{also}}} also}} | {{also|{{{also}}}}}}} }}{{#if: {{{nofgd|}}} | &nbsp;{{Not in FGD}} }}{{#if: {{{deprecated|}}} | &nbsp;{{obs}} }}
+
<includeonly>
: {{#if: {{{deprecated|}}} | Deprecated.&nbsp; }}{{#if: {{{3|}}} | {{{3}}}}}<noinclude>
+
; {{#if: {{{deprecated|}}} | <del> }}{{{1}}} {{#if: {{{intn|}}} | <span style="font-weight: normal;"><code>{{Hover info|dotted=no|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.|({{{intn}}})}}</code></span> }} {{#if: {{{to|}}}{{{intn2|}}} | <span style="font-weight: normal;">to</span> {{{to}}}{{#if:{{{intn2|}}} | &nbsp;<span style="font-weight: normal;"><code>{{Hover info|dotted=no|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.|({{{intn2}}})}}</code></span>}} }} {{#if: {{{2|}}} | {{KV Type|{{{2}}}}} }}{{#if: {{{deprecated|}}} | </del> }}{{#if: {{{only|}}} | &nbsp;{{#ifexist: Template:{{{only}}} only | {{{{{only}}} only}} | {{only|{{{only}}}}}}} }}{{#if: {{{since|}}} | &nbsp;{{#ifexist: Template:{{{since}}} add | {{{{{since}}} add}} | {{since|{{{since}}}}}}} }}{{#if: {{{removed|}}} | &nbsp;{{removed|{{{removed}}}}} }}{{#if: {{{not|}}} | &nbsp;{{#ifexist: Template:{{{not}}} not | {{{{{not}}} not}} | {{not|{{{not}}}}}}} }}{{#if: {{{also|}}} | &nbsp;{{#ifexist: Template:{{{also}}} also | {{{{{also}}} also}} | {{also|{{{also}}}}}}} }}{{#if: {{{nofgd|}}} | &nbsp;{{Not in FGD}} }}{{#if: {{{deprecated|}}} | &nbsp;{{obs}} }}
 +
: {{#if: {{{deprecated|}}} | Deprecated.&nbsp; }}{{#if: {{{3|}}} | {{{3}}}}}</includeonly><noinclude>
 
{{documentation}}
 
{{documentation}}
 
<!-- Add categories to the /doc subpage, not here -->
 
<!-- Add categories to the /doc subpage, not here -->
 
</noinclude>
 
</noinclude>

Latest revision as of 02:14, 17 April 2021

Template icon Template documentation[view] [edit] [history] [purge]

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

Usage

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

Note.png 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> <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. {{KV|Name|intn=targetname|string|The name that other entities refer to this entity by.}}
Name (targetname) <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