This commit is contained in:
Richard Davey 2020-08-20 10:22:43 +01:00
commit 50c629dca8
3 changed files with 12 additions and 11 deletions

View file

@ -1022,9 +1022,9 @@ var Text = new Class({
* @since 3.0.0 * @since 3.0.0
* *
* @param {(number|Phaser.Types.GameObjects.Text.TextPadding)} left - The left padding value, or a padding config object. * @param {(number|Phaser.Types.GameObjects.Text.TextPadding)} left - The left padding value, or a padding config object.
* @param {number} top - The top padding value. * @param {number} [top] - The top padding value.
* @param {number} right - The right padding value. * @param {number} [right] - The right padding value.
* @param {number} bottom - The bottom padding value. * @param {number} [bottom] - The bottom padding value.
* *
* @return {this} This Text object. * @return {this} This Text object.
*/ */

View file

@ -7,6 +7,7 @@
* @property {string} [fontFamily='Courier'] - The font the Text object will render with. This is a Canvas style font string. * @property {string} [fontFamily='Courier'] - The font the Text object will render with. This is a Canvas style font string.
* @property {string} [fontSize='16px'] - The font size, as a CSS size string. * @property {string} [fontSize='16px'] - The font size, as a CSS size string.
* @property {string} [fontStyle] - Any addition font styles, such as 'strong'. * @property {string} [fontStyle] - Any addition font styles, such as 'strong'.
* @property {string} [font] - The font family or font settings to set. Overrides the other font settings.
* @property {string} [backgroundColor] - A solid fill color that is rendered behind the Text object. Given as a CSS string color such as `#ff0`. * @property {string} [backgroundColor] - A solid fill color that is rendered behind the Text object. Given as a CSS string color such as `#ff0`.
* @property {string} [color='#fff'] - The color the Text is drawn in. Given as a CSS string color such as `#fff` or `rgb()`. * @property {string} [color='#fff'] - The color the Text is drawn in. Given as a CSS string color such as `#fff` or `rgb()`.
* @property {string} [stroke='#fff'] - The color used to stroke the Text if the `strokeThickness` property is greater than zero. * @property {string} [stroke='#fff'] - The color used to stroke the Text if the `strokeThickness` property is greater than zero.

View file

@ -11,7 +11,7 @@ var Events = require('./events');
/** /**
* @classdesc * @classdesc
* A Process Queue maintains three internal lists. * A Process Queue maintains three internal lists.
* *
* The `pending` list is a selection of items which are due to be made 'active' in the next update. * The `pending` list is a selection of items which are due to be made 'active' in the next update.
* The `active` list is a selection of items which are considered active and should be updated. * The `active` list is a selection of items which are considered active and should be updated.
* The `destroy` list is a selection of items that were active and are awaiting being destroyed in the next update. * The `destroy` list is a selection of items that were active and are awaiting being destroyed in the next update.
@ -92,7 +92,7 @@ var ProcessQueue = new Class({
/** /**
* Adds a new item to the Process Queue. * Adds a new item to the Process Queue.
* *
* The item is added to the pending list and made active in the next update. * The item is added to the pending list and made active in the next update.
* *
* @method Phaser.Structs.ProcessQueue#add * @method Phaser.Structs.ProcessQueue#add
@ -116,7 +116,7 @@ var ProcessQueue = new Class({
/** /**
* Removes an item from the Process Queue. * Removes an item from the Process Queue.
* *
* The item is added to the pending destroy and fully removed in the next update. * The item is added to the pending destroy and fully removed in the next update.
* *
* @method Phaser.Structs.ProcessQueue#remove * @method Phaser.Structs.ProcessQueue#remove
@ -140,7 +140,7 @@ var ProcessQueue = new Class({
/** /**
* Removes all active items from this Process Queue. * Removes all active items from this Process Queue.
* *
* All the items are marked as 'pending destroy' and fully removed in the next update. * All the items are marked as 'pending destroy' and fully removed in the next update.
* *
* @method Phaser.Structs.ProcessQueue#removeAll * @method Phaser.Structs.ProcessQueue#removeAll
@ -166,7 +166,7 @@ var ProcessQueue = new Class({
/** /**
* Update this queue. First it will process any items awaiting destruction, and remove them. * Update this queue. First it will process any items awaiting destruction, and remove them.
* *
* Then it will check to see if there are any items pending insertion, and move them to an * Then it will check to see if there are any items pending insertion, and move them to an
* active state. Finally, it will return a list of active items for further processing. * active state. Finally, it will return a list of active items for further processing.
* *
@ -202,7 +202,7 @@ var ProcessQueue = new Class({
{ {
active.splice(idx, 1); active.splice(idx, 1);
this.emit(Events.REMOVE, item); this.emit(Events.PROCESS_QUEUE_REMOVE, item);
} }
} }
@ -219,7 +219,7 @@ var ProcessQueue = new Class({
this._active.push(item); this._active.push(item);
this.emit(Events.ADD, item); this.emit(Events.PROCESS_QUEUE_ADD, item);
} }
list.length = 0; list.length = 0;
@ -232,7 +232,7 @@ var ProcessQueue = new Class({
/** /**
* Returns the current list of active items. * Returns the current list of active items.
* *
* This method returns a reference to the active list array, not a copy of it. * This method returns a reference to the active list array, not a copy of it.
* Therefore, be careful to not modify this array outside of the ProcessQueue. * Therefore, be careful to not modify this array outside of the ProcessQueue.
* *