View source for Template:MatParam/doc

{{Doc/subpage}}
<!-- Please place categories where indicated at the bottom of this page. -->
This template is used to generate [[material]] [[shader]] parameter definitions on material shader pages.

== Usage ==
{{Code|<nowiki>{{MatParam|<name>|<variable type>|<description>}}</nowiki>}}

== Examples and Parameters == 
{| class="standard-table"
! Parameter
! Description
! Example
! Preview
|-
| align="center" | {{Param|text}}
| 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 {{tl|&#61;}}, but this may overload the page.
| {{CodeBlock|margin=5px|<nowiki>{{MatParam
| $stupidequalsign | bool
| text = Wow, I've been fixed! Look at this {{Emoji|point_right}} 2 + 2 = 5
}}</nowiki>}}
| {{MatParam|$stupidequalsign|bool|text=Wow, I've been fixed! Look at this {{Emoji|point_right}} 2 + 2 = 5}}
|-
| align="center" | {{Param|deprecated}}
| This material parameter is deprecated and should no longer be used.
| {{CodeBlock|margin=5px|<nowiki>{{MatParam
| I'm deprecated | bool | deprecated = 1
| Really, don't use me anymore!
}}</nowiki>}}
| {{MatParam|I'm deprecated|bool|deprecated=1|Really, don't use me anymore!}}
|-
| align="center" | {{Param|since}}
| This material parameter is available since this game. Uses the template {{tl|Since}}.
| {{CodeBlock|margin=5px|<nowiki>{{MatParam
| $likealienswarm | bool | since = {{as}}
| I'm available in Portal 2, too!
}}</nowiki>}}
| {{MatParam|$likealienswarm|bool|since={{as}}|I'm available in Portal 2, too!}}
|-
| align="center" | {{Param|also}}
| This material parameter is also available in this game. Uses the template {{tl|Also}}.
| {{CodeBlock|margin=5px|<nowiki>{{MatParam
| $likealienswarm | bool | since = {{as}} | also = {{GMOD}}
| I'm also available in Garry's Mod!
}}</nowiki>}}
| {{MatParam|$likealienswarm|bool|since={{as}}|also={{GMOD}}|I'm also available in Garry's Mod!}}
|-
| align="center" | {{Param|only}}
| This material parameter is available only in this/these game(s). Uses the template {{tl|Only}}.
| {{CodeBlock|margin=5px|<nowiki>{{MatParam
| $lovealienswarm | integer | only = {{as}}
| I'm only available in Alien Swarm!
}}</nowiki>}}
| {{MatParam|$lovealienswarm|integer|only={{as}}|I'm only available in Alien Swarm!}}
|-
| align="center" | {{Param|removed}}
| This material parameter was removed in this game. Uses the template {{tl|Removed}}.
| {{CodeBlock|margin=5px|<nowiki>{{MatParam
| $dxparameter | int | removed = {{l4d}}
| I was removed in Left 4 Dead!
}}</nowiki>}}
| {{MatParam|$dxparameter|integer|I was removed in Left 4 Dead!|removed={{l4d}}}}
|-
| align="center" | {{Param|dx9}}
| This material parameter requires DX9 or higher to function.
| {{CodeBlock|margin=5px|<nowiki>{{MatParam
| $dx9parameter | bool | dx9 = 1
| I require DX9 to work!
}}</nowiki>}}
| {{MatParam|$dx9parameter|bool|I require DX9 to work!|dx9=1}}
|-
| align="center" | {{Param|dx8}}
| This material parameter is for DX8, and should not be used for DX9.
| {{CodeBlock|margin=5px|<nowiki>{{MatParam
| $dx8parameter | bool | dx8 = 1
| I'm a material parameter for DX8!
}}</nowiki>}}
| {{MatParam|$dx8parameter|bool|I'm a material parameter for DX8!|dx8=1}}
|-
| align="center" | {{Param|to}}
| Use this to define a set of material parameters with very similar names.
| {{CodeBlock|margin=5px|<nowiki>{{MatParam
| $basetexture1 | to = $basetexture4 | texture
| There are many of us...
}}</nowiki>}}
| {{MatParam|$basetexture1|to=$basetexture4|texture|There are many of us...}}
|-
| align="center" | {{Param|and}}
| Use this to define two material parameters with very similar names.
| {{CodeBlock|margin=5px|<nowiki>{{MatParam
| $bumpmap | and = $bumpmap2 | texture
| This shader supports two bump maps.
}}</nowiki>}}
| {{MatParam|$bumpmap|and=$bumpmap2|texture|This shader supports two bump maps.}}
|-
| align="center" | {{Param|shaders}}
| Lists the shaders for a specific material parameter. Uses the template {{tl|Shaders}}.
| {{CodeBlock|margin=5px|<nowiki>{{MatParam
| $shaderspecificparameter | float
| shaders = VertexLitGeneric, UnlitGeneric
| I only work with specific shaders!
}}</nowiki>}}
| {{MatParam|$shaderspecificparameter|float|shaders=VertexLitGeneric, UnlitGeneric|I only work with specific shaders!}}
|-
| align="center" | {{Param|value}}
| Default value of the parameter.
| {{CodeBlock|margin=5px|<nowiki>{{MatParam
| $defaultvalue | integer | value = 1
| Why do I have such a small value? :(
}}</nowiki>}}
| {{MatParam|$defaultvalue|integer|value=1|Why do I have such a small value? :(}}
|}

== See Also ==
* [[Template:KV]]
* [[Template:IO]]

{{Doc/Sandbox other| [[Category:Formatting templates]] }}