resource.isReady: Difference between revisions

Latest revision as of 04:03, 23 July 2025

Method Client Only Online and Offline

Available since Client 1.0.0

bool resource.isReady(void)

The resource.isReady method is used to check if all of a resource's files are downloaded.

void	This method doesn't take any parameters.

bool	`bool true` if all resource files are downloaded, or `bool false` if not.

Shared Resource

This does NOT include <script> entries in the resource's meta.xml! It only applies to <file> entries.
This is also related to the OnResourceReady event, which is called once all the file's for a resource are downloaded.

There aren't any examples for this method.

There isn't any compatibility information for this method.

@@ Line 6: / Line 6: @@
 |parameters = void
 |returnTypes = bool
-|returnInfo = <code>bool true</code> if the resource is ready, or <code>bool false</code> if not
+|returnInfo = <code>bool true</code> if all resource files are downloaded, or <code>bool false</code> if not
 |returnFail1 = void
-|usage = check if a resource is ready
+|usage = check if all of a resource's files are downloaded
+|notes = This does NOT include <script> entries in the resource's meta.xml! It only applies to <file> entries.<br>
+This is also related to the [[OnResourceReady|OnResourceReady]] event, which is called once all the file's for a resource are downloaded.
 }}