Updated jsdocs. Fix #5857

This commit is contained in:
Richard Davey 2022-02-04 16:05:02 +00:00
parent 6f348f83aa
commit e68f09cefb

View file

@ -67,6 +67,17 @@ var NOOP = require('../../../src/utils/NOOP');
* Phaser Loader. However, doing so will not add it to the current Scene. It will be available from any * Phaser Loader. However, doing so will not add it to the current Scene. It will be available from any
* subsequent Scenes. * subsequent Scenes.
* *
* ## A note about inlined data:
*
* If you need to load Spine assets from inline / base64 encoded data, then you should not use the Loader
* at all. Instead, call the functions directly as required:
*
* scene.cache.json.add
* scene.cache.custom.spine.add
* scene.textures.addBase64
*
* ## Using the plugin
*
* Assuming a default environment you access it from within a Scene by using the `this.spine` reference. * Assuming a default environment you access it from within a Scene by using the `this.spine` reference.
* *
* When this plugin is installed into a Scene it will add a Loader File Type, allowing you to load * When this plugin is installed into a Scene it will add a Loader File Type, allowing you to load