OnResourceStop: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
 
 
(20 intermediate revisions by 11 users not shown)
Line 1: Line 1:
[[Category:Incomplete Event]]
__NOTOC__
This event is triggered when the resource is changed or unloaded.
{{Server event}}
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==
<syntaxhighlight lang="lua">
resource stoppedResource, boolean wasDeleted
</syntaxhighlight>
 
*'''stoppedResource''': the [[resource]] that is being stopped.
*'''wasDeleted''': a [[boolean]] representing whether the resource folder was deleted, moved or renamed.
 
==Source==
The [[event system#Event source|source]] of this event is the root [[element]] of the resource that is being stopped.


==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">
addEventHandler( "onResourceStop", root,
    function( resource )
        outputChatBox( "The resource " .. getResourceName( resource ) .. " was stopped!", root )
    end
)
</syntaxhighlight>


This example only outputs message if the stopped resource is the same resource where the eventHandler is.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
addEventHandler( "onResourceStop", resourceRoot,
    function( resource )
        outputChatBox( "This resource has stopped!", root )
  end
)
</syntaxhighlight>


addEventHandler ( "onResourceStop", root, "onResourceStop" )
==Changelog==
function onResourceStop ( )
{{ChangelogHeader}}
  outputChatBox ( "Script Unloaded!", root, 255, 255, 255 )
{{ChangelogItem|1.5.5-9.11854|Added wasDeleted parameter}}
end


</syntaxhighlight>
{{See also/Server event|Resource events}}

Latest revision as of 22:06, 9 October 2019

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, boolean wasDeleted
  • 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. 

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

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 stopped!", root )
   end
)

Changelog

Version Description
1.5.5-9.11854 Added wasDeleted parameter

See Also

Resource events


Event functions


Retrieved from "https://wiki.multitheftauto.com/wiki/OnResourceStop?oldid=64503"