Skip to main content

Shared Function Template

This is an example description for a shared function template.

Syntax​

``` mp.examples.func(arg1, arg2, arg3); ```

Parameters​

  • arg1: Explanation of example argument, parameter should be in <span style="color: #408DAE"><b>string</b></span> type.
  • arg2: Explanation of second example argument, parameter should be in <span style="color: #408DAE"><b>int</b></span> type.
  • arg3: Explanation of third example argument, parameter should be in <span style="color: #408DAE"><b>double</b></span> type.

Returned Values​

  • <span style="color: #408DAE"><b>true</b></span>: if the example function has been executed successfully.
  • <span style="color: #408DAE"><b>false</b></span>: otherwise.

Multiple Syntaxes​

Syntax I Parameters​

  • arg1: Explanation of example argument, parameter should be in <span style="color: #408DAE"><b>string</b></span> type.
  • arg2: Explanation of second example argument, parameter should be in <span style="color: #408DAE"><b>int</b></span> type.
  • arg3: Explanation of third example argument, parameter should be in <span style="color: #408DAE"><b>double</b></span> type.

Syntax II Parameters​

  • arg1: Explanation of example argument, parameter should be in <span style="color: #408DAE"><b>string</b></span> type.
  • arg2: Explanation of second example argument, parameter should be in <span style="color: #408DAE"><b>int</b></span> type.
  • arg3: Explanation of third example argument, parameter should be in <span style="color: #408DAE"><b>double</b></span> type.
  • arg4: Explanation of fourth example argument, parameter should be in <span style="color: #408DAE"><b>array</b></span> type.

Returned Values​

  • <span style="color: #408DAE"><b>true</b></span>: if the example function has been executed successfully.
  • <span style="color: #408DAE"><b>false</b></span>: otherwise.

Examples​

This is a basic explanation about what does the example below do.

``` //Syntax I let val = mp.examples.func("Washington", 1, 2.0); ```

This is a basic explanation about what does the example below does using 2nd syntax.

``` //Syntax II let val = mp.examples.func("Washington", 1, 2.0, ['foo', 'bar']); ```

See Also​

  • Example Stuff