OnResourceStop: Difference between revisions

Latest revision as of 03:10, 26 February 2024

Event Server and Client Online and Offline Cancellable

Available since Server 1.0.0, Client 1.0.0

onResourceStop(Event event, Resource resource, bool stoppingForRestart)

The onResourceStop event is invoked when a resource stops.

Parameters

1)	Event	event	The event object for this event.
2)	Resource	resource	The resource which has stopped.
3)	bool	stoppingForRestart	The status of whether the resource is restarting. (Where restarting is achieved via resource.restart or the restart command).

Attributes

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

Notes

There aren't any notes for this event.

Examples

Example 1 - Lua:

addEventHandler("OnResourceStop", function(event,resource,stoppingForRestart)
    outputChatBox("Resource ".. resouce.name .." has stopped."..(stoppingForRestart and " (restarting)" or ""), COLOUR_RED)
end)

Compatibility

There isn't any compatibility information for this event.

@@ Line 1: / Line 1: @@
-{{ScriptItem
+{{ScriptItem2
-|endpoint = shared
+|name = onResourceStop
+|side = shared
 |type = event
-|name = onResourceStop
+|games = iii vc sa iv
-|usage = a resource stops
+|desc = a resource stops
-|callbackParameters = Event event, Resource resource, bool stoppingForRestart
+|arg1 = Resource resource The resource which has stopped.
-|cancellable = true
+|arg2 = bool stoppingForRestart The status of whether the resource is restarting. (Where restarting is achieved via [[resource.restart|resource.restart]] or the restart command)
-|parameter1 = Resource resource The resource which has stopped.
+|cancel = true
-|parameter2 = bool stoppingForRestart The status of whether the resource is restarting.
 |exampleLua = addEventHandler("OnResourceStop", function(event,resource,stoppingForRestart)
 	outputChatBox("Resource ".. resouce.name .." has stopped."..(stoppingForRestart and " (restarting)" or ""), COLOUR_RED)
 end)
 }}