Template:I: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
m ({{documentation}} -> {{doc}})
m (Increased readability.)
Line 1: Line 1:
{{lang|Template:IO}}<onlyinclude><includeonly>
{{lang|Template:IO}}<!--
; {{#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: {{{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}} }}
--><onlyinclude><includeonly>
: {{#if: {{{deprecated|}}} | Deprecated.&nbsp; }}{{#if: {{{2|}}} | {{{2}}}}}</includeonly></onlyinclude>
; {{#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: {{{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: {{{2|}}} | {{{2}}}}}<!--
--></includeonly></onlyinclude>
{{doc}}
{{doc}}

Revision as of 10:27, 11 September 2023

English (en)Deutsch (de)Esperanto (eo)Español (es)Français (fr)Suomi (fi)Hrvatski (hr)Magyar (hu)Italiano (it)日本語 (ja)한국어 (ko)Nederlands (nl)Polski (pl)Português (pt)Português do Brasil (pt-br)Русский (ru)Slovenčina (sk)Svenska (sv)Türkçe (tr)Українська (uk)Tiếng Việt (vi)中文 (zh)中文（臺灣） (zh-tw)
Curly brackets white.pngTemplate Documentation [view] [edit]
Icon-translate.png Available doc translations
View
Page history
…

This template is used to generate input definitions on entity pages. Use {{O}} for output definitions.

Usage

{{I|<name>|<description>}}

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

Examples and Parameters

Parameter Description Example Preview
deprecated This input/output is deprecated and should no longer be used. {{O|OnDeprecated|Really, don't use me anymore!|deprecated=1}}
OnDeprecated  Obsolete
Deprecated.
Really, don't use me anymore!
nofgd This input/output isn't available in the official FGD. {{I|AddFGD|Because I'm not there!|nofgd=1}}
AddFGD  !FGD
Because I'm not there!
param Optional variable type for parameters. {{I|SetString|Updates the string.|param=string}}
SetString <string>
Updates the string.
since This input/output is available since this game. Can use either {{<game> add}} or {{Since}} templates. {{O|OnAlienSwarm|I'm available in Portal 2, too!|since=AS}}
OnAlienSwarm  (in all games since Alien Swarm)
I'm available in Portal 2, too!
also This input/output is also available in this game. Can use either {{<game> also}} or {{Also}} templates. {{O|OnAlienSwarm|I'm also available in Garry's Mod!|since=AS|also=GMOD}}
OnAlienSwarm  (in all games since Alien Swarm) (also in Garry's Mod)
I'm also available in Garry's Mod!
only This input/output is available only in this game. Can use either {{<game> only}} or {{Only}} templates. {{O|OnAlienSwarm|I'm only available in Alien Swarm!|only=AS}}
OnAlienSwarm  (only in Alien Swarm)
I'm only available in Alien Swarm!
not This input/output is not available just in this game. Only uses the template {{Not}}. {{O|OnAlienSwarm|I'm available in Portal 2 as well, but not in CS:GO!|since={{as}}|not={{csgo}}}}
OnAlienSwarm  (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 input/output was removed in this game. Only uses the template {{Removed}}. {{O|OnAlienSwarm|I'm available in Portal 2 too, but not in CS:GO, nor in anything after it!|since={{as}}|removed={{csgo}}}}
OnAlienSwarm  (in all games since Alien Swarm) (removed since Counter-Strike: Global Offensive)
I'm available in Portal 2 too, but not in CS:GO!
to Use this to define a set of inputs/outputs with very similar names. {{I|SetTarget1|to=SetTarget4|param=string|Sets targets 1-4…}}
SetTarget1 to SetTarget4<string>
Sets targets 1-4…

See also

The above documentation is transcluded from Template:I/doc. (Edit | Page history)
Editors can experiment in this template's sandbox (create | mirror) and testcases (create) pages.
Retrieved from "https://developer.valvesoftware.com/w/index.php?title=Template:I&oldid=346221"