Template:I/doc

From Valve Developer Community
Jump to: navigation, search
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)
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 redirect to this so the usage is the same)

Usage

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

Note.pngNote:Don't forget to use Template:= 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. {{IO|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. {{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. Can use either {{<game> add}} or {{Since}} templates. {{IO|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. {{IO|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. {{IO|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}}. {{IO|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}}. {{IO|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. {{IO|Sound01|to=Sound24|There are many of us...}}
Sound01 to Sound24
There are many of us…

See also