Template:MatParamDef
From Valve Developer Community
Available doc translations 
EnglishThis template is used to generate material shader parameter definitions on material shader pages.
Usage
{{MatParamDef|<name>|<variable type>|<description>}}
Examples and Parameters
Warning:The code in the example will not work correctly due to the use of <kbd> in the template. Please refer to the $bumpmap page code to see the current code.| Parameter | Description | Example | Preview |
|---|---|---|---|
{{{text}}}or {{{3}}}
|
Description of the parameter.
If specified, then you will not encounter the problem of a broken description if there are equal signs in it. You can also use If not specified, it is replaced with TODO. |
{{MatParamDef
| $stupidequalsign | bool | text = Wow, I've been fixed! Look at this {{Emoji|point_right}} 2 + 2 = 5
}}
|
Wow, I've been fixed! Look at this  2 + 2 = 5 |
{{{described}}}
|
Replaces the text with a link to the specified material parameter. | {{MatParamDef
| $describedcutie | texture | described = true
}}
|
Todo: This shader material has not been documented. |
{{{deprecated}}}
|
This material parameter is deprecated and should no longer be used. | {{MatParamDef
| I'm deprecated | bool | deprecated = 1
| Really, don't use me anymore!
}}
|
Really, don't use me anymore! |
{{{since}}}
|
This material parameter is available since this game. Uses the template {{Since}}.
|
{{MatParamDef
| $likealienswarm | bool | since = {{as}}
| I'm available in Portal 2, too!
}}
|
I'm available in Portal 2, too! |
{{{also}}}
|
This material parameter is also available in this game. Uses the template {{Also}}.
|
{{MatParamDef
| $likealienswarm | bool | since = {{as}} | also = {{GMOD}}
| I'm also available in Garry's Mod!
}}
|
I'm also available in Garry's Mod! |
{{{only}}}
|
This material parameter is available only in this/these game(s). Uses the template {{Only}}.
|
{{MatParamDef
| $lovealienswarm | integer | only = {{as}}
| I'm only available in Alien Swarm!
}}
|
I'm only available in Alien Swarm! |
{{{removed}}}
|
This material parameter was removed in this game. Uses the template {{Removed}}.
|
{{MatParamDef
| $dxparameter | int | removed = {{l4d}}
| I was removed in Left 4 Dead!
}}
|
I was removed in Left 4 Dead! |
{{{dx9}}}
|
This material parameter requires DX9 or higher to function. | {{MatParamDef
| $dx9parameter | bool | dx9 = 1
| I require DX9 to work!
}}
|
I require DX9 to work! |
{{{dx8}}}
|
This material parameter is for DX8, and should not be used for DX9. | {{MatParamDef
| $dx8parameter | bool | dx8 = 1
| I'm a material parameter for DX8!
}}
|
I'm a material parameter for DX8! |
{{{to}}}
|
Use this to define a set of material parameters with very similar names. | {{MatParamDef
| $basetexture1 | to = $basetexture4 | texture
| There are many of us...
}}
|
There are many of us... |
{{{and}}}
|
Use this to define two material parameters with very similar names. | {{MatParamDef
| $bumpmap | and = $bumpmap2 | texture
| This shader supports two bump maps.
}}
|
|
{{{shaders}}}
|
Lists the shaders for a specific material parameter. Uses the template {{Shaders}}.
|
{{MatParamDef
| $shaderspecificparameter | float | shaders = VertexLitGeneric, UnlitGeneric
| I only work with specific shaders!
}}
|
Shader(s): VertexLitGeneric, UnlitGeneric
I only work with specific shaders! |
{{{value}}}
|
Default value of the parameter. | {{MatParamDef
| $defaultvalue | integer | value = 1
| Why do I have such a small value? :(
}}
|
Default Value: 1
Why do I have such a small value? :( |
See also
The above documentation is transcluded from Template:MatParamDef/doc. (Edit | Page history)
Editors can experiment in this template's sandbox (edit) and testcases (create) pages.
Editors can experiment in this template's sandbox (edit) and testcases (create) pages.
Hidden categories: