Mirrors/phaser
2
0
Fork 0
mirror of https://github.com/photonstorm/phaser synced 2024-11-24 13:43:26 +00:00
Code Issues Projects Releases Packages Wiki Activity

Testing jsdocs

Browse source
This commit is contained in:
Richard Davey 2017-09-12 00:28:53 +01:00
parent 593675d233
commit f8eecb31a9
1 changed files with 142 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -2,41 +2,132 @@ var Class = require('../utils/Class');
var Components = require('./components');
var DataProxy = require('./components/DataProxy');
/**
* The base GameObject class that all Game Objects extend.
*
* @class GameObject
*
* @param {Scene} scene - The Scene to which this Game Object belongs.
* @param {String} type - A textual representation of the Game Object.
*/
var GameObject = new Class({
initialize:
function GameObject (scene, type)
{
/**
* The Scene to which this Game Object belongs.
*
* @property
* @type {Scene}
*/
this.scene = scene;
/**
* A textual representation of this Game Object.
*
* @property
* @type {string}
*/
this.type = type;
/**
* The name of this Game Object. Blank by default and not populated by Phaser. Left for developers use.
*
* @property
* @type {String}
*/
this.name = '';
/**
* The active state of this Game Object. A Game Object with an active state of `true` is processed by the UpdateList.
*
* @property
* @type {Boolean}
*/
this.active = true;
/**
* The Tab Index of this Game Object.
*
* @property
* @type {Number}
*/
this.tabIndex = -1;
/**
* A proxy to the Data class. It allows you to store and query key/value paired information specific to this Game Object.
*
* @property
* @type {DataProxy}
*/
this.data = new DataProxy(scene, this);
// 0001 | 0010 | 0100 | 1000
// Will Render bitmask flags for the components Visible, Alpha, Transform and Texture respectively
/**
* The bitmask that determines if the Game Object will render or not.
* Structure: 0001 | 0010 | 0100 | 1000
* The components: Visible, Alpha, Transform and Texture set bits in this mask respectively
*
* @property
* @type {Number}
* @private
*/
this.renderMask = 15;
/**
* The flags that the renderMask uses to determine if the Game Object will render or not.
*
* @property
* @type {Number}
* @private
*/
this.renderFlags = 15;
/**
* A bitmask that controls if this Game Object is drawn by a Camera or not.
*
* @property
* @type {Number}
* @private
*/
this.cameraFilter = 0;
// instance of Phaser.Input.InteractiveObject if input enabled
/**
* If this Game Object is enabled for input then this property will contain a Phaser.Input.InteractiveObject reference.
*
* @property
* @type {Phaser.Input.InteractiveObject|null}
*/
this.input = null;
// instance of Phaser.Physics.X.Body if physics enabled (X = the physics system being used by the Scene)
/**
* If this Game Object is enabled for physics then this property will contain a reference to a Physics Body.
*
* @property
* @type {Phaser.Physics.Body|null}
*/
this.body = null;
// Trigger a scene z-depth sort
/**
* Should this Game Object trigger a Scene level z-depth sort?
* Automatically set by various components but can also be set manually as required.
*
* @property
* @type {Boolean}
*/
this.scene.sys.sortChildrenFlag = true;
},
// For GameObject Pooling and item selection
/**
* Sets the `active` property of this Game Object and returns this Game Object for further chaining.
*
* @method setActive
* @memberof GameObject#
*
* @param {Boolean} value - True if this Game Object should be set as active, false if not.
* @returns {this}
*/
setActive: function (value)
{
this.active = value;
@ -44,6 +135,15 @@ var GameObject = new Class({
return this;
},
/**
* Sets the `name` property of this Game Object and returns this Game Object for further chaining.
*
* @method setName
* @memberof GameObject#
*
* @param {String} value - The name to be given to this Game Object.
* @returns {this}
*/
setName: function (value)
{
this.name = value;
@ -51,6 +151,16 @@ var GameObject = new Class({
return this;
},
/**
* Pass this Game Object to the Input Manager to enable it for Input.
*
* @method setInteractive
* @memberof GameObject#
*
* @param {[type]} [shape] - A geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used.
* @param {Function} [callback] - A callback to be invoked when the Game Object is interacted with.
* @returns {this}
*/
setInteractive: function (shape, callback)
{
this.scene.sys.inputManager.enable(this, shape, callback);
@ -63,17 +173,42 @@ var GameObject = new Class({
{
},
// Can be overridden by custom Game Objects, but provides default export functionality
/**
* Returns a JSON representation of the Game Object.
*
* @method toJSON
* @memberof GameObject#
*
* @return {Object} A JSON representation of the Game Object.
*/
toJSON: function ()
{
return Components.ToJSON(this);
},
/**
* Compares the renderMask with the renderFlags to see if this Game Object will render or not.
*
* @method willRender
* @memberof GameObject#
*
* @return {Boolean} True if the Game Object should be rendered, otherwise false.
*/
willRender: function ()
{
return (this.renderMask === this.renderFlags);
},
/**
* Destroys this Game Object, removing it from the Display List and Update List.
* Also removes it from the Input and Physics Managers if enabled.
* 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
* the Game Object Pool class instead.
*
* @method destroy
* @memberof GameObject#
*/
destroy: function ()
{
this.scene.sys.displayList.remove(this);