Template:IO

From Valve Developer Community
Revision as of 15:40, 8 May 2020 by Blixibon (talk | contribs) (Added support for Template:Removed)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search
{{{1}}}
Template icon Template documentation[view] [edit] [history] [purge]

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

Usage

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

Note: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!
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!|since={{as}}|removed={{csgo}}}}
OnAlienSwarm  (in all games since <Alien Swarm>) (removed in <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