Server Function Template: Difference between revisions

From RAGE Multiplayer Wiki
No edit summary
Line 16: Line 16:
== Multiple Syntaxes ==
== Multiple Syntaxes ==


* Syntax I
'''Syntax I:'''
 
<syntaxhighlight lang="javascript">
<syntaxhighlight lang="javascript">
mp.examples.func(arg1, arg2, arg3);
mp.examples.func(arg1, arg2, arg3);
</syntaxhighlight>
</syntaxhighlight>


* Syntax II
'''Syntax II:'''
 
<syntaxhighlight lang="javascript">
<syntaxhighlight lang="javascript">
mp.examples.func(arg1, arg2, arg3, arg4[]);
mp.examples.func(arg1, arg2, arg3, arg4[]);

Revision as of 23:22, 4 February 2018

Server-Side

This is an example description for a server-side 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.

let val = mp.examples.func("George", 1, 2.0);

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

let val = mp.examples.func("George", 1, 2.0, ['foo', 'bar']);

See Also