Template:MatParam

From Valve Developer Community
Jump to: navigation, search
English (en)
English (en)Deutsch (de)Esperanto (eo)Español (es)Français (fr)Suomi (fi)Hrvatski (hr)Magyar (hu)Italiano (it)日本語 (ja)한국어 (ko)Nederlands (nl)Polski (pl)Português (pt)Português do Brasil (pt-br)Русский (ru)Slovenčina (sk)Svenska (sv)Türkçe (tr)Українська (uk)Tiếng Việt (vi)中文 (zh)中文(台灣)‎ (zh-tw)
Icon-translate.png Available doc translations
View
Page history

This template is used to generate material shader parameter definitions on material shader pages.

Usage

{{MatParam|<name>|<variable type>|<description>}}

Examples and Parameters

Parameter Description Example Preview
{{{text}}}
{{{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 {{=}}, but this may overload the page.

{{MatParam | $stupidequalsign | bool | text = Wow, I've been fixed! Look at this {{Emoji|point_right}} 2 + 2 = 5 }}
{{MatParam | $stupidequalsign | bool | 3 = Wow, I've been fixed! Look at this {{Emoji|point_right}} 2 + 2 = 5 }}
Wow, I've been fixed! Look at this {{Emoji|point_right}} 2 + 2 = 5
{{{deprecated}}} This material parameter is deprecated and should no longer be used.
{{MatParam | 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}}.
{{MatParam | $likealienswarm | bool | since = {{as}} | I'm available in Portal 2, too! }}
$likealienswarm <boolean> (in all games since Alien Swarm)
I'm available in Portal 2, too!
{{{also}}} This material parameter is also available in this game. Uses the template {{Also}}.
{{MatParam | $likealienswarm | bool | since = {{as}} | also = {{GMOD}} | I'm also available in Garry's Mod! }}
$likealienswarm <boolean> (in all games since Alien Swarm) (also 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}}.
{{MatParam | $lovealienswarm | integer | only = {{as}} | I'm only available in Alien Swarm! }}
$lovealienswarm <integer> (only in Alien Swarm)
I'm only available in Alien Swarm!
{{{removed}}} This material parameter was removed in this game. Uses the template {{Removed}}.
{{MatParam | $dxparameter | int | removed = {{l4d}} | I was removed in Left 4 Dead! }}
$dxparameter <integer> (removed since Left 4 Dead)
I was removed in Left 4 Dead!
{{{dx9}}} This material parameter requires DX9 or higher to function.
{{MatParam | $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.
{{MatParam | $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.
{{MatParam | $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.
{{MatParam | $bumpmap | and = $bumpmap2 | texture | This shader supports two bump maps. }}
This shader supports two bump maps.
{{{shaders}}} Lists the shaders for a specific material parameter. Uses the template {{Shaders}}.
{{MatParam | $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.
{{MatParam | $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