Server Function Template

From RAGE Multiplayer Wiki
Revision as of 14:06, 26 October 2018 by Rootcause (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

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.

Returned Values

  • true: if the example function has been executed successfully.
  • false: otherwise.

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.

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

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

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

See Also