OnResourceReady - Revision history

Vortrex at 16:42, 9 November 2025

2025-11-09T16:42:37Z

← Older revision		Revision as of 16:42, 9 November 2025
Line 10:		Line 10:
	\|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>		\|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>		This is related to the [[resource.isReady\|resource.isReady]] property, which indicates if all a resource's files are finished downloading.<br>
			This event is also called when [[OnResourceStart\|OnResourceStart]] is called, IF the resource is ready (ready = all files are downloaded).<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.		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.		\|exampleLuaCS = // This example will fade the camera in to show the game world, when the resource is ready.

Vortrex at 04:05, 23 July 2025

2025-07-23T04:05:41Z

← Older revision		Revision as of 04:05, 23 July 2025
Line 9:		Line 9:
	\|cancel = false		\|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>		\|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.		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.		\|exampleLuaCS = // This example will fade the camera in to show the game world, when the resource is ready.

Vortrex at 18:53, 22 May 2025

2025-05-22T18:53:46Z

← Older revision		Revision as of 18:53, 22 May 2025
Line 4:		Line 4:
	\|type = event		\|type = event
	\|games = iii vc sa iv		\|games = iii vc sa iv
	\|desc = when all files are finished downloading to the client~~, and the resource is ready to start~~		\|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.		\|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.		\|note = The [[fadeCamera\|fadeCamera]], and [[addEventHandler\|addEventHandler]] functions were used in this example. More information on the corresponding pages.
	\|cancel = false		\|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>
			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.		\|exampleLuaCS = // This example will fade the camera in to show the game world, when the resource is ready.

Mex at 20:28, 19 November 2022

2022-11-19T20:28:44Z

← Older revision		Revision as of 20:28, 19 November 2022
Line 1:		Line 1:
	{{~~ScriptItem~~		{{ScriptItem2
	\|~~endpoint~~ = client		\|name = onResourceReady
			\|side = client
	\|type = event		\|type = event
	\|~~name~~ = ~~onResourceReady~~		\|games = iii vc sa iv
	\|~~callbackParameters~~ = ~~Event event~~, ~~Resource~~ resource		\|desc = when all files are finished downloading to the client, and the resource is ready to start
	\|~~parameter1~~ = Resource resource The resource that has entirely loaded.		\|arg1 = Resource resource The resource that has entirely loaded.
	\|~~cancellable~~ = ~~false~~		\|note = The [[fadeCamera\|fadeCamera]], and [[addEventHandler\|addEventHandler]] functions were used in this example. More information on the corresponding pages.
	\|~~usage = when all files are finished downloading to the client~~, and the ~~resource is ready to start~~		\|cancel = false
	\|~~luaExampleCS~~ = // This example will fade the camera in to show the game world, when the resource is ready.		\|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:
	}		}
	}		}
	~~\|notes = The [[fadeCamera\|fadeCamera]], and [[addEventHandler\|addEventHandler]] functions were used in this example. More information on the corresponding pages.~~
	}}		}}

Mex at 14:09, 7 October 2019

2019-10-07T14:09:22Z

New page

{{ScriptItem
|endpoint = client
|type = event
|name = onResourceReady
|callbackParameters = Event event, Resource resource
|parameter1 = Resource resource The resource that has entirely loaded.
|cancellable = false
|usage = when all files are finished downloading to the client, and the resource is ready to start
|luaExampleCS = // 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);
}
}
|notes = The [[fadeCamera|fadeCamera]], and [[addEventHandler|addEventHandler]] functions were used in this example. More information on the corresponding pages.
}}