OnResourceStart: Difference between revisions

From GTA Connected
Jump to navigation Jump to search
m (Typo: resouce -> resource)
 
No edit summary
Line 1: Line 1:
{{ScriptItem
{{ScriptItem2
|endpoint = shared
|name = onResourceStart
|side = shared
|type = event
|type = event
|name = onResourceStart
|games = iii vc sa iv
|usage = a resource starts
|desc = a resource starts
|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)
|exampleLua = addEventHandler("OnResourceStart", function(event,resource)
outputChatBox("Resource ".. resource.name .." has started.", COLOUR_RED)
outputChatBox("Resource ".. resource.name .." has started.", COLOUR_RED)
end)
end)
}}
}}

Revision as of 20:28, 19 November 2022

Event Server and Client icon-iii.png icon-vc.png icon-sa.png icon-iv.png 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 starts.

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

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.

Related

Server Related

icon-iii.png icon-vc.png icon-sa.png icon-iv.png OnResourceStart
icon-iii.png icon-vc.png icon-sa.png icon-iv.png OnResourceStop


Client Related

icon-iii.png icon-vc.png icon-sa.png icon-iv.png OnResourceReady
icon-iii.png icon-vc.png icon-sa.png icon-iv.png OnResourceStart
icon-iii.png icon-vc.png icon-sa.png icon-iv.png OnResourceStop