Template:I/doc: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
No edit summary
(Substituted IO templates and made other small improvements)
Line 1: Line 1:
{{Doc/subpage}}
{{Doc/subpage}}
<!-- Please place categories where indicated at the bottom of this page.) -->
<!-- Please place categories where indicated at the bottom of this page. -->
{{Shortcut|O}}
This template is used to generate input definitions on entity pages. Use {{T|O}} for output definitions (Template:O is redirected here so that the usage is the same).
This template is used to generate input definitions on entity pages. Use {{T|O}} for output definitions. (Template:O is redirect to this so the usage is the same)


== Usage ==
== Usage ==
<nowiki>{{IO|<name>|<description>}}</nowiki>
<nowiki>{{I|<name>|<description>}}</nowiki>


{{note|Don't forget to use [[Template:=]] to escape any "{{=}}" characters in the text.}}
{{note|Don't forget to use <code><nowiki>{{=}}</nowiki></code> to escape any "{{=}}" characters in the text.}}


== Examples and Parameters ==  
== Examples and Parameters ==  
Line 13: Line 12:
! Parameter || Description || Example || Preview
! Parameter || Description || Example || Preview
|-
|-
| <code>deprecated</code> || This input/output is deprecated and should no longer be used. || <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>deprecated</code> || This input/output is deprecated and should no longer be used. || <code><nowiki>{{O|OnDeprecated|Really, don't use me anymore!|deprecated=1}}</nowiki></code> || {{O|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>nofgd</code> || This input/output isn't available in the official FGD. || <code><nowiki>{{I|AddFGD|Because I'm not there!|nofgd=1}}</nowiki></code> || {{I|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>param</code> || Optional variable type for parameters. || <code><nowiki>{{I|SetString|Updates the string.|param=string}}</nowiki></code> || {{I|SetString|Updates the string.|param=string}}
|-
|-
| <code>since</code> || This input/output is available since this game. Can use either <nowiki>{{<game> add}}</nowiki> or {{tl|Since}} templates. || <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>since</code> || This input/output is available since this game. Can use either <nowiki>{{<game> add}}</nowiki> or {{tl|Since}} templates. || <code><nowiki>{{O|OnAlienSwarm|I'm available in Portal 2, too!|since=AS}}</nowiki></code> || {{O|OnAlienSwarm|I'm available in Portal 2, too!|since=AS}}
|-
|-
| <code>also</code> || This input/output is also available in this game. Can use either <nowiki>{{<game> also}}</nowiki> or {{tl|Also}} templates. || <code><nowiki>{{IO|OnAlienSwarm|I'm also available in Garry's Mod!|since=AS|also=GMOD}}</nowiki></code> || {{IO|OnAlienSwarm|I'm also available in Garry's Mod!|since=AS|also=GMOD}}
| <code>also</code> || This input/output is also available in this game. Can use either <nowiki>{{<game> also}}</nowiki> or {{tl|Also}} templates. || <code><nowiki>{{O|OnAlienSwarm|I'm also available in Garry's Mod!|since=AS|also=GMOD}}</nowiki></code> || {{O|OnAlienSwarm|I'm also available in Garry's Mod!|since=AS|also=GMOD}}
|-
|-
| <code>only</code> || This input/output is available only in this game. Can use either <nowiki>{{<game> only}}</nowiki> or {{tl|Only}} templates. || <code><nowiki>{{IO|OnAlienSwarm|I'm only available in Alien Swarm!|only=AS}}</nowiki></code> || {{IO|OnAlienSwarm|I'm only available in Alien Swarm!|only=AS}}
| <code>only</code> || This input/output is available only in this game. Can use either <nowiki>{{<game> only}}</nowiki> or {{tl|Only}} templates. || <code><nowiki>{{O|OnAlienSwarm|I'm only available in Alien Swarm!|only=AS}}</nowiki></code> || {{O|OnAlienSwarm|I'm only available in Alien Swarm!|only=AS}}
|-
|-
| <code>not</code> || This input/output is not available just in this game. Only uses the template {{tl|Not}}. || <code><nowiki>{{IO|OnAlienSwarm|I'm available in Portal 2 as well, but not in CS:GO!|since={{as}}|not={{csgo}}}}</nowiki></code> || {{IO|OnAlienSwarm|I'm available in Portal 2 too, but not in CS:GO!|since={{as}}|not={{csgo}}}}
| <code>not</code> || This input/output is not available just in this game. Only uses the template {{tl|Not}}. || <code><nowiki>{{O|OnAlienSwarm|I'm available in Portal 2 as well, but not in CS:GO!|since={{as}}|not={{csgo}}}}</nowiki></code> || {{O|OnAlienSwarm|I'm available in Portal 2 too, but not in CS:GO!|since={{as}}|not={{csgo}}}}
|-
|-
| <code>removed</code> || This input/output was removed in this game. Only uses the template {{tl|Removed}}. || <code><nowiki>{{IO|OnAlienSwarm|I'm available in Portal 2 too, but not in CS:GO, nor in anything after it!|since={{as}}|removed={{csgo}}}}</nowiki></code> || {{IO|OnAlienSwarm|I'm available in Portal 2 too, but not in CS:GO!|since={{as}}|removed={{csgo}}}}
| <code>removed</code> || This input/output was removed in this game. Only uses the template {{tl|Removed}}. || <code><nowiki>{{O|OnAlienSwarm|I'm available in Portal 2 too, but not in CS:GO, nor in anything after it!|since={{as}}|removed={{csgo}}}}</nowiki></code> || {{O|OnAlienSwarm|I'm available in Portal 2 too, but not in CS:GO!|since={{as}}|removed={{csgo}}}}
|-
|-
| <code>to</code> || Use this to define a set of inputs/outputs with very similar names. || <code><nowiki>{{IO|Sound01|to=Sound24|There are many of us...}}</nowiki></code> || {{IO|Sound01|to=Sound24|There are many of us…}}
| <code>to</code> || Use this to define a set of inputs/outputs with very similar names. || <code><nowiki>{{I|Sound01|to=Sound24|There are many of us...}}</nowiki></code> || {{I|Sound01|to=Sound24|There are many of us…}}
|}
|}


Line 37: Line 36:
* [[Template:MatParam]]
* [[Template:MatParam]]


<includeonly>{{sandbox other||
<includeonly>{{Sandbox other||
<!-- Categories below this line, please -->
<!-- Categories below this line, please -->
[[Category:FGD Templates]]
[[Category:FGD Templates]]
}}</includeonly>
}}</includeonly>

Revision as of 15:10, 21 April 2025

Edit-copy.png
This is a documentation subpage for Template:I.
Don't forget to purge the contents of the base page upon creating or editing this subpage.

This template is used to generate input definitions on entity pages. Use {{O}} for output definitions (Template:O is redirected here so that the usage is the same).

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|Sound01|to=Sound24|There are many of us...}}
Sound01 to Sound24
There are many of us…

See also


Retrieved from "https://developer.valvesoftware.com/w/index.php?title=Template:I/doc&oldid=472787"