Client Function Template

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

This is an example description for a client-side function template.

Syntax

example.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
example.func(arg1, arg2, arg3);
//Syntax II
example.func(arg1, arg2, arg3, arg4[]);

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.

Client-Side
//Syntax I
let val = example.func("Washington", 1, 2.0);


Client-Side
//Syntax II
let val = example.func("Washington", 1, 2.0, ['foo', 'bar']);

See Also