| Excerpt |
|---|
Perform a task when dependencies become available. |
Syntax
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
Check.doWhen(dependencies, self, task[, lazy]); |
Parameters
| Parameter | Type | Mandatory | Notes | Util.js version |
|---|---|---|---|---|
| dependencies | Dependency Descriptor Object |  | The dependencies for the task. | 1.0 |
| self | | The SDO of the script submitting the task. | 1.0 | |
| task | Function String | | Either:
Note: Autoloading must be enabled if you specify a file name to load. See Check.paths for more information. | 1.0 |
| lazy | Constant |  | By default, Check.doWhen() will attempt to autoload missing dependencies (except those marked as If you want to prevent autoloading, specify See Check.paths for more information on autoloading. | 1.0 |
Return Values
| Value | Type | Notes | Util.js version |
|---|---|---|---|
| true | Boolean | The dependencies were available and the task has been performed. | 1.0 |
| false | Boolean | One or more of the dependency checks failed and the task has not yet been performed. The task will be queued until missing dependencies become available. If one of the dependencies is marked as | 1.0 |
| <error> | Error | An error occurred, usually due to one of the following reasons:
| 1.0 |
Notes
The Check.doWhen() function is most commonly used for lazy loading diagnostic routines. Diagnostic routines are not required for normal gameplay, so they can be lazy loaded to reduce game start-up times and RAM consumption.
You can use the "loaddiag" chat command (part of Chat API) to load Diag API at any time during a game, which in turn will cause all the lazy-loaded diagnostic routine scripts to be loaded.
You can run the "blocked" diagnostic (requires Diag API) to get a list of tasks that are blocked due to errors or presence of dependencies marked as Check.NOT_LOADED. You can also run the "blocked" diagnostic routine via the "diag blocked" chat command (requires Chat API).
Example
Note: In these examples, it's assumed the 'self' variable is already defined. For more information on that variable, see Self Descriptor Object.
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
Check.doWhen(
{"Diag.js": true},
self,
"Diag.Cache.js",
Check.LAZY_LOAD
); |
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
Check.doWhen(
{"Chat.js": true},
self,
function() {
chat(0, "Let's chat...");
},
Check.LAZY_LOAD
); |
| Div | ||||||
|---|---|---|---|---|---|---|
| ||||||
Availability
Requires:
|
| Div | ||||
|---|---|---|---|---|
| ||||
ContentsJump to:
|
| Div | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
Dependency CheckingTopics:
|