Mirrors/phaser
2
0
Fork 0
mirror of https://github.com/photonstorm/phaser synced 2025-02-17 06:28:30 +00:00
Code Issues Projects Releases Packages Wiki Activity

Added jsdocs

Browse source
This commit is contained in:
Richard Davey 2018-05-05 12:14:16 +01:00
parent 42cc4acf00
commit a1ee4e6f24
3 changed files with 141 additions and 27 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
src/loader/filetypes/ImageFile.js
View file

@ -184,7 +184,7 @@ var ImageFile = new Class({
*
* The file is **not** loaded immediately, it is added to a queue ready to be loaded either when the loader starts,
* or if it's already running, when the next free load slot becomes available. This means you cannot use the file
* immediately after calling this method, but instead my wait for the file to complete.
* immediately after calling this method, but instead must wait for the file to complete.
*
* Phaser can load all common image types: png, jpg, gif and any other format the browser can natively handle.
* If you try to load an animated gif only the first frame will be rendered. Browsers do not natively support playback

83
src/loader/filetypes/TextFile.js
View file

@ -11,9 +11,22 @@ var FileTypesManager = require('../FileTypesManager');
var GetFastValue = require('../../utils/object/GetFastValue');
var IsPlainObject = require('../../utils/object/IsPlainObject');
/**
* @typedef {object} Phaser.Loader.FileTypes.TextFileConfig
*
* @property {string} key - The key of the file. Must be unique within both the Loader and the Text Cache.
* @property {string} [url] - The absolute or relative URL to load the file from.
* @property {string} [extension='txt'] - The default file extension to use if no url is provided.
* @property {XHRSettingsObject} [xhrSettings] - Extra XHR Settings specifically for this file.
*/
/**
* @classdesc
* [description]
* A single Text File suitable for loading by the Loader.
*
* These are created when you use the Phaser.Loader.LoaderPlugin#text method and are not typically created directly.
*
* For documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#text.
*
* @class TextFile
* @extends Phaser.Loader.File
@ -21,10 +34,10 @@ var IsPlainObject = require('../../utils/object/IsPlainObject');
* @constructor
* @since 3.0.0
*
* @param {string} key - [description]
* @param {string} url - [description]
* @param {string} path - [description]
* @param {XHRSettingsObject} [xhrSettings] - [description]
* @param {Phaser.Loader.LoaderPlugin} loader - A reference to the Loader that is responsible for this file.
* @param {(string|Phaser.Loader.FileTypes.TextFileConfig)} key - The key to use for this file, or a file configuration object.
* @param {string} [url] - The absolute or relative URL to load this file from. If undefined or `null` it will be set to `<key>.txt`, i.e. if `key` was "alien" then the URL will be "alien.txt".
* @param {XHRSettingsObject} [xhrSettings] - Extra XHR Settings specifically for this file.
*/
var TextFile = new Class({
@ -59,6 +72,13 @@ var TextFile = new Class({
File.call(this, loader, fileConfig);
},
/**
* Called automatically by Loader.nextFile.
* This method controls what extra work this File does with its loaded data.
*
* @method Phaser.Loader.FileTypes.TextFile#onProcess
* @since 3.7.0
*/
onProcess: function ()
{
this.state = CONST.FILE_PROCESSING;
@ -71,21 +91,58 @@ var TextFile = new Class({
});
/**
* Adds a Text file to the current load queue.
* Adds an Text file, or array of Text files, to the current load queue.
*
* Note: This method will only be available if the Text File type has been built into Phaser.
* The file is **not** loaded immediately, it is added to a queue ready to be loaded either when the loader starts,
* or if it's already running, when the next free load slot becomes available. This means you cannot use the file
* immediately after calling this method, but instead must wait for the file to complete.
*
* The key must be a unique String. It is used to add the file to the global Text Cache upon a successful load.
* The key should be unique both in terms of files being loaded and files already present in the Text Cache.
* Loading a file using a key that is already taken will result in a warning. If you wish to replace an existing file
* then remove it from the Text Cache first, before loading a new one.
*
* The file is **not** loaded immediately after calling this method.
* Instead, the file is added to a queue within the Loader, which is processed automatically when the Loader starts.
* Instead of passing arguments you can pass a configuration object, such as:
*
* ```javascript
* this.load.text({
* key: 'story',
* url: 'files/IntroStory.txt'
* });
* ```
*
* See the documentation for `Phaser.Loader.FileTypes.TextFileConfig` for more details.
*
* Once the file has finished loading you can access it from its Cache using its key:
*
* ```javascript
* this.load.image('story', 'files/IntroStory.txt');
* // and later in your game ...
* var data = this.cache.text.get('story');
* ```
*
* If you have specified a prefix in the loader, via `Loader.setPrefix` then this value will be prepended to this files
* key. For example, if the prefix was `LEVEL1.` and the key was `Story` the final key will be `LEVEL1.Story` and
* this is what you would use to retrieve the text from the Text Cache.
*
* The URL can be relative or absolute. If the URL is relative the `Loader.baseURL` and `Loader.path` values will be prepended to it.
*
* If the URL isn't specified the Loader will take the key and create a filename from that. For example if the key is "story"
* and no URL is given then the Loader will set the URL to be "story.txt". It will always add `.txt` as the extension, although
* this can be overridden if using an object instead of method arguments. If you do not desire this action then provide a URL.
*
* Note: Th ability to load this type of file will only be available if the Text File type has been built into Phaser.
* It is available in the default build but can be excluded from custom builds.
*
* @method Phaser.Loader.LoaderPlugin#text
* @fires Phaser.Loader.LoaderPlugin#addFileEvent
* @since 3.0.0
*
* @param {string} key - [description]
* @param {string} url - [description]
* @param {XHRSettingsObject} [xhrSettings] - [description]
* @param {(string|Phaser.Loader.FileTypes.TextFileConfig|Phaser.Loader.FileTypes.TextFileConfig[])} key - The key to use for this file, or a file configuration object, or array of them.
* @param {string} [url] - The absolute or relative URL to load this file from. If undefined or `null` it will be set to `<key>.txt`, i.e. if `key` was "alien" then the URL will be "alien.txt".
* @param {XHRSettingsObject} [xhrSettings] - An XHR Settings configuration object. Used in replacement of the Loaders default XHR Settings.
*
* @return {Phaser.Loader.LoaderPlugin} The Loader.
* @return {Phaser.Loader.LoaderPlugin} The Loader instance.
*/
FileTypesManager.register('text', function (key, url, xhrSettings)
{

83
src/loader/filetypes/XMLFile.js
View file

@ -12,9 +12,22 @@ var GetFastValue = require('../../utils/object/GetFastValue');
var IsPlainObject = require('../../utils/object/IsPlainObject');
var ParseXML = require('../../dom/ParseXML');
/**
* @typedef {object} Phaser.Loader.FileTypes.XMLFileConfig
*
* @property {string} key - The key of the file. Must be unique within both the Loader and the Text Cache.
* @property {string} [url] - The absolute or relative URL to load the file from.
* @property {string} [extension='xml'] - The default file extension to use if no url is provided.
* @property {XHRSettingsObject} [xhrSettings] - Extra XHR Settings specifically for this file.
*/
/**
* @classdesc
* [description]
* A single XML File suitable for loading by the Loader.
*
* These are created when you use the Phaser.Loader.LoaderPlugin#xml method and are not typically created directly.
*
* For documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#xml.
*
* @class XMLFile
* @extends Phaser.Loader.File
@ -22,10 +35,10 @@ var ParseXML = require('../../dom/ParseXML');
* @constructor
* @since 3.0.0
*
* @param {string} key - [description]
* @param {string} url - [description]
* @param {string} path - [description]
* @param {XHRSettingsObject} [xhrSettings] - [description]
* @param {Phaser.Loader.LoaderPlugin} loader - A reference to the Loader that is responsible for this file.
* @param {(string|Phaser.Loader.FileTypes.TextFileConfig)} key - The key to use for this file, or a file configuration object.
* @param {string} [url] - The absolute or relative URL to load this file from. If undefined or `null` it will be set to `<key>.xml`, i.e. if `key` was "alien" then the URL will be "alien.xml".
* @param {XHRSettingsObject} [xhrSettings] - Extra XHR Settings specifically for this file.
*/
var XMLFile = new Class({
@ -60,6 +73,13 @@ var XMLFile = new Class({
File.call(this, loader, fileConfig);
},
/**
* Called automatically by Loader.nextFile.
* This method controls what extra work this File does with its loaded data.
*
* @method Phaser.Loader.FileTypes.XMLFile#onProcess
* @since 3.7.0
*/
onProcess: function ()
{
this.state = CONST.FILE_PROCESSING;
@ -81,21 +101,58 @@ var XMLFile = new Class({
});
/**
* Adds an XML file to the current load queue.
* Adds an XML file, or array of XML files, to the current load queue.
*
* Note: This method will only be available if the XML File type has been built into Phaser.
* The file is **not** loaded immediately, it is added to a queue ready to be loaded either when the loader starts,
* or if it's already running, when the next free load slot becomes available. This means you cannot use the file
* immediately after calling this method, but instead must wait for the file to complete.
*
* The key must be a unique String. It is used to add the file to the global XML Cache upon a successful load.
* The key should be unique both in terms of files being loaded and files already present in the XML Cache.
* Loading a file using a key that is already taken will result in a warning. If you wish to replace an existing file
* then remove it from the XML Cache first, before loading a new one.
*
* The file is **not** loaded immediately after calling this method.
* Instead, the file is added to a queue within the Loader, which is processed automatically when the Loader starts.
* Instead of passing arguments you can pass a configuration object, such as:
*
* ```javascript
* this.load.xml({
* key: 'wavedata',
* url: 'files/AlienWaveData.xml'
* });
* ```
*
* See the documentation for `Phaser.Loader.FileTypes.XMLFileConfig` for more details.
*
* Once the file has finished loading you can access it from its Cache using its key:
*
* ```javascript
* this.load.xml('wavedata', 'files/AlienWaveData.xml');
* // and later in your game ...
* var data = this.cache.xml.get('wavedata');
* ```
*
* If you have specified a prefix in the loader, via `Loader.setPrefix` then this value will be prepended to this files
* key. For example, if the prefix was `LEVEL1.` and the key was `Waves` the final key will be `LEVEL1.Waves` and
* this is what you would use to retrieve the text from the XML Cache.
*
* The URL can be relative or absolute. If the URL is relative the `Loader.baseURL` and `Loader.path` values will be prepended to it.
*
* If the URL isn't specified the Loader will take the key and create a filename from that. For example if the key is "data"
* and no URL is given then the Loader will set the URL to be "data.xml". It will always add `.xml` as the extension, although
* this can be overridden if using an object instead of method arguments. If you do not desire this action then provide a URL.
*
* Note: Th ability to load this type of file will only be available if the XML File type has been built into Phaser.
* It is available in the default build but can be excluded from custom builds.
*
* @method Phaser.Loader.LoaderPlugin#xml
* @fires Phaser.Loader.LoaderPlugin#addFileEvent
* @since 3.0.0
*
* @param {string} key - [description]
* @param {string} url - [description]
* @param {XHRSettingsObject} [xhrSettings] - [description]
* @param {(string|Phaser.Loader.FileTypes.XMLFileConfig|Phaser.Loader.FileTypes.XMLFileConfig[])} key - The key to use for this file, or a file configuration object, or array of them.
* @param {string} [url] - The absolute or relative URL to load this file from. If undefined or `null` it will be set to `<key>.xml`, i.e. if `key` was "alien" then the URL will be "alien.xml".
* @param {XHRSettingsObject} [xhrSettings] - An XHR Settings configuration object. Used in replacement of the Loaders default XHR Settings.
*
* @return {Phaser.Loader.LoaderPlugin} The Loader.
* @return {Phaser.Loader.LoaderPlugin} The Loader instance.
*/
FileTypesManager.register('xml', function (key, url, xhrSettings)
{