onResourceReady

Event Client Only Online and Offline Not Cancellable

Available since Client 1.0.0

onResourceReady(Event event, Resource resource)

The onResourceReady event is invoked when when all files are finished downloading to the client. This does NOT include script files.

Parameters

1)	Event	event	The event object for this event.
2)	Resource	resource	The resource that has entirely loaded.

Attributes

const

This event cannot be cancelled.

Notes

• The fadeCamera, and addEventHandler functions were used in this example. More information on the corresponding pages.
• This is related to the resource.isReady property, which indicates if all a resource's files are finished downloading.
• A good example of this is a resource that shows an image on screen. Such a resource would likely load the image with openFile and graphics.loadPNG so these functions should be called in an OnResourceReady event handler. If they're called in an OnResourceStart event handler, it might throw an error since the resource has started, but the image file hasn't been downloaded to the client yet.

Examples

Example 1 - Lua - Client-Side:

// This example will fade the camera in to show the game world, when the resource is ready.

function ResourceReady (event, resource) {
    if(thisResource == resource) {
        game.fadeCamera(0.5, true);
    }
}

Compatibility

There isn't any compatibility information for this event.

Related

Client Related

OnResourceReady
OnResourceStart
OnResourceStop