Template:VT/doc
Jump to navigation
Jump to search

This is a documentation subpage for Template:VT.
Don't forget to purge the contents of the base page upon creating or editing this subpage.
Don't forget to purge the contents of the base page upon creating or editing this subpage.
Just a list template for FGD and shader parameter templates to easily link to a wide variety of variable types.
Usage
This template accepts one parameter: the name of the variable type. It outputs a specific string depending on this parameter. It is not case-sensitive.
The following table lists inputs, their results, other inputs yielding the same results, and any things to note. Case variations are not included.
Code | Output | Aliases | Notes |
---|---|---|---|
{{VT|???}} |
<???> | Unknown type, verify from FGD docs. (with hover info) | |
{{VT|angle}} |
<angle> | Parsed as QAngle. | |
{{VT|angles}} |
<angles> | Parsed as QAngle. | |
{{VT|axis}} |
<axis> | ||
{{VT|bool}} |
<boolean> | boolean | FGD KV type is (in all games since ![]() ![]() Use choices instead in earlier games' FGDs, but note them as Booleans on the game pages themselves. |
{{VT|byte}} |
<byte> | unsigned char | Range 0-255. If the variable uses a regular integer with clamped range, use <integer 0–255> instead. |
{{VT|byte choices}} |
<byte choices> | ||
{{VT|char}} |
<char> | Use for signed chars (-128 to 127). | |
{{VT|char choices}} |
<char choices> | ||
{{VT|choices}} |
<choices> | Preferably use version which indicates the actual data type parsed by the code, such as <byte choices>, <integer choices>, or <string choices>. | |
{{VT|color1}} |
<color1> | ||
{{VT|color255}} |
<color255> | RGB, rgb | |
{{VT|color255 + int}} |
<color255 + int> | color255+int | |
{{VT|env_cubemap / texture}} |
<env_cubemap/texture> | cubemap/texture, cubemap / texture, env cubemap/texture, env cubemap / texture, env_cubemap/texture, env_cubemap / texture | |
{{VT|ehandle}} |
<targetname*> | IO type ehandle. | |
{{VT|file}} |
<file path> | filename, filepath | File path, treated as string. |
{{VT|filter}} |
<filter> | filterclass | |
{{VT|float}} |
<float> | ||
{{VT|int}} |
<integer> | integer | Enums without explicit type use this. |
{{VT|int 0-10}} |
<integer 0–10> | For ambient_generic. | |
{{VT|int 0-100}} |
<integer 0–100> | For ambient_generic. | |
{{VT|int 0-1000}} |
<integer 0–1000> | For ambient_generic. | |
{{VT|int 0-255}} |
<integer 0–255> | integer 0-255 | For ambient_generic. Not to be confused with <byte>. |
{{VT|integer}} |
<integer> | int | |
{{VT|integer choices}} |
<integer choices> | Parsed as int with selectable options. | |
{{VT|material property}} |
<property> | material property | Link to Material surface properties. |
{{VT|RGB matrix}} |
<RGB matrix> | Two separate links. | |
{{VT|script}} |
<script> | vscript | Link to Vscript. |
{{VT|scriptlist}} |
<scriptlist> | ||
{{VT|sky}} |
<sky name> | skybox, skyname | Link to Skybox. |
{{VT|string}} |
<string> | str | |
{{VT|string choices}} |
<string choices> | String with selectable options. | |
{{VT|studio}} |
<model path> | model, modelname, model name, modelpath, model path | Link to Model. |
{{VT|target}} |
<targetname> | targetname, target_destination, target_source | |
{{VT|variant}} |
<variant> | IO type variant. | |
{{VT|vector}} |
<vector> | vecline, vec | |
{{VT|vector2}} |
<vector2> | vec2 | Link to Material vector#vector2. |
{{VT|vector3}} |
<vector3> | vec3 | Link to Material vector#vector3. |
{{VT|vector4}} |
<vector4> | vec4 | Link to Material vector#vector4. |
{{VT|void}} |
<void> | <blank> | Signifies IO truly has no parameter instead of missing type. |
Any other input will be a link to that input.