Interface administrators, moderator
2,756
edits
OnResourceReady: Difference between revisions
no edit summary
No edit summary |
No edit summary |
||
| (2 intermediate revisions by 2 users not shown) | |||
| 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. This does NOT include script files. | ||
| | |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 | ||
| | |notes = This function is only called when extra files (using the <file> tag in meta.xml) are done downloading. The script files (added with <script> tag) are handled differently, so resource might've already started and running before the extra files are downloaded. You can check this in any script file with [[resource.isStarted]].<br> | ||
This is related to the [[resource.isReady|resource.isReady]] property, which indicates if all a resource's files are finished downloading.<br> | |||
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|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. | |||
|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 18: | ||
} | } | ||
} | } | ||
}} | }} | ||