Events::call: Difference between revisions

From RAGE Multiplayer Wiki
No edit summary
 
(8 intermediate revisions by 5 users not shown)
Line 1: Line 1:
This function calls registered event handlers.
This function calls registered event handlers. This function can call serverside events from serverside and clientside events from clientside.


<br>{{SharedFunction}}
{{CSharpContainer|
<pre>
RAGE.Events.CallLocal(string eventName, params object[] args);
</pre>
}}
{{JSContainer|
<b>Note: (1.1)</b><br>
If you're sending number more than 2^31 to client, you need to arg.toString() transform your number on server and parseInt(arg) on client.
==Syntax==
==Syntax==
<syntaxhighlight lang="javascript">
<pre>
//CLIENTSIDE
events.call(eventName, ...args);
events.call(eventName, ...args);
//SERVERSIDE
</pre>
events.call(eventName, ...args);
</syntaxhighlight>


Calling from serverside to clientside requires args to be enclosed in []. Calling serverside to serverside, clientside to serverside, or clientside to clientside does not require this.
=== Parameters ===
*'''eventName''': {{RageType|String}}
*'''args''': Any


==Example==
==Example==
<syntaxhighlight lang="javascript">
Creates an event called 'anyCallbackName' and then calls that event which will then output "yea" to the console.
mp.events.add(
{{ServersideCode|
{
<pre>
    "anyCallbackName" : anything =>
mp.events.add("anyCallbackName", (anything) => {
     {
     console.log(anything);
        console.log(anything);
    }
});
});


mp.events.call("anyCallbackName", "yea");
mp.events.call("anyCallbackName", "yea");
</syntaxhighlight>
</pre>
 
}}
}}
==See Also==
==See Also==
{{Event_functions}}
{{Event_functions}}
[[Category:Shared API]]
[[Category:Shared Function]]

Latest revision as of 08:18, 26 December 2022

This function calls registered event handlers. This function can call serverside events from serverside and clientside events from clientside.


Shared
Function

 C#  JavaScript



C# Syntax

RAGE.Events.CallLocal(string eventName, params object[] args);


JavaScript Syntax

Note: (1.1)
If you're sending number more than 2^31 to client, you need to arg.toString() transform your number on server and parseInt(arg) on client.

Syntax

events.call(eventName, ...args);

Parameters

  • eventName: String
  • args: Any

Example

Creates an event called 'anyCallbackName' and then calls that event which will then output "yea" to the console.

Server-Side
mp.events.add("anyCallbackName", (anything) => {
    console.log(anything);
});

mp.events.call("anyCallbackName", "yea");


See Also