Mirrors/phaser
2
0
Fork 0
mirror of https://github.com/photonstorm/phaser synced 2025-02-25 03:47:24 +00:00
Code Issues Projects Releases Packages Wiki Activity

Added properties docs

Browse source
This commit is contained in:
Pavle Goloskokovic 2018-01-06 15:47:58 +01:00
parent dbea4d27bf
commit f76aff724d
1 changed files with 8 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
v3/src/sound/BaseSound.js
View file

@ -22,15 +22,16 @@ var BaseSound = new Class({
*/ */
this.manager = manager; this.manager = manager;
/** /**
* [description] * Asset key for the sound.
* *
* @readonly
* @property {string} key * @property {string} key
*/ */
this.key = key; this.key = key;
/** /**
* Event dispatches used to handle all sound instance * Event dispatcher used to handle all sound instance relevant events.
* relevant events.
* *
* @readonly
* @property {Phaser.Events.EventDispatcher} * @property {Phaser.Events.EventDispatcher}
*/ */
this.events = new EventDispatcher(); this.events = new EventDispatcher();
@ -53,6 +54,7 @@ var BaseSound = new Class({
* after its rate and detune values has been combined with global * after its rate and detune values has been combined with global
* rate and detune values. * rate and detune values.
* *
* @readonly
* @property {number} totalRate * @property {number} totalRate
*/ */
this.totalRate = 1; this.totalRate = 1;
@ -65,15 +67,14 @@ var BaseSound = new Class({
*/ */
this.duration = this.duration || 0; this.duration = this.duration || 0;
/** /**
* Duration of the entire sound. * The total duration of the sound in seconds.
* *
* @readonly * @readonly
* @property {number} * @property {number}
*/ */
this.totalDuration = this.totalDuration || 0; this.totalDuration = this.totalDuration || 0;
/** /**
* [description] * A config object used to store default sound settings' values.
*
* Default values will be set by properties' setters. * Default values will be set by properties' setters.
* *
* @private * @private
@ -133,7 +134,7 @@ var BaseSound = new Class({
*/ */
this.seek = 0; this.seek = 0;
/** /**
* [description] * Flag indicating whether or not the sound or current sound marker will loop.
* *
* @property {boolean} loop * @property {boolean} loop
*/ */