OnResourceStop: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
This event is triggered when the resource is changed or unloaded.
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]].  


==Example==
==Example==
This example displays a message in the textbox when the resource is changed / unloaded
This example displays a message in the chatbox when a resource is stopped.


<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">


addEventHandler ( "onResourceStop", root, "onResourceStop" )
addEventHandler ( "onResourceStop", root,  
function onResourceStop ( )
    function ( resource )
  outputChatBox ( "Script Unloaded!", root, 255, 255, 255 )
        outputChatBox ( "The Resource " .. getResourceName(resource) .. " was stopped!", root, 255, 255, 255 )
end
    end  
)


</syntaxhighlight>
</syntaxhighlight>

Revision as of 04:08, 5 July 2007

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.

Example

This example displays a message in the chatbox when a resource is stopped.


addEventHandler ( "onResourceStop", root, 
    function ( resource )
        outputChatBox ( "The Resource " .. getResourceName(resource) .. " was stopped!", root, 255, 255, 255 )
    end 
)