resource.isReady: Difference between revisions

(Created page with "{{ScriptItem |endpoint = client |type = method |class = Resource |name = isReady |parameters = void |returnTypes = bool |returnInfo = <code>bool true</code> if the resource is...")
 
No edit summary
 
(One intermediate revision by the same user not shown)
Line 6: Line 6:
|parameters = void
|parameters = void
|returnTypes = bool
|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
|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.
}}
}}

Latest revision as of 04:03, 23 July 2025

Method Client Only icon-iii.png icon-vc.png icon-sa.png icon-iv.png 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.

Parameters

void This method doesn't take any parameters.

Return

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

Types

Shared Resource

Notes

  • 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.

Examples

There aren't any examples for this method.

Compatibility

There isn't any compatibility information for this method.

Related

Client Related

        findResourceByName
        getResources
        thisResource

        resource.exports
        resource.getExport
        resource.isReady
        resource.isStarted
        resource.isStarting
        resource.name
        resource.restart
        resource.start
        resource.stop