mirror of
https://github.com/photonstorm/phaser
synced 2024-11-22 12:43:26 +00:00
Fix "object" types on Sound and Time
This commit is contained in:
parent
dcd80375c0
commit
90cf919b10
5 changed files with 23 additions and 9 deletions
|
@ -203,10 +203,10 @@ var BaseSound = new Class({
|
|||
this.config = Extend(this.config, config);
|
||||
|
||||
/**
|
||||
* Object containing markers definitions (Object.<string, SoundMarker>).
|
||||
* Object containing markers definitions.
|
||||
*
|
||||
* @name Phaser.Sound.BaseSound#markers
|
||||
* @type {object}
|
||||
* @type {Object.<string, SoundMarker>}
|
||||
* @default {}
|
||||
* @readOnly
|
||||
* @since 3.0.0
|
||||
|
|
|
@ -477,7 +477,7 @@ var BaseSoundManager = new Class({
|
|||
* @since 3.0.0
|
||||
*
|
||||
* @param {EachActiveSoundCallback} callback - Callback function. (sound: ISound, index: number, array: ISound[]) => void
|
||||
* @param {object} [scope] - Callback context.
|
||||
* @param {*} [scope] - Callback context.
|
||||
*/
|
||||
forEachActiveSound: function (callback, scope)
|
||||
{
|
||||
|
|
|
@ -136,7 +136,7 @@ var Clock = new Class({
|
|||
* @method Phaser.Time.Clock#addEvent
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param {object} config - [description]
|
||||
* @param {TimerEventConfig} config - [description]
|
||||
*
|
||||
* @return {Phaser.Time.TimerEvent} [description]
|
||||
*/
|
||||
|
@ -157,8 +157,8 @@ var Clock = new Class({
|
|||
*
|
||||
* @param {number} delay - [description]
|
||||
* @param {function} callback - [description]
|
||||
* @param {array} args - [description]
|
||||
* @param {object} callbackScope - [description]
|
||||
* @param {*[]} args - [description]
|
||||
* @param {*} callbackScope - [description]
|
||||
*
|
||||
* @return {Phaser.Time.TimerEvent} [description]
|
||||
*/
|
||||
|
|
|
@ -7,6 +7,20 @@
|
|||
var Class = require('../utils/Class');
|
||||
var GetFastValue = require('../utils/object/GetFastValue');
|
||||
|
||||
/**
|
||||
* @typedef {object} TimerEventConfig
|
||||
*
|
||||
* @property {number} [delay=0] - [description]
|
||||
* @property {number} [repeat=0] - [description]
|
||||
* @property {boolean} [loop=false] - [description]
|
||||
* @property {function} [callback] - [description]
|
||||
* @property {*} [callbackScope] - [description]
|
||||
* @property {*[]} [args] - [description]
|
||||
* @property {number} [timeScale=1] - [description]
|
||||
* @property {number} [startAt=1] - [description]
|
||||
* @property {boolean} [paused=false] - [description]
|
||||
*/
|
||||
|
||||
/**
|
||||
* @classdesc
|
||||
* [description]
|
||||
|
@ -16,7 +30,7 @@ var GetFastValue = require('../utils/object/GetFastValue');
|
|||
* @constructor
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param {object} config - [description]
|
||||
* @param {TimerEventConfig} config - [description]
|
||||
*/
|
||||
var TimerEvent = new Class({
|
||||
|
||||
|
@ -153,7 +167,7 @@ var TimerEvent = new Class({
|
|||
* @method Phaser.Time.TimerEvent#reset
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param {object} config - [description]
|
||||
* @param {TimerEventConfig} config - [description]
|
||||
*
|
||||
* @return {Phaser.Time.TimerEvent} This TimerEvent object.
|
||||
*/
|
||||
|
|
|
@ -16,7 +16,7 @@
|
|||
*
|
||||
* @param {object} source - [description]
|
||||
* @param {string} key - [description]
|
||||
* @param {*} defaultValue - [description]
|
||||
* @param {*} [defaultValue] - [description]
|
||||
*
|
||||
* @return {*} [description]
|
||||
*/
|
||||
|
|
Loading…
Reference in a new issue