====== mul ======

===== Description =====

Multiply one number by another.

===== Function prototype =====

<code>
variant mul <variant:arg1> <variant:arg2>
</code>

===== Arguments =====

^  Name  ^  Type  ^ Comment ^
|  //arg1//  |  variant  | The first number to be multiplied. |
|  //arg2//  |  variant  | The second number to be multiplied. |

<note important>
If the type of //arg1// is not equal to that of //arg2//, the ordering of the arguments may change the result of calls to ''mul''. See comments for [[plugins:general:zeoscript:reference:functions:add]].
</note>

===== Return value =====

The value of //arg1// multiplied by //arg2//, in the data type of //arg1//.


===== Example =====

<code>
echo <zs:mul 2 5>
</code>

... the output of which is written to the event log by [[plugins:general:zeoscript:reference:functions:echo]] as:

<file>
10
</file>

===== Comments =====

None.

===== See also =====


  * [[plugins:general:zeoscript:reference:functions:add]]
  * [[plugins:general:zeoscript:reference:functions:sub]]
  * [[plugins:general:zeoscript:reference:functions:div]]
  * [[plugins:general:zeoscript:reference:functions:mod]]