Template:I: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
mNo edit summary
(Added documentation)
Line 1: Line 1:
; {{#if: {{{deprecated|}}} | <del> }}<code>{{{1}}}</code> {{#if: {{{to|}}} | <span style="font-weight: normal; font-style: italic;">to</span> <code>{{{to}}}</code>}} {{#if: {{{param|}}} | {{KV Type|{{{param}}}}} }}{{#if: {{{deprecated|}}} | </del> }}{{#if: {{{since|}}} | &nbsp;{{{{{since}}} add}} }}{{#if: {{{nofgd|}}} | {{Not in FGD}} }}
<noinclude>
This template is used to generate input/output definitions on entity pages.
 
== Basic usage ==
<nowiki>{{IO|<name>|<description>}}</nowiki>
 
{{note|Don't forget to use [[Template:=]] to escape any "{{=}}" characters in the text.}}
 
== Named parameters ==
{| class=standard-table
! Parameter || Description || Example || Preview
|-
| <code>deprecated</code> || Used to mark deprecated Keyvalues || <code><nowiki>{{IO|OnDeprecated|Really, don't use me anymore!|deprecated=1}}</nowiki></code> || {{IO|OnDeprecated|Really, don't use me anymore!|deprecated=1}}
|-
| <code>nofgd</code> || This input/output isn't available in the official FGD. || <code><nowiki>{{IO|AddFGD|Because I'm not there!|nofgd=1}}</nowiki></code> || {{IO|AddFGD|Because I'm not there!|nofgd=1}}
|-
| <code>param</code> || Optional variable type for parameters. || <code><nowiki>{{IO|SetString|Updates the string.|param=string}}</nowiki></code> || {{IO|SetString|Updates the string.|param=string}}
|-
| <code>since</code> || This input/output is available since this game. Uses the template <nowiki>{{<game> add}}</nowiki>. || <code><nowiki>{{IO|OnAlienSwarm|I'm available in Portal 2, too!|since=AS}}</nowiki></code> || {{IO|OnAlienSwarm|I'm available in Portal 2, too!|since=AS}}
|-
| <code>to</code> || Use this to define a set of inputs/outputs with very similar names. || <code><nowiki>{{IO|Sound01|to=Sound24|There're many of us...}}</nowiki></code> || {{IO|Sound01|to=Sound24|There're many of us...}}
|}
 
== See also ==
* [[Template:KV]]
 
<hr>
</noinclude>; {{#if: {{{deprecated|}}} | <del> }}<code>{{{1}}}</code> {{#if: {{{to|}}} | <span style="font-weight: normal;">to</span> <code>{{{to}}}</code>}} {{#if: {{{param|}}} | {{KV Type|{{{param}}}}} }}{{#if: {{{deprecated|}}} | </del> }}{{#if: {{{since|}}} | &nbsp;{{{{{since}}} add}} }}{{#if: {{{nofgd|}}} | {{Not in FGD}} }}
: {{#if: {{{deprecated|}}} | Deprecated.&nbsp; }}{{#if: {{{2|}}} | {{{2}}} | {{todo|add description}} }}<noinclude>
: {{#if: {{{deprecated|}}} | Deprecated.&nbsp; }}{{#if: {{{2|}}} | {{{2}}} | {{todo|add description}} }}<noinclude>
[[Category:FGD Templates]]
[[Category:FGD Templates]]
</noinclude>
</noinclude>

Revision as of 22:09, 9 June 2011

This template is used to generate input/output definitions on entity pages.

Basic usage

{{IO|<name>|<description>}}

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

Named parameters

Parameter Description Example Preview
deprecated Used to mark deprecated Keyvalues {{IO|OnDeprecated|Really, don't use me anymore!|deprecated=1}}
OnDeprecated
Deprecated. Really, don't use me anymore!
nofgd This input/output isn't available in the official FGD. {{IO|AddFGD|Because I'm not there!|nofgd=1}}
AddFGD !FGD
Because I'm not there!
param Optional variable type for parameters. {{IO|SetString|Updates the string.|param=string}}
SetString <string>
Updates the string.
since This input/output is available since this game. Uses the template {{<game> add}}. {{IO|OnAlienSwarm|I'm available in Portal 2, too!|since=AS}}
OnAlienSwarm  Template:AS add
I'm available in Portal 2, too!
to Use this to define a set of inputs/outputs with very similar names. {{IO|Sound01|to=Sound24|There're many of us...}}
Sound01 to Sound24
There're many of us...

See also

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