Events::call: Difference between revisions

From RAGE Multiplayer Wiki
m (Added more description)
mNo edit summary
Line 1: Line 1:
__NOTOC__
{{SharedJsFunction}}
This function calls registered event handlers. This function can call serverside events from serverside and clientside events from clientside.
This function calls registered event handlers. This function can call serverside events from serverside and clientside events from clientside.


{{JSContainer|
==Syntax==
==Syntax==
<pre>
<pre>
events.call(eventName, ...args);
events.call(eventName, ...args);
</pre>
</pre>
=== Parameters ===
*'''eventName''': {{RageType|String}}
*'''args''': Any


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


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

Revision as of 06:15, 22 April 2020

Shared
Function

 JavaScript


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

JavaScript Syntax

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