Events::addProc: Difference between revisions

From RAGE Multiplayer Wiki
No edit summary
No edit summary
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Shared}}
This function register the specified player's Remote Prodecure Call (RPC) event and expects a callback.
mp.events.addProc register a RPC event into server-side/client-side.


<br>{{SharedFunction}}
{{CSharpContainer|
<pre>
RAGE.Events.AddProc(string eventName, RAGE.Events.CallDelegate handler, [async = false]);
</pre>
}}
{{JSContainer|
== Syntax ==
== Syntax ==
<pre>
<pre>
mp.events.addProc(name[, args], callback);
mp.events.addProc('eventProcName', callback);
</pre>
</pre>
=== Required Arguments ===
*{{Required}}'''eventProcName''': {{RageType|String}}
*{{Required}}'''callback''': {{RageType|Any}}


== Examples ==
== Examples ==
Line 12: Line 23:
{{ServersideCode|
{{ServersideCode|
<pre>
<pre>
// register RPC 'test_proc' in server-side
mp.events.addProc('test_proc', (player, text) => {
mp.events.addProc('test_proc', (player, text) => {
   return 'hey beast: ' + text;
   return 'hey beast: ' + text;
Line 21: Line 33:
<pre>
<pre>
const response = await mp.events.callRemoteProc('test_proc', 'test');
const response = await mp.events.callRemoteProc('test_proc', 'test');
// calls RPC 'test_proc' from server side and wait for result
mp.gui.chat.push(`response: ${response}`);
mp.gui.chat.push(`response: ${response}`);
</pre>
</pre>
}}
}}
}}

Latest revision as of 08:17, 26 December 2022

This function register the specified player's Remote Prodecure Call (RPC) event and expects a callback.


Shared
Function

 C#  JavaScript



C# Syntax

RAGE.Events.AddProc(string eventName, RAGE.Events.CallDelegate handler, [async = false]);


JavaScript Syntax

Syntax

mp.events.addProc('eventProcName', callback);

Required Arguments

  • *eventProcName: String
  • *callback: Any

Examples

Server-Side
// register RPC 'test_proc' in server-side
mp.events.addProc('test_proc', (player, text) => {
  return 'hey beast: ' + text;
});


Client-Side
const response = await mp.events.callRemoteProc('test_proc', 'test');
// calls RPC 'test_proc' from server side and wait for result
mp.gui.chat.push(`response: ${response}`);