Template:KIO

From Source Entities
Jump to navigation Jump to search

Info.png

This template is high-use or intricate. Changes made to it may break other templates, and/or a large amount of pages. It might also cause a significant server load. If you want to make changes to it, you are advised to test them first on Template:KIO/Sandbox. It might also be a good idea to discuss changes on the talk page.

This template is a standard format for listing keyvalues, inputs, outputs, VMT/QC parameters, or really anything else! It's just a standard, though. You don't have to use it on everything.

Note: If something was left blank despite it having an FGD description, consider it could have been because that one isn't satisfactory. The purpose of these pages is to explain, not to copy gibberish from a text file readers already have.

Note: Use Template:varcom for convars and concommands!

Parameters[edit source]

  1. Name of the keyvalue, output, whatever.
  2. Optional parameter. If there's none to add, just leave it totally blank. For Hammer-accessible items this should match with something the FGD parser actually knows, so nothing like "color255 + int" or "targetname".
  3. Description.
{{KIO|I'm a regular Joe||Hi.}}
{{KIO|I like letters|string|Stringy.}}
I'm a regular Joe
Hi.
I like letters <string>
Stringy.


Use {{{donotuse}}} to mark things that should not be used. They probably got replaced with something else.

{{KIO|Don't use me||donotuse=1|I probably only exist in the FGD.}}
Don't use me
I probably only exist in the FGD.


Use {{{to}}} to define a set of things with very similar names.

{{KIO|$basetexture1|to=$basetexture4|string|There are many of us.}}
$basetexture1 to $basetexture4 <string>
There are many of us.


Use {{{since}}} for things that have only been available since X game.

{{KIO|I like Alien Swarm|integer|since={{asw}}|I'm Portal 2 and CSGO as well.}}
I like Alien Swarm <integer> (available in all games since Asw.png)
I'm Portal 2 and CSGO as well.


Use {{{only}}} for things that are only in a certain game or games.

Note: It's not worth noting that something is in a game if it's useful for another game its in, but not the one in question. See the Activate/Deactivate inputs on point_camera, which were made solely for a feature in Alien Swarm, but exist in Portal 2 and CS:GO as well and are useless. This logic does not apply to entire entities, though.

{{KIO|OnWhat||only={{l4d}}{{csgo}}|Valve was indecisive!}}
OnWhat  (only available in L4d.pngCsgo-small.png)
Valve was indecisive!


Use {{{c}}} to add a non-FGD version of this keyvalue's name.

{{KIO|SmartEdit name|c=secretname|integer|Nothing to hide.}}
SmartEdit name (secretname) <integer>
Nothing to hide. Also, use {{{toc}}} to add a {{{c}}} for the {{{to}}} value.


The nofgd parameter no longer exists. Please use Template:nofgd directly, next to the name of the KV/I/O.

Tip: If you don't want the todo to appear when {{{3}}} is left blank, just add the third |, like this: {{KIO|foo|foo|}}.