Describe time units in Phaser.Sound

Fixes #2926
This commit is contained in:
samme 2017-01-03 12:14:00 -08:00
parent 1dc1dacb35
commit 15a695a80f
2 changed files with 7 additions and 6 deletions

View file

@ -8,6 +8,7 @@
### Updates ### Updates
* Clarification of time units in Phaser.Sound
* Clarification of `group.exists` behavior * Clarification of `group.exists` behavior
* Clarification of fixedToCamera semantics * Clarification of fixedToCamera semantics
* change Emitter.gravity from number to Phaser.Point * change Emitter.gravity from number to Phaser.Point

View file

@ -62,13 +62,13 @@ Phaser.Sound = function (game, key, volume, loop, connect) {
this.totalDuration = 0; this.totalDuration = 0;
/** /**
* @property {number} startTime - The time the Sound starts at (typically 0 unless starting from a marker) * @property {number} startTime - The time the sound starts at in ms (typically 0 unless starting from a marker).
* @default * @default
*/ */
this.startTime = 0; this.startTime = 0;
/** /**
* @property {number} currentTime - The current time the sound is at. * @property {number} currentTime - The current time of sound playback in ms.
*/ */
this.currentTime = 0; this.currentTime = 0;
@ -83,12 +83,12 @@ Phaser.Sound = function (game, key, volume, loop, connect) {
this.durationMS = 0; this.durationMS = 0;
/** /**
* @property {number} position - The position of the current sound marker. * @property {number} position - The position of the current sound marker in ms.
*/ */
this.position = 0; this.position = 0;
/** /**
* @property {number} stopTime - The time the sound stopped. * @property {number} stopTime - The time the sound stopped in ms.
*/ */
this.stopTime = 0; this.stopTime = 0;
@ -99,12 +99,12 @@ Phaser.Sound = function (game, key, volume, loop, connect) {
this.paused = false; this.paused = false;
/** /**
* @property {number} pausedPosition - The position the sound had reached when it was paused. * @property {number} pausedPosition - The position the sound had reached when it was paused in ms.
*/ */
this.pausedPosition = 0; this.pausedPosition = 0;
/** /**
* @property {number} pausedTime - The game time at which the sound was paused. * @property {number} pausedTime - The game time (ms) at which the sound was paused.
*/ */
this.pausedTime = 0; this.pausedTime = 0;