@vpmedia/phaser 1.15.0 → 1.17.0

package/src/phaser/core/array_set.js

@@ -1,14 +1,18 @@
-/**
- * @copyright    Copyright (c) 2018-present Richard Davey, Photon Storm Ltd., Andras Csizmadia <andras@vpmedia.hu> (www.vpmedia.hu)
- * @author       Andras Csizmadia <andras@vpmedia.hu>
- * @author       Richard Davey <rich@photonstorm.com>
- */
 export class ArraySet {
+  /**
+   * TBD.
+   * @param {object[]} list - TBD.
+   */
   constructor(list = []) {
     this.position = 0;
     this.list = list;
   }
 
+  /**
+   * TBD.
+   * @param {object} item - TBD.
+   * @returns {object} TBD.
+   */
   add(item) {
     if (!this.exists(item)) {
       this.list.push(item);
@@ -16,10 +20,21 @@ export class ArraySet {
     return item;
   }
 
+  /**
+   * TBD.
+   * @param {object} item - TBD.
+   * @returns {number} TBD.
+   */
   getIndex(item) {
     return this.list.indexOf(item);
   }
 
+  /**
+   * TBD.
+   * @param {string} property - TBD.
+   * @param {object} value - TBD.
+   * @returns {object} TBD.
+   */
   getByKey(property, value) {
     let i = this.list.length;
     while (i) {
@@ -31,14 +46,27 @@ export class ArraySet {
     return null;
   }
 
+  /**
+   * TBD.
+   * @param {object} item - TBD.
+   * @returns {boolean} TBD.
+   */
   exists(item) {
     return this.list.indexOf(item) > -1;
   }
 
+  /**
+   * TBD.
+   */
   reset() {
     this.list.length = 0;
   }
 
+  /**
+   * TBD.
+   * @param {object} item - TBD.
+   * @returns {object} TBD.
+   */
   remove(item) {
     const idx = this.list.indexOf(item);
     if (idx > -1) {
@@ -48,6 +76,11 @@ export class ArraySet {
     return null;
   }
 
+  /**
+   * TBD.
+   * @param {string} key - TBD.
+   * @param {object} value - TBD.
+   */
   setAll(key, value) {
     let i = this.list.length;
     while (i) {
@@ -58,6 +91,11 @@ export class ArraySet {
     }
   }
 
+  /**
+   * TBD.
+   * @param {string} key - TBD.
+   * @param {...any} args - TBD.
+   */
   callAll(key, ...args) {
     let i = this.list.length;
     while (i) {
@@ -68,6 +106,10 @@ export class ArraySet {
     }
   }
 
+  /**
+   * TBD.
+   * @param {boolean} destroy - TBD.
+   */
   removeAll(destroy = false) {
     let i = this.list.length;
     while (i) {
@@ -83,10 +125,18 @@ export class ArraySet {
     this.list = [];
   }
 
+  /**
+   * TBD.
+   * @returns {number} TBD.
+   */
   get total() {
     return this.list.length;
   }
 
+  /**
+   * TBD.
+   * @returns {object} TBD.
+   */
   get first() {
     this.position = 0;
     if (this.list.length > 0) {
@@ -95,6 +145,10 @@ export class ArraySet {
     return null;
   }
 
+  /**
+   * TBD.
+   * @returns {object} TBD.
+   */
   get next() {
     if (this.position < this.list.length) {
       this.position += 1;