Template:MatProxyCell/doc

From Valve Developer Community
Jump to navigation Jump to search
Edit-copy.png
This is a documentation subpage for Template:MatProxyCell.
Don't forget to purge the contents of the base page upon creating or editing this subpage.

Usage

This template is designed to be used for List of material proxies. It is a text block with a headline. Multiple of these will display next to each other, filling row by row.

One can link to a block like a section using the {{material proxy}} template with the {{{title}}} as first parameter, e. g. {{material proxy|LessOrEqual}}LessOrEqual.


Parameters

  • {{{title}}} – The proxy name;
  • {{{desc}}} – The proxy description;
  • {{{arguments}}} – The proxy arguments that can or must be provided. Use two types of lines: ; <code>argument name</code> for argument names and : argument description for descriptions.

Examples

Wikitext Result
{{MatProxyCell|title={{param|title}}|desc={{param|desc}}|arguments=
{{param|arguments}}
}}

<div id="{{{title}}}" style="display:grid; vertical-align: top; padding:.5em; margin:.5em; background: rgba(255,255,255,0.03);"> {{{title}}} {{{desc}}} {{{arguments}}}

{{MatProxyCell|title=LessOrEqual|desc=Compares the first value to the second.|arguments=
; <code>lessEqualVar</code>
: If <code>srcVar1 <= srcVar2</code> then the value of this variable is copied into <code>resultVar</code>
; <code>greaterVar</code>
: If <code>srcVar1 > srcVar2</code> then the value of this variable is copied into <code>resultVar</code>
; <code>srcVar1</code>
; <code>srcVar2</code>
; <code>resultVar</code>
}}

LessOrEqual Compares the first value to the second.

lessEqualVar
If srcVar1 <= srcVar2 then the value of this variable is copied into resultVar
greaterVar
If srcVar1 > srcVar2 then the value of this variable is copied into resultVar
srcVar1
srcVar2
resultVar