OnResourceStop: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{ | {{ScriptItem2 | ||
| | |name = onResourceStop | ||
|side = shared | |||
|type = event | |type = event | ||
| | |games = iii vc sa iv | ||
| | |desc = a resource stops | ||
| | |arg1 = Resource resource The resource which has stopped. | ||
|arg2 = bool stoppingForRestart The status of whether the resource is restarting. (Where restarting is achieved via [[resource.restart|resource.restart]] or the restart command) | |||
|cancel = true | |||
| | |||
|exampleLua = addEventHandler("OnResourceStop", function(event,resource,stoppingForRestart) | |exampleLua = addEventHandler("OnResourceStop", function(event,resource,stoppingForRestart) | ||
outputChatBox("Resource ".. resouce.name .." has stopped."..(stoppingForRestart and " (restarting)" or ""), COLOUR_RED) | outputChatBox("Resource ".. resouce.name .." has stopped."..(stoppingForRestart and " (restarting)" or ""), COLOUR_RED) | ||
end) | end) | ||
}} | }} | ||
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.
Related
Server Related OnResourceStart
OnResourceStop
Client Related OnResourceReady
OnResourceStart
OnResourceStop