Events::remove - Revision history

Shr0x at 08:58, 23 April 2024

2024-04-23T08:58:00Z

← Older revision		Revision as of 08:58, 23 April 2024
Line 4:		Line 4:

	Removes the specified event from events tree.		Removes the specified event from events tree.
			{{JSContainer\|


	== Syntax ==		== Syntax ==
	<~~pre~~>		<syntaxhighlight lang="javascript">
	mp.events.remove("eventName"); // Removes all eventName instances		mp.events.remove("eventName"); // Removes all eventName instances
	mp.events.remove("eventName", functionInstance); // Removes specified event instance.		mp.events.remove("eventName", functionInstance); // Removes specified event instance.
Line 14:		Line 16:
	event.destroy()		event.destroy()

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

	==Example==		==Example==
	{{~~ServersideCode~~\|		{{SharedCode\|
	<syntaxhighlight lang="javascript">		<syntaxhighlight lang="javascript">
	function onPlayerDeath(player, reason, killer){		function onPlayerDeath(player, reason, killer){
Line 34:		Line 36:
	</syntaxhighlight>		</syntaxhighlight>
	}}		}}
			}}
	==See Also==		==See Also==
	{{Event_functions}}		{{Event_functions}}

Shr0x at 08:56, 23 April 2024

2024-04-23T08:56:17Z

← Older revision		Revision as of 08:56, 23 April 2024
Line 10:		Line 10:
	mp.events.remove("eventName", functionInstance); // Removes specified event instance.		mp.events.remove("eventName", functionInstance); // Removes specified event instance.
	mp.events.remove(["eventName1", "eventName2"]); // Removes all specified events instances.		mp.events.remove(["eventName1", "eventName2"]); // Removes all specified events instances.

			//alternatively you can use '.destroy' if event was created as a class (example below)
			event.destroy()

	</pre>		</pre>

	==Example==		==Example==
	{{ServersideCode\|		{{ServersideCode\|
	<~~pre~~>		<syntaxhighlight lang="javascript">
	function onPlayerDeath(player, reason, killer){		function onPlayerDeath(player, reason, killer){
	console.log(player.name + " died.");		console.log(player.name + " died.");
Line 20:		Line 24:
	}		}
	mp.events.add("playerDeath", onPlayerDeath);		mp.events.add("playerDeath", onPlayerDeath);
	</~~pre~~>
			//Using class
			const myEvent = new mp.Event("playerDeath", (player, reason, killer) => {
			console.log(`${player.name} ${killer ? `was killed by ${killer.name}` : `died`}`);
			});

			myEvent.destroy(); //destroy the event

			</syntaxhighlight>
	}}		}}

	==See Also==		==See Also==
	{{Event_functions}}		{{Event_functions}}

Unknown: Created page with "{{ServersideJsFunction}} __TOC__ Removes the specified event from events tree. == Syntax ==

 mp.events.remove("eventName"); // Removes all eventName instances mp.event..."

2019-11-11T10:31:11Z

Created page with "{{ServersideJsFunction}} __TOC__ Removes the specified event from events tree. == Syntax == <pre> mp.events.remove("eventName"); // Removes all eventName instances mp.event..."

New page

{{ServersideJsFunction}}

__TOC__

Removes the specified event from events tree.

== Syntax ==
<pre>
mp.events.remove("eventName"); // Removes all eventName instances
mp.events.remove("eventName", functionInstance); // Removes specified event instance.
mp.events.remove(["eventName1", "eventName2"]); // Removes all specified events instances.
</pre>

==Example==
{{ServersideCode|
<pre>
function onPlayerDeath(player, reason, killer){
console.log(player.name + " died.");
mp.events.remove("playerDeath", onPlayerDeath); // Once someone died, remove the event.
}
mp.events.add("playerDeath", onPlayerDeath);
</pre>
}}

==See Also==
{{Event_functions}}