OnResourceReady: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
{{ | {{ScriptItem2 | ||
| | |name = onResourceReady | ||
|side = client | |||
|type = event | |type = event | ||
| | |games = iii vc sa iv | ||
| | |desc = when all files are finished downloading to the client, and the resource is ready to start | ||
| | |arg1 = Resource resource The resource that has entirely loaded. | ||
| | |note = The [[fadeCamera|fadeCamera]], and [[addEventHandler|addEventHandler]] functions were used in this example. More information on the corresponding pages. | ||
| | |cancel = false | ||
| | |exampleLuaCS = // This example will fade the camera in to show the game world, when the resource is ready. | ||
function ResourceReady (event, resource) { | function ResourceReady (event, resource) { | ||
| Line 14: | Line 15: | ||
} | } | ||
} | } | ||
}} | }} | ||
Latest revision as of 20:28, 19 November 2022
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, and the resource is ready to start.
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.
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