OnResourceStart: Difference between revisions

Latest revision as of 03:12, 26 February 2024

Event Server and Client Online and Offline Cancellable

Available since Server 1.0.0, Client 1.0.0

onResourceStart(Event event, Resource resource)

The onResourceStart event is invoked when a resource has started. The event is triggered after all script files have been ran in the resource's meta.xml file.

Parameters

1)	Event	event	The event object for this event.
2)	Resource	resource	The resource which has started.

Attributes

cancellable	This event can be cancelled, by using event.preventDefault.

Notes

This event can be used with bindEventHandler.

Examples

Example 1 - Lua:

addEventHandler("OnResourceStart", function(event,resource)
    outputChatBox("Resource ".. resource.name .." has started.", COLOUR_RED)
end)

Compatibility

There isn't any compatibility information for this event.

@@ Line 1: / Line 1: @@
-{{ScriptItem
+{{ScriptItem2
-|endpoint = shared
+|name = onResourceStart
+|side = shared
 |type = event
-|name = onResourceStart
+|games = iii vc sa iv
-|usage = a resource starts
+|desc = a resource has started. The event is triggered after all script files have been ran in the resource's meta.xml file.
-|callbackParameters = Event event, Resource resource
+|arg1 = Resource resource The resource which has started.
-|cancellable = true
+|note = This event can be used with [[bindEventHandler|bindEventHandler]].
-|parameter1 = Resource resource The resource which has started.
+|cancel = true
-|notes = This event can be used with [[bindEventHandler|bindEventHandler]].
 |exampleLua = addEventHandler("OnResourceStart", function(event,resource)
 	outputChatBox("Resource ".. resource.name .." has started.", COLOUR_RED)
 end)
 }}