Getting Started with Events - Revision history

Shr0x at 00:42, 7 April 2026

2026-04-07T00:42:32Z

KirillZver: /* Registering an event */

2020-12-20T14:48:39Z

Registering an event

← Older revision		Revision as of 14:48, 20 December 2020
Line 51:		Line 51:

	In '''CEF''' you're not allowed to register any events. You can only call the functions that are registered in your '''CEF'''.		In '''CEF''' you're not allowed to register any events. You can only call the functions that are registered in your '''CEF'''.

	In 1.1 version:		In 1.1 version:

	Added: CEF: mp.events.add(string eventName, function handler)		Added: CEF: mp.events.add(string eventName, function handler)

	Added: CEF: mp.events.reset()		Added: CEF: mp.events.reset()

	Added: CEF: mp.events.remove(string eventName)		Added: CEF: mp.events.remove(string eventName)

	Added: CEF: mp.events.call(string eventName) (псевдоним к mp.trigger)		Added: CEF: mp.events.call(string eventName) (псевдоним к mp.trigger)

	Added: Client-side: Browser.call(eventName, arguments...)		Added: Client-side: Browser.call(eventName, arguments...)

KirillZver: /* Registering an event */

2020-12-20T14:48:03Z

Registering an event

← Older revision		Revision as of 14:48, 20 December 2020
Line 51:		Line 51:

	In '''CEF''' you're not allowed to register any events. You can only call the functions that are registered in your '''CEF'''.		In '''CEF''' you're not allowed to register any events. You can only call the functions that are registered in your '''CEF'''.
			In 1.1 version:
			Added: CEF: mp.events.add(string eventName, function handler)
			Added: CEF: mp.events.reset()
			Added: CEF: mp.events.remove(string eventName)
			Added: CEF: mp.events.call(string eventName) (псевдоним к mp.trigger)
			Added: Client-side: Browser.call(eventName, arguments...)

	== Calling methods ==		== Calling methods ==

Almeidowski at 16:45, 31 August 2020

2020-08-31T16:45:07Z

← Older revision		Revision as of 16:45, 31 August 2020
Line 56:		Line 56:
	It is pretty important to know how to call your events on each side, or you'll be totally lost in your development. We made it easier for you with the following calling methods, so you can know how the events calling system is working.		It is pretty important to know how to call your events on each side, or you'll be totally lost in your development. We made it easier for you with the following calling methods, so you can know how the events calling system is working.
	{{JSContainer\|		{{JSContainer\|
			===Calling server-side or client-side local events===
			====Syntax====
	<pre>		<pre>

	~~// calls server-side local events / calls client-side local events~~
	mp.events.call('eventName', args);		mp.events.call('eventName', args);
			</pre>
	/*		===Calling client-side events from server-side (the server-side calls client-side)===
	* Calls client-side ~~event~~ from server-side.		Notice: arguments must be inside an array.
	* Notice: arguments must be inside an array.		====Make a player call their client-side====
	*/		=====Syntax=====
			<pre>
	player.call('eventName', [arg1, arg2]);		player.call('eventName', [arg1, arg2]);
			</pre>
	/*		=====Examples=====
	* Makes server's all players call their client-side.		======Example 1======
	* Notice: arguments must be inside an array.		With this example we'll add a server-side command that calls a client-side event that starts a screen effect on the player who types the command.
	*/		As show below, once a player types /effect [effect] (for example, /effect ChopVision) it will send whatever the player typed on the first argument to the event created on the client-side ('startEffectEvent').
			{{ServersideCode\|
			<pre>
			mp.events.addCommand('effect', (player, fullText, effect) => {
			player.call('startEffectEvent', [effect]);
			});
			</pre>
			}}
			On the client-side, it will received whatever the player typed on the first argument and replace it on the effect.
			{{ClientsideCode\|
			<pre>
			mp.events.add('startEffectEvent', (effect) => {
			mp.game.graphics.startScreenEffect(effect, 10000, false);
			});
			</pre>
			}}
			====Make all players in the server call their client-side====
			=====Syntax=====
			<pre>
	mp.players.call('eventName', [arg1, arg2]);		mp.players.call('eventName', [arg1, arg2]);
			</pre>
	/*		====Make server-side call a filtered player's client-side====
	* Makes server-side call filtered player's client-side.		The example below filters a player with the name '''WeirdNewbie''' to call his client-side.
	* For example ~~this~~ filters player with name '''WeirdNewbie''' to call his client-side.		=====Syntax=====
	* Notice: arguments must be inside an array.		<pre>
	*/
	mp.players.call(mp.players.toArray().filter((_player) => _player.name == 'WeirdNewbie'), 'eventName', [args]);		mp.players.call(mp.players.toArray().filter((_player) => _player.name == 'WeirdNewbie'), 'eventName', [args]);
			</pre>
	~~// Makes~~ client-side ~~call~~ server-side ~~event~~		===Calling server-side events from client-side (the client-side calls server-side)===
			====Syntax====
			<pre>
	mp.events.callRemote('eventName', args);		mp.events.callRemote('eventName', args);
			</pre>
	~~// Makes client-side call~~ a function registered in CEF		===Calling a function registered in CEF from client-side (the client-side calls CEF)===
	~~browser~~.execute(´javascriptFunction('${variable1}','${variable2}');´);		====Syntax====
			<pre>
	/*		mbrowser.execute(´javascriptFunction('${variable1}','${variable2}');´);
	* Makes CEF call a event in client-side.		</pre>
	* Notice: You can't communicate between CEF and server-side		===Calling a client-side event from CEF (the CEF calls client-side)===
	*/		Notice: You can't communicate between CEF and server-side
			====Syntax====
			<pre>
	mp.trigger('eventName', args);		mp.trigger('eventName', args);

	</pre>		</pre>
	}}		}}

YnnhoJ at 17:33, 12 December 2019

2019-12-12T17:33:46Z

← Older revision		Revision as of 17:33, 12 December 2019
Line 55:		Line 55:

	It is pretty important to know how to call your events on each side, or you'll be totally lost in your development. We made it easier for you with the following calling methods, so you can know how the events calling system is working.		It is pretty important to know how to call your events on each side, or you'll be totally lost in your development. We made it easier for you with the following calling methods, so you can know how the events calling system is working.
			{{JSContainer\|
	<pre>		<pre>

Line 93:		Line 93:

	</pre>		</pre>
			}}

	== Cancelling events ==		== Cancelling events ==

Unknown at 10:56, 6 December 2019

2019-12-06T10:56:09Z

← Older revision		Revision as of 10:56, 6 December 2019
Line 143:		Line 143:
	</pre>		</pre>
	}}		}}

			== See also ==
			{{ScriptingTutorials}}

	[[Category:Tutorials]]		[[Category:Tutorials]]

Unknown at 10:19, 6 December 2019

2019-12-06T10:19:44Z

← Older revision		Revision as of 10:19, 6 December 2019
Line 143:		Line 143:
	</pre>		</pre>
	}}		}}

			[[Category:Tutorials]]

Unknown at 10:19, 6 December 2019

2019-12-06T10:19:20Z

← Older revision		Revision as of 10:19, 6 December 2019
Line 32:		Line 32:
	if your event will be for server-side use only then you can register it the way you want.		if your event will be for server-side use only then you can register it the way you want.

	~~<div class="header" style="background-color: #408DAE; color: #FFFFFF; border: 2px solid #408DAE;">~~		{{ServersideCode\|
	~~<div style="margin: 10px 10px 10px 10px;"><b>Server-Side</b></div>~~
	<pre>		<pre>
	mp.events.add('eventName', (arg1, arg2, etc.) => {		mp.events.add('eventName', (arg1, arg2, etc.) => {
Line 39:		Line 38:
	});		});
	</pre>		</pre>
	~~</div>~~		}}

	if your event will be called from client-side and you registered it in server-side. You have to add '''player''' argument as a main first argument because client-side delivers the localPlayer with your data, so you can know which player is it.		if your event will be called from client-side and you registered it in server-side. You have to add '''player''' argument as a main first argument because client-side delivers the localPlayer with your data, so you can know which player is it.

	~~<div class="header" style="background-color: #408DAE; color: #FFFFFF; border: 2px solid #408DAE;">~~		{{ServersideCode\|
	~~<div style="margin: 10px 10px 10px 10px;"><b>Server-Side</b></div>~~
	<pre>		<pre>
	mp.events.add('eventName', (player, arg1, arg2, etc.) => {		mp.events.add('eventName', (player, arg1, arg2, etc.) => {
Line 50:		Line 48:
	});		});
	</pre>		</pre>
	~~</div>~~		}}

	In '''CEF''' you're not allowed to register any events. You can only call the functions that are registered in your '''CEF'''.		In '''CEF''' you're not allowed to register any events. You can only call the functions that are registered in your '''CEF'''.
Line 58:		Line 56:
	It is pretty important to know how to call your events on each side, or you'll be totally lost in your development. We made it easier for you with the following calling methods, so you can know how the events calling system is working.		It is pretty important to know how to call your events on each side, or you'll be totally lost in your development. We made it easier for you with the following calling methods, so you can know how the events calling system is working.

	<~~syntaxhighlight lang="javascript"~~>		<pre>

	// calls server-side local events / calls client-side local events		// calls server-side local events / calls client-side local events
Line 94:		Line 92:
	mp.trigger('eventName', args);		mp.trigger('eventName', args);

	</~~syntaxhighlight~~>		</pre>

	== Cancelling events ==		== Cancelling events ==
Line 107:		Line 105:
	A small example of how to use it:		A small example of how to use it:

	<~~syntaxhighlight lang="javascript"~~>		{{ServersideCode\|
			<pre>
	let ev = new mp.Event("playerDeath", (player, reason, killer) =>		let ev = new mp.Event("playerDeath", (player, reason, killer) =>
	{		{
Line 116:		Line 114:
	// ev.enable(); due to this line the event will be re-enabled.		// ev.enable(); due to this line the event will be re-enabled.
	// ev.destroy(); due to this line the event is never going to be executed if we call this before it		// ev.destroy(); due to this line the event is never going to be executed if we call this before it
	</~~syntaxhighlight~~>		</pre>
			}}

	=== Removing ===		=== Removing ===
Line 122:		Line 121:
	Here are all the methods to remove events:		Here are all the methods to remove events:

	<~~syntaxhighlight lang="javascript"~~>		{{SharedCode\|
			<pre>
	// Remove specified handler of specified event		// Remove specified handler of specified event
	function playerJoinHandler(player)		function playerJoinHandler(player)
Line 142:		Line 141:
	// Get all handlers of specified event		// Get all handlers of specified event
	mp.events.getAllOf("playerJoin").forEach(_ev => _ev(null));		mp.events.getAllOf("playerJoin").forEach(_ev => _ev(null));
			</pre>
	</~~syntaxhighlight~~>		}}

Wingear: /* Calling methods */

2019-03-22T15:13:51Z

Calling methods

← Older revision		Revision as of 15:13, 22 March 2019
Line 89:		Line 89:

	/*		/*
	*Makes CEF call a event in client-side		* Makes CEF call a event in client-side.
	*Notice: You can't communicate between CEF and server-side		* Notice: You can't communicate between CEF and server-side
	*/		*/
	mp.trigger('eventName', args);		mp.trigger('eventName', args);

Unknown: /* Removing */

2018-10-11T20:36:59Z

Removing

← Older revision		Revision as of 20:36, 11 October 2018
Line 143:		Line 143:
	mp.events.getAllOf("playerJoin").forEach(_ev => _ev(null));		mp.events.getAllOf("playerJoin").forEach(_ev => _ev(null));

	<syntaxhighlight ~~lang="javascript"~~>		</syntaxhighlight>