JsonManager

JsonManager

JsonManager loads json files (using XMLHttpRequest), using the "json" resources registered in the game resources.

Contrary to audio/fonts, json files are loaded asynchronously, when requested. You should properly handle errors, and give the developer/player a way to know that loading failed.

Constructor

new JsonManager(resources)

Parameters:
Name Type Description
resources

The resources data of the game.

Source:

Methods

getLoadedJson(resourceName)

Get the object for the given resource that is already loaded (preloaded or loaded with loadJson). If the resource is not loaded, null will be returned.

Parameters:
Name Type Description
resourceName

The name of the json resource.

Returns:
Type Description

the content of the json resource, if loaded. null otherwise.

Source:

isJsonLoaded(resourceName)

Check if the given json resource was loaded (preloaded or loaded with loadJson).

Parameters:
Name Type Description
resourceName

The name of the json resource.

Returns:
Type Description

true if the content of the json resource is loaded. false otherwise.

Source:

loadJson(resourceName, callback)

Request the json file from the given resource name. This method is asynchronous. When loaded, the callback is called with the error (null if none) and the loaded json (a JS Object).

Parameters:
Name Type Description
resourceName

The resource pointing to the json file to load.

callback

The callback function called when json is loaded (or an error occured).

Source:

preloadJsons(onProgress, onComplete)

Request all the json resources to be preloaded (unless they are marked as not preloaded).

Note that even if a JSON is already loaded, it will be reloaded (useful for hot-reloading, as JSON files can have been modified without the editor knowing).

Parameters:
Name Type Description
onProgress

The function called after each json is loaded.

onComplete

The function called when all jsons are loaded.

Source:

setResources(resources)

Update the resources data of the game. Useful for hot-reloading, should not be used otherwise.

Parameters:
Name Type Description
resources

The resources data of the game.

Source: