OnResourceStop: Difference between revisions
Jump to navigation
Jump to search
m (Added info on new parameter) |
m (→Parameters) |
||
Line 14: | Line 14: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
*'''stoppedResource''': | *'''stoppedResource''': the [[resource]] that is being stopped. | ||
{{New items|3.0160|1.6| | {{New items|3.0160|1.6| | ||
*'''wasDeleted''': | *'''wasDeleted''': a [[boolean]] representing whether the resource folder was deleted, moved or renamed. | ||
}} | }} | ||
==Source== | ==Source== | ||
The [[event system#Event source|source]] of this event is the root [[element]] of the resource that is being stopped. | The [[event system#Event source|source]] of this event is the root [[element]] of the resource that is being stopped. |
Revision as of 22:08, 2 April 2018
This event is triggered when the resource is stopped. This can occur for a number of reasons:
- The stop console command was used
- The restart console command was used
- The resource was modified (the resource will automatically restart)
- Another resource stopped it using stopResource.
Note: If you wish to just detect a single resource being stopped, you should attach handlers for this event to the resource's root element. You can access this using getResourceRootElement.
Parameters
resource stoppedResource
- stoppedResource: the resource that is being stopped.
- wasDeleted: a boolean representing whether the resource folder was deleted, moved or renamed.
Source
The source of this event is the root element of the resource that is being stopped.
Example
This example displays a message in the chatbox when a resource is stopped.
Click to collapse [-]
Example 1: ServeraddEventHandler ( "onResourceStop", root, function ( resource ) outputChatBox ( "The Resource " .. getResourceName(resource) .. " was stopped!", root, 255, 255, 255 ) end )
Click to collapse [-]
Example 2: ServerThis example only outputs message if the stopped resource is the same resource where the eventHandler is.
addEventHandler ( "onResourceStop", resourceRoot, function ( resource ) outputChatBox ( "This resource has stoped", root, 255, 255, 255 ) end )
See Also
Resource events
Event functions
- addEvent
- addEventHandler
- cancelEvent
- cancelLatentEvent
- getEventHandlers
- getLatentEventHandles
- getLatentEventStatus
- removeEventHandler
- triggerEvent
- wasEventCancelled