Skip to content

Commit ae45aff

Browse files
committed
More JSDocs work - this time to massive game config!
1 parent 99954c5 commit ae45aff

1 file changed

Lines changed: 62 additions & 1 deletion

File tree

v3/src/boot/Config.js

Lines changed: 62 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,71 @@ var MATH = require('../math/const');
55
var NOOP = require('../utils/NOOP');
66
var ValueToColor = require('../graphics/color/ValueToColor');
77

8+
/**
9+
* This callback type is completely empty, a no-operation.
10+
*
11+
* @callback NOOP
12+
*/
13+
814
var Config = new Class({
915

1016
initialize:
1117

18+
/**
19+
* [description]
20+
*
21+
* @class Config
22+
* @memberOf Phaser.Boot
23+
* @constructor
24+
* @since 3.0.0
25+
*
26+
* @todo Add Physics Config
27+
*
28+
* @param {object} [config] - The configuration object for your Phaser Game instance.
29+
* @param {integer|string} [config.width=1024] - [description]
30+
* @param {integer|string} [config.height=768] - [description]
31+
* @param {number} [config.zoom=1] - [description]
32+
* @param {number} [config.resolution=1] - [description]
33+
* @param {number} [config.type=CONST.AUTO] - [description]
34+
* @param {object} [?config.parent=null] - [description]
35+
* @param {HTMLCanvasElement} [?config.canvas=null] - [description]
36+
* @param {string} [?config.canvasStyle=null] - [description]
37+
* @param {object} [?config.scene=null] - [description]
38+
* @param {array} [config.seed] - [description]
39+
* @param {string} [config.title=''] - [description]
40+
* @param {string} [config.url='http://phaser.io'] - [description]
41+
* @param {string} [config.version=''] - [description]
42+
* @param {object} [config.input] - [description]
43+
* @param {boolean} [config.input.keyboard=true] - [description]
44+
* @param {object} [config.input.keyboard.target=window] - [description]
45+
* @param {boolean} [config.input.mouse=true] - [description]
46+
* @param {object} [?config.input.mouse.target=null] - [description]
47+
* @param {boolean} [config.input.touch=true] - [description]
48+
* @param {object} [?config.input.touch.target=null] - [description]
49+
* @param {boolean} [config.input.gamepad=false] - [description]
50+
* @param {boolean} [config.disableContextMenu=false] - [description]
51+
* @param {boolean} [config.banner=false] - [description]
52+
* @param {boolean} [config.banner.hidePhaser=false] - [description]
53+
* @param {string} [config.banner.text='#ffffff'] - [description]
54+
* @param {array} [config.banner.background] - [description]
55+
* @param {object} [?config.fps] - [description]
56+
* @param {integer} [config.fps.min=10] - [description]
57+
* @param {integer} [config.fps.target=60] - [description]
58+
* @param {boolean} [config.fps.forceSetTimeOut=false] - [description]
59+
* @param {integer} [config.fps.deltaHistory=10] - [description]
60+
* @param {boolean} [config.pixelArt=false] - [description]
61+
* @param {boolean} [config.transparent=false] - [description]
62+
* @param {boolean} [config.clearBeforeRender=true] - [description]
63+
* @param {string|number} [config.backgroundColor=0x000000] - [description]
64+
* @param {boolean} [config.preserveDrawingBuffer=false] - [description]
65+
* @param {object} [?config.callbacks] - [description]
66+
* @param {function} [config.callbacks.preBoot=NOOP] - [description]
67+
* @param {function} [config.callbacks.postBoot=NOOP] - [description]
68+
* @param {boolean} [config.useTicker=false] - [description]
69+
* @param {object} [?config.images] - [description]
70+
* @param {string} [config.images.default] - [description]
71+
* @param {string} [config.images.missing] - [description]
72+
*/
1273
function Config (config)
1374
{
1475
if (config === undefined) { config = {}; }
@@ -80,7 +141,7 @@ var Config = new Class({
80141
this.transparent = GetValue(config, 'transparent', false);
81142
this.clearBeforeRender = GetValue(config, 'clearBeforeRender', true);
82143
this.backgroundColor = ValueToColor(GetValue(config, 'backgroundColor', 0));
83-
this.preserveDrawingBuffer = ValueToColor(GetValue(config, 'preserveDrawingBuffer', false));
144+
this.preserveDrawingBuffer = GetValue(config, 'preserveDrawingBuffer', false);
84145

85146
// Callbacks
86147
this.preBoot = GetValue(config, 'callbacks.preBoot', NOOP);

0 commit comments

Comments
 (0)