Shared Function Template: Difference between revisions
(Created page with "{{Shared}} This is an example description for a shared function template. == Syntax == <syntaxhighlight lang="javascript"> mp.examples.func(arg1, arg2, arg3); </syntaxhighl...") |
No edit summary |
||
| Line 13: | Line 13: | ||
* '''arg2''': Explanation of second example argument, parameter should be in <span style="color: #408DAE"><b>int</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. | * '''arg3''': Explanation of third example argument, parameter should be in <span style="color: #408DAE"><b>double</b></span> type. | ||
== Multiple Syntaxes == | |||
<syntaxhighlight lang="javascript"> | |||
// Syntax I | |||
mp.examples.func(arg1, arg2, arg3); | |||
</syntaxhighlight> | |||
<syntaxhighlight lang="javascript"> | |||
// Syntax II | |||
mp.examples.func(arg1, arg2, arg3, arg4[]); | |||
</syntaxhighlight> | |||
=== 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 === | === Returned Values === | ||
| Line 24: | Line 50: | ||
<syntaxhighlight lang="javascript"> | <syntaxhighlight lang="javascript"> | ||
//Syntax I | |||
let val = mp.examples.func("Washington", 1, 2.0); | let val = mp.examples.func("Washington", 1, 2.0); | ||
</syntaxhighlight> | |||
<syntaxhighlight lang="javascript"> | |||
//Syntax II | |||
let val = mp.examples.func("Washington", 1, 2.0, ['foo', 'bar']); | |||
</syntaxhighlight> | </syntaxhighlight> | ||
Revision as of 23:26, 4 February 2018
Shared
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 string type.
- arg2: Explanation of second example argument, parameter should be in int type.
- arg3: Explanation of third example argument, parameter should be in double type.
Multiple Syntaxes
// Syntax I
mp.examples.func(arg1, arg2, arg3);
// Syntax II
mp.examples.func(arg1, arg2, arg3, arg4[]);
Syntax I Parameters
- arg1: Explanation of example argument, parameter should be in string type.
- arg2: Explanation of second example argument, parameter should be in int type.
- arg3: Explanation of third example argument, parameter should be in double type.
Syntax II Parameters
- arg1: Explanation of example argument, parameter should be in string type.
- arg2: Explanation of second example argument, parameter should be in int type.
- arg3: Explanation of third example argument, parameter should be in double type.
- arg4: Explanation of fourth example argument, parameter should be in array type.
Returned Values
- true: if the example function has been executed successfully.
- false: 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);
//Syntax II
let val = mp.examples.func("Washington", 1, 2.0, ['foo', 'bar']);