OnResourceStart

This event is triggered when a resource is loaded.

Important: If you attach this event to the root element it will called when any resource starts, not just the resource your script is running inside. As such, most of the time you will want to check that the resource passed to this event matches your resource (compare with the value returned by getThisResource) before doing anything. Alternatively you can attach the event to getResourceRootElement(getThisResource()).

Parameters

resource startedResource

• startedResource: The resource that was started

Source

The source of this event is the root element in the resource that started.

Cancel effect

If this event is canceled, the resource starting is aborted and is gets unloaded again.

Example

This code will output the name of any resource that is started.

function displayLoadedRes ( res )
	outputChatBox ( "Resource " .. getResourceName(res) .. " loaded", getRootElement(), 255, 255, 255 )
end
addEventHandler ( "onResourceStart", getRootElement(), displayLoadedRes )

See Also

Resource events

BETA: NEW FEATURE (BUILD: 1.6.0 r22430)
onResourceStateChange
• onPlayerResourceStart
• onResourceLoadStateChange
• onResourcePreStart
• onResourceStart
• onResourceStop

Event functions

• addEvent
• addEventHandler
• cancelEvent
• cancelLatentEvent
• getEventHandlers
• getLatentEventHandles
• getLatentEventStatus
• removeEventHandler
• triggerEvent
• wasEventCancelled