Events::callRemote: Difference between revisions

From RAGE Multiplayer Wiki
m (Replaced HTML with template)
(Updated page)
Line 1: Line 1:
__NOTOC__
{{ClientsideJsFunction}}
This function is used to call a server-side event from a client-side script.


This function is used to call a server-side event from a client-side script.
'''NOTE''': If you're calling a server-side event, the first parameter of that server-side event will be your player object that gets sent automatically.


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


==Example==  
==Example==  
Line 12: Line 20:
{{ClientsideCode|
{{ClientsideCode|
<pre>
<pre>
let checkResolution = () => {
mp.events.add("playerReady", () => {
let res = mp.game.graphics.getScreenActiveResolution(x, y);
    let res = mp.game.graphics.getScreenActiveResolution(x, y);
if (!((res.x == 1280) && (res.y == 1024))) {
    if (!((res.x == 1280) && (res.y == 1024))) {
mp.events.callRemote("kickMeImBad", res.x, res.y);
        mp.events.callRemote("kickMeImBad", res.x, res.y);
};
    };
};
});
 
checkResolution();
</pre>
</pre>
}}
}}
Line 27: Line 33:
{{ServersideCode|
{{ServersideCode|
<pre>
<pre>
let blahBlah = (player, sx, sy) => {
mp.events.add("kickMeImBad", (player, sx, sy) => {
console.log(`${player.name} bad boy :c, his screen size ${sx}x${sy}`);
    console.log(`${player.name} bad boy :c, his screen size ${sx}x${sy}`);
player.kick();
player.kick();
};
});
 
mp.events.add("kickMeImBad", blahBlah);
</pre>
</pre>
}}
}}
 
}}
==See Also==
==See Also==
{{Event_functions}}
{{Event_functions}}

Revision as of 03:21, 24 April 2021

Client-Side
Function

 JavaScript



This function is used to call a server-side event from a client-side script.

NOTE: If you're calling a server-side event, the first parameter of that server-side event will be your player object that gets sent automatically.

JavaScript Syntax

Syntax

mp.events.callRemote(String eventName [, ...args])

Parameters

  • eventName: String
  • args: Any

Example

This example will call the server-side event, from the client-side script, to see if the player screen size is not 1280x1024.

Client-Side
mp.events.add("playerReady", () => {
    let res = mp.game.graphics.getScreenActiveResolution(x, y);
	
    if (!((res.x == 1280) && (res.y == 1024))) {
        mp.events.callRemote("kickMeImBad", res.x, res.y);
    };
});


Server-Side
mp.events.add("kickMeImBad", (player, sx, sy) => {
    console.log(`${player.name} bad boy :c, his screen size ${sx}x${sy}`);
	player.kick();
});


See Also