OnElementDestroy: Difference between revisions

Revision as of 20:28, 19 November 2022

Event Server and Client Online and Offline Cancellable

Available since Server 1.0.0, Client 1.0.0

onElementDestroy(Event event, Element element)

The onElementDestroy event is invoked when an element is destroyed.

1)	Event	event	The event object for this event.
2)	Element	element	The element that is about to be destroyed.

cancellable	This event can be cancelled, by using event.preventDefault.

There aren't any notes for this event.

Example 1 - JavaScript:

addEventHandler('OnElementDestroy', (event, element) => {
    message(`Element with id ${element.id} has been destroyed.`, COLOUR_RED)
});

Example 2 - Lua:

addEventHandler('OnElementDestroy', function(event, element)
    message('Element with id ' .. element.id .. ' has been destroyed.', COLOUR_RED)
end)

There isn't any compatibility information for this event.

@@ Line 1: / Line 1: @@
-{{ScriptItem
+{{ScriptItem2
-|endpoint = shared
+|name = onElementDestroy
+|side = shared
 |type = event
-|name = onElementDestroy
+|games = iii vc sa iv
-|usage = an element is destroyed
+|desc = an element is destroyed
-|callbackParameters = Event event, Element element
+|arg1 = Element element The element that is about to be destroyed.
-|parameter1 = Element element The element that is about to be destroyed.
+|cancel = true
-|cancellable = true
 |exampleJS = addEventHandler('OnElementDestroy', (event, element) => {
 	message(`Element with id ${element.id} has been destroyed.`, COLOUR_RED)