mirror of
https://github.com/photonstorm/phaser
synced 2024-11-23 05:03:37 +00:00
Finished off descriptions for Data, Plugins and Sound.
This commit is contained in:
parent
b6768f8a0f
commit
f95b35eae7
4 changed files with 13 additions and 19 deletions
|
@ -20,7 +20,7 @@ var PluginCache = require('../plugins/PluginCache');
|
|||
* @constructor
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param {Phaser.Scene} scene - [description]
|
||||
* @param {Phaser.Scene} scene - A reference to the Scene that this DataManager belongs to.
|
||||
*/
|
||||
var DataManagerPlugin = new Class({
|
||||
|
||||
|
@ -33,7 +33,7 @@ var DataManagerPlugin = new Class({
|
|||
DataManager.call(this, scene, scene.sys.events);
|
||||
|
||||
/**
|
||||
* [description]
|
||||
* The Scene that this DataManager belongs to.
|
||||
*
|
||||
* @name Phaser.Data.DataManagerPlugin#scene
|
||||
* @type {Phaser.Scene}
|
||||
|
@ -42,7 +42,7 @@ var DataManagerPlugin = new Class({
|
|||
this.scene = scene;
|
||||
|
||||
/**
|
||||
* [description]
|
||||
* The Systems of the Scene that this DataManager belongs to.
|
||||
*
|
||||
* @name Phaser.Data.DataManagerPlugin#systems
|
||||
* @type {Phaser.Scenes.Systems}
|
||||
|
|
|
@ -6,23 +6,17 @@
|
|||
|
||||
var Class = require('../utils/Class');
|
||||
|
||||
// A Scene Level Plugin is installed into every Scene and belongs to that Scene.
|
||||
// It can listen for Scene events and respond to them.
|
||||
// It can map itself to a Scene property, or into the Scene Systems, or both.
|
||||
//
|
||||
// A Global Plugin is installed just once into the Game owned Plugin Manager.
|
||||
// It can listen for Game events and respond to them.
|
||||
|
||||
/**
|
||||
* @classdesc
|
||||
* [description]
|
||||
* A Global Plugin is installed just once into the Game owned Plugin Manager.
|
||||
* It can listen for Game events and respond to them.
|
||||
*
|
||||
* @class BasePlugin
|
||||
* @memberOf Phaser.Plugins
|
||||
* @constructor
|
||||
* @since 3.8.0
|
||||
*
|
||||
* @param {Phaser.Game} game - [description]
|
||||
* @param {Phaser.Game} game - A reference to the Game instance this plugin is running under.
|
||||
*/
|
||||
var BasePlugin = new Class({
|
||||
|
||||
|
@ -33,7 +27,7 @@ var BasePlugin = new Class({
|
|||
/**
|
||||
* A handy reference to the Plugin Manager that is responsible for this plugin.
|
||||
* Can be used as a route to gain access to game systems and events.
|
||||
*
|
||||
*
|
||||
* @name Phaser.Plugins.BasePlugin#pluginManager
|
||||
* @type {Phaser.Plugins.PluginManager}
|
||||
* @protected
|
||||
|
|
|
@ -19,7 +19,7 @@ var Class = require('../utils/Class');
|
|||
* @constructor
|
||||
* @since 3.8.0
|
||||
*
|
||||
* @param {Phaser.Game} game - [description]
|
||||
* @param {Phaser.Game} game - A reference to the Scene that has installed this plugin.
|
||||
*/
|
||||
var ScenePlugin = new Class({
|
||||
|
||||
|
|
|
@ -13,10 +13,10 @@ var NOOP = require('../utils/NOOP');
|
|||
/**
|
||||
* @callback EachActiveSoundCallback
|
||||
*
|
||||
* @param {Phaser.Sound.BaseSoundManager} manager - [description]
|
||||
* @param {Phaser.Sound.BaseSound} sound - [description]
|
||||
* @param {number} index - [description]
|
||||
* @param {Phaser.Sound.BaseSound[]} sounds - [description]
|
||||
* @param {Phaser.Sound.BaseSoundManager} manager - The SoundManager
|
||||
* @param {Phaser.Sound.BaseSound} sound - The active Sound
|
||||
* @param {number} index - The index
|
||||
* @param {Phaser.Sound.BaseSound[]} sounds - All sounds
|
||||
*/
|
||||
|
||||
/**
|
||||
|
@ -527,7 +527,7 @@ var BaseSoundManager = new Class({
|
|||
* @private
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param {EachActiveSoundCallback} callback - Callback function. (sound: ISound, index: number, array: ISound[]) => void
|
||||
* @param {EachActiveSoundCallback} callback - Callback function. (manager: Phaser.Sound.BaseSoundManager, sound: Phaser.Sound.BaseSound, index: number, sounds: Phaser.Manager.BaseSound[]) => void
|
||||
* @param {*} [scope] - Callback context.
|
||||
*/
|
||||
forEachActiveSound: function (callback, scope)
|
||||
|
|
Loading…
Reference in a new issue