Template:MatParamDef/doc

From Valve Developer Community
< Template:MatParamDef
Revision as of 19:03, 22 April 2020 by Deprecated (talk | contribs) (Updated documentation to reflect changes)
Jump to navigation Jump to search
Edit-copy.png
This is a documentation subpage for Template:MatParamDef.
Don't forget to purge the contents of the base page upon creating or editing this subpage.

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

Usage

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

Note.pngNote:Don't forget to use Template:= to escape any "=" characters in the text.

Examples and Parameters

Parameter Description Example Preview
deprecated This material parameter is deprecated and should no longer be used. {{MatParam|I'm deprecated|bool|Really, don't use me anymore!|deprecated=1}} I'm deprecated
since This material parameter is available since this game. Uses the template {{Since}}. {{MatParam|$likealienswarm|bool|I'm available in Portal 2, too!|since={{as}}}} $likealienswarm
also This material parameter is also available in this game. Uses the template {{Also}}. {{MatParam|$likealienswarm|bool|I'm also available in Garry's Mod!|since={{as}}|also={{GMOD}}}} $likealienswarm
only This material parameter is available only in this/these game(s). Uses the template {{Only}}. {{MatParam|$lovealienswarm|integer|I'm only available in Alien Swarm!|only={{as}}}} $lovealienswarm
removed This material parameter was removed in this game. Uses the template {{Removed}}. {{MatParam|$dxparameter|int|I was removed in Left 4 Dead!|removed={{l4d}}}} $dxparameter
dx9 This material parameter requires DX9 or higher to function. {{MatParam|$dx9parameter|bool|I require DX9 to work!|dx9=1}} $dx9parameter
dx8 This material parameter is for DX8, and should not be used for DX9. {{MatParam|$dx8parameter|bool|I'm a material parameter for DX8!|dx8=1}} $dx8parameter
to Use this to define a set of material parameters with very similar names. {{MatParam|$basetexture1|to=$basetexture4|texture|There are many of us...}} $basetexture1
and Use this to define two material parameters with very similar names. {{MatParam|$bumpmap|and=$bumpmap2|texture|This shader supports two bump maps.}} $bumpmap
shaders Lists the shaders for a specific material parameter. Uses the template {{Shaders}}. {{MatParam|$shaderspecificparameter|float|I only work with specific shaders!|shaders=LightmappedGeneric, WorldVertexTransition}} $shaderspecificparameter

See also