Mirrors/phaser
2
0
Fork 0
mirror of https://github.com/photonstorm/phaser synced 2024-11-22 20:53:39 +00:00
Code Issues Projects Releases Packages Wiki Activity

More comments work.

Browse source
This commit is contained in:
Richard Davey 2017-09-13 02:02:49 +01:00
parent 84c0f5006a
commit 3b268569f1
3 changed files with 180 additions and 131 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
v3/comments.js
View file

@ -28,6 +28,30 @@ fs.readFile(source, 'utf8', (err, data) => {
var comments = []; var comments = [];
var blocks = extract.block(data); var blocks = extract.block(data);
/*
// Example extracted docblock:
{
"type": "block",
"range": [ 1181, 1414 ],
"loc": { "start": { "line": 37, "column": 8 }, "end": { "line": 42, "column": 11 } },
"raw": "*\r\n * A textual representation of this Game Object, i.e. `sprite`.\r\n * Used internally by Phaser but is available for your own custom classes to populate.\r\n *\r\n * @property {string} type\r\n ",
"value": "\r\nA textual representation of this Game Object, i.e. `sprite`.\r\nUsed internally by Phaser but is available for your own custom classes to populate.\r\n\r\n@property {string} type",
"code": {
"context": {
"type": "property",
"receiver": "this",
"name": "type",
"value": "type",
"string": "this.type"
},
"value": "this.type = type;\r",
"line": 44,
"loc": { "start": { "line": 44, "column": 1424 }, "end": { "line": 44, "column": 1442 } }
}
},
*/
for (var i = 0; i < blocks.length; i++) for (var i = 0; i < blocks.length; i++)
{ {
var block = blocks[i]; var block = blocks[i];
@ -37,6 +61,7 @@ fs.readFile(source, 'utf8', (err, data) => {
// comments = JSON.stringify(comments); // comments = JSON.stringify(comments);
comments = beautify(comments, null, 2, 100); // just for debugging really comments = beautify(comments, null, 2, 100); // just for debugging really
// comments = beautify(blocks, null, 2, 100); // just for debugging really
fs.writeFile(dest, comments, { encoding: 'utf8', flag: 'w' }, function (error) { fs.writeFile(dest, comments, { encoding: 'utf8', flag: 'w' }, function (error) {

241
v3/docs/comments.json
View file

@ -2,12 +2,8 @@
{ {
"description": "", "description": "",
"tags": [ "tags": [
{ { "title": "author", "description": "Richard Davey <rich@phaser.io>", "lineNumber": 1 },
"title": "author", { "title": "copyright", "description": "2017 Photon Storm Ltd.", "lineNumber": 2 },
"description": "Richard Davey <rich@photonstorm.com>",
"lineNumber": 1
},
{ "title": "copyright", "description": "2016 Photon Storm Ltd.", "lineNumber": 2 },
{ {
"title": "license", "title": "license",
"description": "{@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}", "description": "{@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}",
@ -16,163 +12,156 @@
] ]
}, },
{ {
"description": "The base GameObject class that all Game Objects extend.", "description": "",
"tags": [
{ "title": "include", "description": "Class", "lineNumber": 1 },
{ "title": "include", "description": "Components", "lineNumber": 2 },
{ "title": "include", "description": "DataProxy", "lineNumber": 3 }
]
},
{
"description": "The base class that all Game Objects extend.\r\nYou don't create GameObjects directly and they cannot be added to the display list.\r\nInstead, use them as the base for your own custom classes.",
"tags": [ "tags": [
{ {
"title": "class", "title": "class",
"description": null, "description": null,
"lineNumber": 3, "lineNumber": 5,
"type": null, "type": null,
"name": "GameObject" "name": "GameObject"
}, },
{ {
"title": "namespace", "title": "namespace",
"description": null, "description": null,
"lineNumber": 4, "lineNumber": 6,
"type": null, "type": null,
"name": "Phaser.GameObjects" "name": "Phaser.GameObjects"
}, },
{ "title": "constructor", "description": null, "lineNumber": 5, "type": null, "name": null }, { "title": "constructor", "description": null, "lineNumber": 7, "type": null, "name": null },
{ {
"title": "param", "title": "param",
"description": "The Scene to which this Game Object belongs.", "description": "The Scene to which this Game Object belongs.",
"lineNumber": 7, "lineNumber": 9,
"type": { "type": "NameExpression", "name": "Scene" }, "type": { "type": "NameExpression", "name": "Phaser.Scene" },
"name": "scene" "name": "scene"
}, },
{ {
"title": "param", "title": "param",
"description": "A textual representation of the Game Object.", "description": "A textual representation of the type of Game Object, i.e. `sprite`.",
"lineNumber": 8, "lineNumber": 10,
"type": { "type": "NameExpression", "name": "String" }, "type": { "type": "NameExpression", "name": "string" },
"name": "type" "name": "type"
} }
] ]
}, },
{ {
"description": "The Scene to which this Game Object belongs.", "description": "The Scene to which this Game Object belongs.\r\nGame Objects can only belong to one Scene.",
"tags": [ "tags": [
{ {
"title": "property", "title": "property",
"description": null, "description": null,
"lineNumber": 3, "lineNumber": 4,
"type": { "type": "NameExpression", "name": "Scene" }, "type": { "type": "NameExpression", "name": "Phaser.Scene" },
"name": "scene" "name": "scene"
} }
] ]
}, },
{ {
"description": "A textual representation of this Game Object.", "description": "A textual representation of this Game Object, i.e. `sprite`.\r\nUsed internally by Phaser but is available for your own custom classes to populate.",
"tags": [ "tags": [
{ {
"title": "property", "title": "property",
"description": null, "description": null,
"lineNumber": 3, "lineNumber": 4,
"type": { "type": "NameExpression", "name": "String" }, "type": { "type": "NameExpression", "name": "string" },
"name": "type" "name": "type"
} }
] ]
}, },
{ {
"description": "The name of this Game Object. Blank by default and not populated by Phaser. Left for developers use.", "description": "The name of this Game Object.\r\nEmpty by default and never populated by Phaser, this is left for developers to use.",
"tags": [ "tags": [
{ {
"title": "property", "title": "property",
"description": null, "description": null,
"lineNumber": 3, "lineNumber": 4,
"type": { "type": "OptionalType", "expression": { "type": "NameExpression", "name": "String" } }, "type": { "type": "OptionalType", "expression": { "type": "NameExpression", "name": "string" } },
"name": "name", "name": "name",
"default": "''" "default": "''"
} }
] ]
}, },
{ {
"description": "The active state of this Game Object. A Game Object with an active state of `true` is processed by the UpdateList.", "description": "The active state of this Game Object.\r\nA Game Object with an active state of `true` is processed by the Scenes UpdateList, if added to it.",
"tags": [ "tags": [
{ {
"title": "property", "title": "property",
"description": null, "description": null,
"lineNumber": 3, "lineNumber": 4,
"type": { "type": "OptionalType", "expression": { "type": "NameExpression", "name": "Boolean" } }, "type": { "type": "OptionalType", "expression": { "type": "NameExpression", "name": "boolean" } },
"name": "active", "name": "active",
"default": "true" "default": "true"
} }
] ]
}, },
{ {
"description": "The Tab Index of this Game Object.", "description": "The Tab Index of the Game Object.\r\nReserved for future use by plugins and the Input Manager.",
"tags": [ "tags": [
{ {
"title": "property", "title": "property",
"description": null, "description": null,
"lineNumber": 3, "lineNumber": 4,
"type": { "type": "OptionalType", "expression": { "type": "NameExpression", "name": "Integer" } }, "type": { "type": "OptionalType", "expression": { "type": "NameExpression", "name": "integer" } },
"name": "tabIndex", "name": "tabIndex",
"default": "-1" "default": "-1"
} }
] ]
}, },
{ {
"description": "A proxy to the Data class. It allows you to store and query key/value paired information specific to this Game Object.", "description": "A proxy to the Data class.\r\nIt allows you to store, query and get key/value paired information specific to this Game Object.",
"tags": [ "tags": [
{ {
"title": "property", "title": "property",
"description": null, "description": null,
"lineNumber": 3, "lineNumber": 4,
"type": { "type": "NameExpression", "name": "DataProxy" }, "type": { "type": "NameExpression", "name": "DataProxy" },
"name": "data" "name": "data"
} }
] ]
}, },
{ {
"description": "The bitmask that determines if the Game Object will render or not.\r\nStructure: 0001 | 0010 | 0100 | 1000\r\nThe components: Visible, Alpha, Transform and Texture set bits in this mask respectively", "description": "The flags that are compared against `RENDER_MASK` to determine if this Game Object will render or not.\r\nThe bits are 0001 | 0010 | 0100 | 1000 set by the components Visible, Alpha, Transform and Texture respectively.\r\nIf those components are not used by your custom class then you can use this bitmask as you wish.",
"tags": [ "tags": [
{ {
"title": "property", "title": "property",
"description": null, "description": null,
"lineNumber": 5, "lineNumber": 5,
"type": { "type": "OptionalType", "expression": { "type": "NameExpression", "name": "Integer" } }, "type": { "type": "OptionalType", "expression": { "type": "NameExpression", "name": "integer" } },
"name": "renderMask",
"default": "15"
},
{ "title": "private", "description": null, "lineNumber": 6 }
]
},
{
"description": "The flags that the renderMask uses to determine if the Game Object will render or not.",
"tags": [
{
"title": "property",
"description": null,
"lineNumber": 3,
"type": { "type": "OptionalType", "expression": { "type": "NameExpression", "name": "Integer" } },
"name": "renderFlags", "name": "renderFlags",
"default": "15" "default": "15"
}, }
{ "title": "private", "description": null, "lineNumber": 4 }
] ]
}, },
{ {
"description": "A bitmask that controls if this Game Object is drawn by a Camera or not.", "description": "A bitmask that controls if this Game Object is drawn by a Camera or not.\r\nNot usually set directly. Instead call `Camera.ignore`.",
"tags": [ "tags": [
{ {
"title": "property", "title": "property",
"description": null, "description": null,
"lineNumber": 3, "lineNumber": 4,
"type": { "type": "OptionalType", "expression": { "type": "NameExpression", "name": "Number" } }, "type": { "type": "OptionalType", "expression": { "type": "NameExpression", "name": "number" } },
"name": "cameraFilter", "name": "cameraFilter",
"default": "0" "default": "0"
}, },
{ "title": "private", "description": null, "lineNumber": 4 } { "title": "see", "description": "Phaser.Cameras.Camera.ignore", "lineNumber": 5 }
] ]
}, },
{ {
"description": "If this Game Object is enabled for input then this property will contain a Phaser.Input.InteractiveObject reference.", "description": "If this Game Object is enabled for input then this property will contain an InteractiveObject instance.\r\nNot usually set directly. Instead call `GameObject.setInteractive()`.",
"tags": [ "tags": [
{ {
"title": "property", "title": "property",
"description": null, "description": null,
"lineNumber": 3, "lineNumber": 4,
"type": { "type": {
"type": "OptionalType", "type": "OptionalType",
"expression": { "expression": {
@ -185,7 +174,8 @@
}, },
"name": "input", "name": "input",
"default": "null" "default": "null"
} },
{ "title": "see", "description": "setInteractive", "lineNumber": 5 }
] ]
}, },
{ {
@ -211,69 +201,16 @@
] ]
}, },
{ {
"description": "Sets the `active` property of this Game Object and returns this Game Object for further chaining.", "description": "Sets the `active` property of this Game Object and returns this Game Object for further chaining.\r\nA Game Object with its `active` property set to `true` will be updated by the Scenes UpdateList.",
"tags": [ "tags": [
{ "title": "method", "description": null, "lineNumber": 3, "name": "GameObject#setActive" }, { "title": "method", "description": null, "lineNumber": 4, "name": "setActive" },
{ {
"title": "param", "title": "param",
"description": "True if this Game Object should be set as active, false if not.", "description": "True if this Game Object should be set as active, false if not.",
"lineNumber": 5, "lineNumber": 6,
"type": { "type": "NameExpression", "name": "Boolean" }, "type": { "type": "NameExpression", "name": "boolean" },
"name": "value" "name": "value"
}, },
{
"title": "return",
"description": "This GameObject.",
"lineNumber": 6,
"type": { "type": "NameExpression", "name": "GameObject" }
}
]
},
{
"description": "Sets the `name` property of this Game Object and returns this Game Object for further chaining.",
"tags": [
{ "title": "method", "description": null, "lineNumber": 3, "name": "GameObject#setName" },
{
"title": "param",
"description": "The name to be given to this Game Object.",
"lineNumber": 5,
"type": { "type": "NameExpression", "name": "String" },
"name": "value"
},
{
"title": "return",
"description": "This GameObject.",
"lineNumber": 6,
"type": { "type": "NameExpression", "name": "GameObject" }
}
]
},
{
"description": "Pass this Game Object to the Input Manager to enable it for Input.",
"tags": [
{
"title": "method",
"description": null,
"lineNumber": 3,
"name": "GameObject#setInteractive"
},
{
"title": "param",
"description": "A geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used.",
"lineNumber": 5,
"type": {
"type": "OptionalType",
"expression": { "type": "ArrayType", "elements": [ { "type": "NameExpression", "name": "type" } ] }
},
"name": "shape"
},
{
"title": "param",
"description": "A callback to be invoked when the Game Object is interacted with.",
"lineNumber": 6,
"type": { "type": "OptionalType", "expression": { "type": "NameExpression", "name": "Function" } },
"name": "callback"
},
{ {
"title": "return", "title": "return",
"description": "This GameObject.", "description": "This GameObject.",
@ -282,32 +219,98 @@
} }
] ]
}, },
{
"description": "Sets the `name` property of this Game Object and returns this Game Object for further chaining.\r\nThe `name` property is not populated by Phaser and is presented for your own use.",
"tags": [
{ "title": "example", "description": "game objects/image/set name.js", "lineNumber": 4 },
{ "title": "tutorial", "description": "game objects/basics", "lineNumber": 5 },
{ "title": "method", "description": null, "lineNumber": 7, "name": "setName" },
{
"title": "param",
"description": "The name to be given to this Game Object.",
"lineNumber": 9,
"type": { "type": "NameExpression", "name": "string" },
"name": "value"
},
{
"title": "return",
"description": "This GameObject.",
"lineNumber": 10,
"type": { "type": "NameExpression", "name": "GameObject" }
}
]
},
{
"description": "Pass this Game Object to the Input Manager to enable it for Input.",
"tags": [
{
"title": "example",
"description": "game objects/image/set interactive.js",
"lineNumber": 3
},
{ "title": "tutorial", "description": "input/basics", "lineNumber": 4 },
{ "title": "method", "description": null, "lineNumber": 6, "name": "setInteractive" },
{
"title": "param",
"description": "A geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used.",
"lineNumber": 8,
"type": { "type": "OptionalType", "expression": { "type": "NameExpression", "name": "any" } },
"name": "shape"
},
{
"title": "param",
"description": "A callback to be invoked when the Game Object is interacted with.",
"lineNumber": 9,
"type": { "type": "OptionalType", "expression": { "type": "NameExpression", "name": "function" } },
"name": "callback"
},
{
"title": "return",
"description": "This GameObject.",
"lineNumber": 10,
"type": { "type": "NameExpression", "name": "GameObject" }
}
]
},
{ {
"description": "Returns a JSON representation of the Game Object.", "description": "Returns a JSON representation of the Game Object.",
"tags": [ "tags": [
{ "title": "method", "description": null, "lineNumber": 3, "name": "GameObject#toJSON" }, { "title": "method", "description": null, "lineNumber": 3, "name": "toJSON" },
{ {
"title": "return", "title": "return",
"description": "A JSON representation of the Game Object.", "description": "A JSON representation of the Game Object.",
"lineNumber": 5, "lineNumber": 5,
"type": { "type": "NameExpression", "name": "Object" } "type": { "type": "NameExpression", "name": "object" }
} }
] ]
}, },
{ {
"description": "Compares the renderMask with the renderFlags to see if this Game Object will render or not.", "description": "Compares the renderMask with the renderFlags to see if this Game Object will render or not.",
"tags": [ "tags": [
{ "title": "method", "description": null, "lineNumber": 3, "name": "GameObject#willRender" }, { "title": "method", "description": null, "lineNumber": 3, "name": "willRender" },
{ {
"title": "return", "title": "return",
"description": "True if the Game Object should be rendered, otherwise false.", "description": "True if the Game Object should be rendered, otherwise false.",
"lineNumber": 5, "lineNumber": 5,
"type": { "type": "NameExpression", "name": "Boolean" } "type": { "type": "NameExpression", "name": "boolean" }
} }
] ]
}, },
{ {
"description": "Destroys this Game Object, removing it from the Display List and Update List.\r\nAlso removes it from the Input and Physics Managers if enabled.\r\nSets the active state to `false`. Use this to remove a Game Object from your game if\r\nyou don't plan to use it again later. If you do wish to use it later then look at using\r\nthe Game Object Pool class instead.", "description": "Destroys this Game Object, removing it from the Display List and Update List.\r\nAlso removes it from the Input and Physics Managers if enabled.\r\nSets the active state to `false`. Use this to remove a Game Object from your game if\r\nyou don't plan to use it again later. If you do wish to use it later then look at using\r\nthe Game Object Pool class instead.",
"tags": [ { "title": "method", "description": null, "lineNumber": 7, "name": "GameObject#destroy" } ] "tags": [ { "title": "method", "description": null, "lineNumber": 7, "name": "destroy" } ]
},
{
"description": "The bitmask that `GameObject.renderFlags` is compared against to determine if the Game Object will render or not.",
"tags": [
{
"title": "constant",
"description": null,
"lineNumber": 3,
"type": { "type": "NameExpression", "name": "integer" },
"name": "RENDER_MASK"
},
{ "title": "default", "description": null, "lineNumber": 4 }
]
} }
] ]

45
v3/src/gameobjects/GameObject.js
View file

@ -31,6 +31,7 @@ var GameObject = new Class({
* Game Objects can only belong to one Scene. * Game Objects can only belong to one Scene.
* *
* @property {Phaser.Scene} scene * @property {Phaser.Scene} scene
* @protected
*/ */
this.scene = scene; this.scene = scene;
@ -53,6 +54,7 @@ var GameObject = new Class({
/** /**
* The active state of this Game Object. * The active state of this Game Object.
* A Game Object with an active state of `true` is processed by the Scenes UpdateList, if added to it. * A Game Object with an active state of `true` is processed by the Scenes UpdateList, if added to it.
* An active object is one which is having its logic and internal systems updated.
* *
* @property {boolean} [active=true] * @property {boolean} [active=true]
*/ */
@ -75,27 +77,29 @@ var GameObject = new Class({
this.data = new DataProxy(scene, this); this.data = new DataProxy(scene, this);
/** /**
* The flags that the renderMask uses to determine if the Game Object will render or not. * The flags that are compared against `RENDER_MASK` to determine if this Game Object will render or not.
* Structure: 0001 | 0010 | 0100 | 1000 * The bits are 0001 | 0010 | 0100 | 1000 set by the components Visible, Alpha, Transform and Texture respectively.
* The components Visible, Alpha, Transform and Texture set the bits in this mask respectively * If those components are not used by your custom class then you can use this bitmask as you wish.
* *
* @property {integer} [renderFlags=15] * @property {integer} [renderFlags=15]
* @private
*/ */
this.renderFlags = 15; this.renderFlags = 15;
/** /**
* A bitmask that controls if this Game Object is drawn by a Camera or not. * A bitmask that controls if this Game Object is drawn by a Camera or not.
* Not usually set directly. Instead call `Camera.ignore`.
* *
* @property {number} [cameraFilter=0] * @property {number} [cameraFilter=0]
* @private * @see Phaser.Cameras.Camera.ignore
*/ */
this.cameraFilter = 0; this.cameraFilter = 0;
/** /**
* If this Game Object is enabled for input then this property will contain a Phaser.Input.InteractiveObject reference. * If this Game Object is enabled for input then this property will contain an InteractiveObject instance.
* Not usually set directly. Instead call `GameObject.setInteractive()`.
* *
* @property {Phaser.Input.InteractiveObject|null} [input=null] * @property {Phaser.Input.InteractiveObject|null} [input=null]
* @see setInteractive
*/ */
this.input = null; this.input = null;
@ -112,6 +116,7 @@ var GameObject = new Class({
/** /**
* Sets the `active` property of this Game Object and returns this Game Object for further chaining. * Sets the `active` property of this Game Object and returns this Game Object for further chaining.
* A Game Object with its `active` property set to `true` will be updated by the Scenes UpdateList.
* *
* @method setActive * @method setActive
* *
@ -127,6 +132,10 @@ var GameObject = new Class({
/** /**
* Sets the `name` property of this Game Object and returns this Game Object for further chaining. * Sets the `name` property of this Game Object and returns this Game Object for further chaining.
* The `name` property is not populated by Phaser and is presented for your own use.
*
* @example game objects/image/set name.js
* @tutorial game objects/basics
* *
* @method setName * @method setName
* *
@ -143,6 +152,9 @@ var GameObject = new Class({
/** /**
* Pass this Game Object to the Input Manager to enable it for Input. * Pass this Game Object to the Input Manager to enable it for Input.
* *
* @example game objects/image/set interactive.js
* @tutorial input/basics
*
* @method setInteractive * @method setInteractive
* *
* @param {any} [shape] - A geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used. * @param {any} [shape] - A geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used.
@ -186,11 +198,17 @@ var GameObject = new Class({
}, },
/** /**
* Destroys this Game Object, removing it from the Display List and Update List. * Destroys this Game Object removing it from the Display List and Update List and
* Also removes it from the Input and Physics Managers if enabled. * severing all ties to parent resources.
* Sets the active state to `false`. Use this to remove a Game Object from your game if *
* you don't plan to use it again later. If you do wish to use it later then look at using * Also removes itself from the Input Manager and Physics Manager if previously enabled.
* the Game Object Pool class instead. *
* Use this to remove a Game Object from your game if you don't ever plan to use it again.
* As long as no reference to it exists within your own code it should become free for
* garbage collection by the browser.
*
* If you just want to temporarily disable an object then look at using the
* Game Object Pool instead of destroying it, as destroyed objects cannot be resurrected.
* *
* @method destroy * @method destroy
*/ */
@ -211,6 +229,8 @@ var GameObject = new Class({
this.active = false; this.active = false;
this.data = undefined;
this.scene = undefined; this.scene = undefined;
} }
@ -219,7 +239,8 @@ var GameObject = new Class({
/** /**
* The bitmask that `GameObject.renderFlags` is compared against to determine if the Game Object will render or not. * The bitmask that `GameObject.renderFlags` is compared against to determine if the Game Object will render or not.
* *
* @constant {integer} [RENDER_MASK=15] * @constant {integer} RENDER_MASK
* @default
*/ */
GameObject.RENDER_MASK = 15; GameObject.RENDER_MASK = 15;