Template:MatParamDef

Template Documentation [view] [edit]

 Available doc translations

…

Subpages

Strings

Sandbox

Testcase

 English

 中文

This 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 {{=}}, but this may overload the page. 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 }}	$stupidequalsign <boolean> 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 }}	$describedcutie <texture>
{{{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! }}	I'm deprecated <boolean>  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! }}	$likealienswarm <boolean> (in all games since ) 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! }}	$likealienswarm <boolean> (in all games since ) (also in ) 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! }}	$lovealienswarm <integer> (only in ) 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! }}	$dxparameter <integer> (removed since ) 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! }}	$dx9parameter <boolean> (DX9 SM2) 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! }}	$dx8parameter <boolean> (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... }}	$basetexture1 to $basetexture4 <texture> 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. }}	$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! }}	$shaderspecificparameter <float> Shader: 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? :( }}	$defaultvalue <integer> Default Value: 1 Why do I have such a small value? :(

See also

• {{matparam}}
• {{KV}}
• {{I}}
• {{O}}

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.