OnResourceStop: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
m (Added info on new parameter)
Line 15: Line 15:


*'''stoppedResource''': The resource that is being stopped.
*'''stoppedResource''': The resource that is being stopped.
{{New items|3.0160|1.6|
*'''wasDeleted''': True if the resource folder was deleted, moved or renamed.
}}


<!-- Add the event's source in the section below -->
<!-- Add the event's source in the section below -->

Revision as of 23:20, 16 February 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: True if 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: Server
addEventHandler ( "onResourceStop", root, 
    function ( resource )
        outputChatBox ( "The Resource " .. getResourceName(resource) .. " was stopped!", root, 255, 255, 255 )
   end 
)
Click to collapse [-]
Example 2: Server

This 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