Skip to content

Commit bbaa5c3

Browse files
committed
Added OBJFileConfig defs
1 parent 7287a76 commit bbaa5c3

2 files changed

Lines changed: 11 additions & 2 deletions

File tree

src/loader/filetypes/OBJFile.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ var ParseObj = require('../../geom/mesh/ParseObj');
2929
* @param {Phaser.Loader.LoaderPlugin} loader - A reference to the Loader that is responsible for this file.
3030
* @param {(string|Phaser.Types.Loader.FileTypes.OBJFileConfig)} key - The key to use for this file, or a file configuration object.
3131
* @param {string} [url] - The absolute or relative URL to load this file from. If undefined or `null` it will be set to `<key>.obj`, i.e. if `key` was "alien" then the URL will be "alien.obj".
32-
* @param {boolean} [flipUV=true] - Flip the UV coordinates stored in the texture locations?
32+
* @param {boolean} [flipUV] - Flip the UV coordinates stored in the model data?
3333
* @param {Phaser.Types.Loader.XHRSettingsObject} [xhrSettings] - Extra XHR Settings specifically for this file.
3434
*/
3535
var OBJFile = new Class({
@@ -153,7 +153,7 @@ var OBJFile = new Class({
153153
*
154154
* @param {(string|Phaser.Types.Loader.FileTypes.OBJFileConfig|Phaser.Types.Loader.FileTypes.OBJFileConfig[])} key - The key to use for this file, or a file configuration object, or array of them.
155155
* @param {string} [url] - The absolute or relative URL to load this file from. If undefined or `null` it will be set to `<key>.obj`, i.e. if `key` was "alien" then the URL will be "alien.obj".
156-
* @param {boolean} [flipUVs=true] - Flip the UV coordinates stored in the texture locations?
156+
* @param {boolean} [flipUV] - Flip the UV coordinates stored in the model data?
157157
* @param {Phaser.Types.Loader.XHRSettingsObject} [xhrSettings] - An XHR Settings configuration object. Used in replacement of the Loaders default XHR Settings.
158158
*
159159
* @return {this} The Loader instance.
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
/**
2+
* @typedef {object} Phaser.Types.Loader.FileTypes.OBJFileConfig
3+
*
4+
* @property {string} key - The key of the file. Must be unique within both the Loader and the OBJ Cache.
5+
* @property {string} [url] - The absolute or relative URL to load this file from. If undefined or `null` it will be set to `<key>.obj`, i.e. if `key` was "alien" then the URL will be "alien.obj".
6+
* @property {string} [extension='obj'] - The default file extension to use if no url is provided.
7+
* @property {boolean} [flipUV] - Flip the UV coordinates stored in the model data?
8+
* @property {Phaser.Types.Loader.XHRSettingsObject} [xhrSettings] - Extra XHR Settings specifically for this file.
9+
*/

0 commit comments

Comments
 (0)