Template:KeyValue/doc
Jump to navigation
Jump to search
Note:Don't forget to use Template:= to escape any "=" characters in the text.
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.
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: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}} |
|
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}} |
|
intn |
The internal/engine name for this Keyvalue. | {{KV|Name|intn=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}} |
|
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}} |
|
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}} |
|
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}}}} |
|
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}}}} |
|
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...}} |
|
Future formatting
Parameters
- {{{new}}} - A temporary parameter that will be deleted along with the old code as soon as all pages are updated.
- {{{start}}} - The beginning of the table.
- {{{end}}} - End of the table.
- {{{divider}}} - Divides the contents of the table with an empty row.
- {{{sectiontitle}}} - The same as {{{divider}}}, but with the ability to write text.
- {{{deprecated}}} - Adds
Obsolete to the description, and also replaces the background of the table row. - {{{1}}} - Key
- {{{2}}} - Variable
- {{{3}}} - Property Name
- {{{4}}} - Description
- {{{value}}} - Default Value
- {{{color}}} - Default Value
- {{{rawValue}}} - Default Value
- {{{src}}} - Source
- {{{toKey}}} - "Key1 to Key2"
- {{{toPN}}} - "PropertyName1 to PropertyName2"
Preview
; start ([todo internal name (i)])
- {{{1}}} ([todo internal name (i)])
sound1 ([todo internal name (i)]) <string>(in all games since
) (removed since 
) (also in 
) - Deprecated.
Sound 1
- end ([todo internal name (i)])
See also