FileType Types

Author: photonstorm

src/loader/filetypes/AtlasJSONFile.js

@@ -12,19 +12,6 @@ var IsPlainObject = require('../../utils/object/IsPlainObject');
 var JSONFile = require('./JSONFile.js');
 var MultiFile = require('../MultiFile.js');
 
-/**
- * @typedef {object} Phaser.Loader.FileTypes.AtlasJSONFileConfig
- *
- * @property {string} key - The key of the file. Must be unique within both the Loader and the Texture Manager.
- * @property {string} [textureURL] - The absolute or relative URL to load the texture image file from.
- * @property {string} [textureExtension='png'] - The default file extension to use for the image texture if no url is provided.
- * @property {Phaser.Types.Loader.XHRSettingsObject} [textureXhrSettings] - Extra XHR Settings specifically for the texture image file.
- * @property {string} [normalMap] - The filename of an associated normal map. It uses the same path and url to load as the texture image.
- * @property {string} [atlasURL] - The absolute or relative URL to load the atlas json file from. Or a well formed JSON object to use instead.
- * @property {string} [atlasExtension='json'] - The default file extension to use for the atlas json if no url is provided.
- * @property {Phaser.Types.Loader.XHRSettingsObject} [atlasXhrSettings] - Extra XHR Settings specifically for the atlas json file.
- */
-
 /**
  * @classdesc
  * A single JSON based Texture Atlas File suitable for loading by the Loader.

src/loader/filetypes/AtlasXMLFile.js

@@ -12,19 +12,6 @@ var IsPlainObject = require('../../utils/object/IsPlainObject');
 var MultiFile = require('../MultiFile.js');
 var XMLFile = require('./XMLFile.js');
 
-/**
- * @typedef {object} Phaser.Loader.FileTypes.AtlasXMLFileConfig
- *
- * @property {string} key - The key of the file. Must be unique within both the Loader and the Texture Manager.
- * @property {string} [textureURL] - The absolute or relative URL to load the texture image file from.
- * @property {string} [textureExtension='png'] - The default file extension to use for the image texture if no url is provided.
- * @property {Phaser.Types.Loader.XHRSettingsObject} [textureXhrSettings] - Extra XHR Settings specifically for the texture image file.
- * @property {string} [normalMap] - The filename of an associated normal map. It uses the same path and url to load as the texture image.
- * @property {string} [atlasURL] - The absolute or relative URL to load the atlas xml file from.
- * @property {string} [atlasExtension='xml'] - The default file extension to use for the atlas xml if no url is provided.
- * @property {Phaser.Types.Loader.XHRSettingsObject} [atlasXhrSettings] - Extra XHR Settings specifically for the atlas xml file.
- */
-
 /**
  * @classdesc
  * A single XML based Texture Atlas File suitable for loading by the Loader.

src/loader/filetypes/AudioFile.js

@@ -12,15 +12,6 @@ var GetFastValue = require('../../utils/object/GetFastValue');
 var HTML5AudioFile = require('./HTML5AudioFile');
 var IsPlainObject = require('../../utils/object/IsPlainObject');
 
-/**
- * @typedef {object} Phaser.Loader.FileTypes.AudioFileConfig
- *
- * @property {string} key - The key of the file. Must be unique within the Loader and Audio Cache.
- * @property {string} [urlConfig] - The absolute or relative URL to load the file from.
- * @property {Phaser.Types.Loader.XHRSettingsObject} [xhrSettings] - Extra XHR Settings specifically for this file.
- * @property {AudioContext} [audioContext] - The AudioContext this file will use to process itself.
- */
-
 /**
  * @classdesc
  * A single Audio File suitable for loading by the Loader.

src/loader/filetypes/AudioSpriteFile.js

@@ -12,17 +12,6 @@ var IsPlainObject = require('../../utils/object/IsPlainObject');
 var JSONFile = require('./JSONFile.js');
 var MultiFile = require('../MultiFile.js');
 
-/**
- * @typedef {object} Phaser.Loader.FileTypes.AudioSpriteFileConfig
- *
- * @property {string} key - The key of the file. Must be unique within both the Loader and the Audio Cache.
- * @property {string} jsonURL - The absolute or relative URL to load the json file from. Or a well formed JSON object to use instead.
- * @property {Phaser.Types.Loader.XHRSettingsObject} [jsonXhrSettings] - Extra XHR Settings specifically for the json file.
- * @property {{(string|string[])}} [audioURL] - The absolute or relative URL to load the audio file from.
- * @property {any} [audioConfig] - The audio configuration options.
- * @property {Phaser.Types.Loader.XHRSettingsObject} [audioXhrSettings] - Extra XHR Settings specifically for the audio file.
- */
-
 /**
  * @classdesc
  * An Audio Sprite File suitable for loading by the Loader.

src/loader/filetypes/BinaryFile.js

@@ -11,16 +11,6 @@ var FileTypesManager = require('../FileTypesManager');
 var GetFastValue = require('../../utils/object/GetFastValue');
 var IsPlainObject = require('../../utils/object/IsPlainObject');
 
-/**
- * @typedef {object} Phaser.Loader.FileTypes.BinaryFileConfig
- *
- * @property {string} key - The key of the file. Must be unique within both the Loader and the Binary Cache.
- * @property {string} [url] - The absolute or relative URL to load the file from.
- * @property {string} [extension='bin'] - The default file extension to use if no url is provided.
- * @property {Phaser.Types.Loader.XHRSettingsObject} [xhrSettings] - Extra XHR Settings specifically for this file.
- * @property {any} [dataType] - Optional type to cast the binary file to once loaded. For example, `Uint8Array`.
- */
-
 /**
  * @classdesc
  * A single Binary File suitable for loading by the Loader.

src/loader/filetypes/BitmapFontFile.js

@@ -13,19 +13,6 @@ var MultiFile = require('../MultiFile.js');
 var ParseXMLBitmapFont = require('../../gameobjects/bitmaptext/ParseXMLBitmapFont.js');
 var XMLFile = require('./XMLFile.js');
 
-/**
- * @typedef {object} Phaser.Loader.FileTypes.BitmapFontFileConfig
- *
- * @property {string} key - The key of the file. Must be unique within both the Loader and the Texture Manager.
- * @property {string} [textureURL] - The absolute or relative URL to load the texture image file from.
- * @property {string} [textureExtension='png'] - The default file extension to use for the image texture if no url is provided.
- * @property {Phaser.Types.Loader.XHRSettingsObject} [textureXhrSettings] - Extra XHR Settings specifically for the texture image file.
- * @property {string} [normalMap] - The filename of an associated normal map. It uses the same path and url to load as the texture image.
- * @property {string} [fontDataURL] - The absolute or relative URL to load the font data xml file from.
- * @property {string} [fontDataExtension='xml'] - The default file extension to use for the font data xml if no url is provided.
- * @property {Phaser.Types.Loader.XHRSettingsObject} [fontDataXhrSettings] - Extra XHR Settings specifically for the font data xml file.
- */
-
 /**
  * @classdesc
  * A single Bitmap Font based File suitable for loading by the Loader.

src/loader/filetypes/CSSFile.js

@@ -11,15 +11,6 @@ var FileTypesManager = require('../FileTypesManager');
 var GetFastValue = require('../../utils/object/GetFastValue');
 var IsPlainObject = require('../../utils/object/IsPlainObject');
 
-/**
- * @typedef {object} Phaser.Loader.FileTypes.CSSFileConfig
- *
- * @property {string} key - The key of the file. Must be unique within the Loader.
- * @property {string} [url] - The absolute or relative URL to load the file from.
- * @property {string} [extension='js'] - The default file extension to use if no url is provided.
- * @property {Phaser.Types.Loader.XHRSettingsObject} [xhrSettings] - Extra XHR Settings specifically for this file.
- */
-
 /**
  * @classdesc
  * A single CSS File suitable for loading by the Loader.

src/loader/filetypes/GLSLFile.js

@@ -12,16 +12,6 @@ var GetFastValue = require('../../utils/object/GetFastValue');
 var IsPlainObject = require('../../utils/object/IsPlainObject');
 var Shader = require('../../display/shader/BaseShader');
 
-/**
- * @typedef {object} Phaser.Loader.FileTypes.GLSLFileConfig
- *
- * @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} [shaderType='fragment'] - The type of shader. Either `fragment` for a fragment shader, or `vertex` for a vertex shader. This is ignored if you load a shader bundle.
- * @property {string} [extension='glsl'] - The default file extension to use if no url is provided.
- * @property {Phaser.Types.Loader.XHRSettingsObject} [xhrSettings] - Extra XHR Settings specifically for this file.
- */
-
 /**
  * @classdesc
  * A single GLSL File suitable for loading by the Loader.

src/loader/filetypes/HTMLFile.js

@@ -11,15 +11,6 @@ var FileTypesManager = require('../FileTypesManager');
 var GetFastValue = require('../../utils/object/GetFastValue');
 var IsPlainObject = require('../../utils/object/IsPlainObject');
 
-/**
- * @typedef {object} Phaser.Loader.FileTypes.HTMLFileConfig
- *
- * @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='html'] - The default file extension to use if no url is provided.
- * @property {Phaser.Types.Loader.XHRSettingsObject} [xhrSettings] - Extra XHR Settings specifically for this file.
- */
-
 /**
  * @classdesc
  * A single HTML File suitable for loading by the Loader.

src/loader/filetypes/HTMLTextureFile.js

@@ -11,17 +11,6 @@ var FileTypesManager = require('../FileTypesManager');
 var GetFastValue = require('../../utils/object/GetFastValue');
 var IsPlainObject = require('../../utils/object/IsPlainObject');
 
-/**
- * @typedef {object} Phaser.Loader.FileTypes.HTMLTextureFileConfig
- *
- * @property {string} key - The key of the file. Must be unique within both the Loader and the Texture Manager.
- * @property {string} [url] - The absolute or relative URL to load the file from.
- * @property {string} [extension='html'] - The default file extension to use if no url is provided.
- * @property {Phaser.Types.Loader.XHRSettingsObject} [xhrSettings] - Extra XHR Settings specifically for this file.
- * @property {integer} [width=512] - The width of the texture the HTML will be rendered to.
- * @property {integer} [height=512] - The height of the texture the HTML will be rendered to.
- */
-
 /**
  * @classdesc
  * A single HTML File suitable for loading by the Loader.