custom-pixi-particles 4.0.20 → 4.0.22

package/dist/lib/util/Point.js

@@ -1,18 +1,39 @@
 export default class Point {
     constructor(x, y) {
+        /**
+         * Sets the x and y coordinates of a Point
+         * @param {number} x - The x coordinate
+         * @param {number} y - The y coordinate
+         * @return {Point} - The Point instance
+         */
         this.set = (x, y) => {
             this.x = x;
             this.y = y === undefined ? this.y : y;
             return this;
         };
+        /**
+         * Copies the x and y coordinates from another Point
+         * @param {IPoint} point - The Point instance to copy from
+         * @return {Point} - The Point instance
+         */
         this.copyFrom = (point) => {
             this.x = point.x;
             this.y = point.y;
             return this;
         };
+        /**
+         * Copies the x and y coordinates from an object with numeric x and y properties
+         * @param {IPoint} data - The object to copy from
+         * @return {Point} - The Point instance
+         */
         this.copyFromRawData = (data) => {
             this.copyFrom(data);
         };
+        /**
+         * Adds the x and y coordinates of another Point to this Point
+         * @param {IPoint} point - The other Point instance
+         * @return {Point} - The Point instance
+         */
         this.add = (point) => {
             this.x += point.x;
             this.y += point.y;

package/dist/lib/util/Point.js.map

@@ -1 +1 @@
-{"version":3,"file":"Point.js","sourceRoot":"","sources":["../../../src/lib/util/Point.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,OAAO,OAAO,KAAK;IAIxB,YAAY,CAAU,EAAE,CAAU;QAKlC,QAAG,GAAG,CAAC,CAAS,EAAE,CAAS,EAAE,EAAE;YAC7B,IAAI,CAAC,CAAC,GAAG,CAAC,CAAA;YACV,IAAI,CAAC,CAAC,GAAG,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;YACrC,OAAO,IAAI,CAAA;QACb,CAAC,CAAA;QAED,aAAQ,GAAG,CAAC,KAAa,EAAE,EAAE;YAC3B,IAAI,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAA;YAChB,IAAI,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAA;YAChB,OAAO,IAAI,CAAA;QACb,CAAC,CAAA;QAED,oBAAe,GAAG,CAAC,IAAY,EAAE,EAAE;YACjC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAA;QACrB,CAAC,CAAA;QAED,QAAG,GAAG,CAAC,KAAa,EAAE,EAAE;YACtB,IAAI,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,CAAA;YACjB,IAAI,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,CAAA;YACjB,OAAO,IAAI,CAAA;QACb,CAAC,CAAA;QAxBC,IAAI,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;QACf,IAAI,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;IACjB,CAAC;CAuBF"}
+{"version":3,"file":"Point.js","sourceRoot":"","sources":["../../../src/lib/util/Point.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,OAAO,OAAO,KAAK;IAIxB,YAAY,CAAU,EAAE,CAAU;QAKlC;;;;;WAKG;QACH,QAAG,GAAG,CAAC,CAAS,EAAE,CAAS,EAAE,EAAE;YAC7B,IAAI,CAAC,CAAC,GAAG,CAAC,CAAA;YACV,IAAI,CAAC,CAAC,GAAG,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;YACrC,OAAO,IAAI,CAAA;QACb,CAAC,CAAA;QAED;;;;WAIG;QACH,aAAQ,GAAG,CAAC,KAAa,EAAE,EAAE;YAC3B,IAAI,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAA;YAChB,IAAI,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAA;YAChB,OAAO,IAAI,CAAA;QACb,CAAC,CAAA;QAED;;;;WAIG;QACH,oBAAe,GAAG,CAAC,IAAY,EAAE,EAAE;YACjC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAA;QACrB,CAAC,CAAA;QAED;;;;WAIG;QACH,QAAG,GAAG,CAAC,KAAa,EAAE,EAAE;YACtB,IAAI,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,CAAA;YACjB,IAAI,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,CAAA;YACjB,OAAO,IAAI,CAAA;QACb,CAAC,CAAA;QA7CC,IAAI,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;QACf,IAAI,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;IACjB,CAAC;CA4CF"}

package/dist/lib/util/Random.d.ts

@@ -1,4 +1,24 @@
+/**
+ * @class Random
+ *
+ * @description This class provides methods to generate random numbers.
+ */
 export default class Random {
+    /**
+     * @static
+     * @method get
+     * @returns {number} A random number between 0 and 1
+     *
+     * @description Generates a random number between 0 and 1.
+     */
     static get: () => number;
+    /**
+     * Returns a random number between a specified range
+     *
+     * @param {number} min - The lowest number in the range
+     * @param {number} max - The highest number in the range
+     *
+     * @returns {number} A random number between min and max
+     */
     static uniform: (min: number, max: number) => number;
 }

package/dist/lib/util/Random.js

@@ -1,8 +1,28 @@
+/**
+ * @class Random
+ *
+ * @description This class provides methods to generate random numbers.
+ */
 export default class Random {
 }
+/**
+ * @static
+ * @method get
+ * @returns {number} A random number between 0 and 1
+ *
+ * @description Generates a random number between 0 and 1.
+ */
 Random.get = () => {
     return Random.uniform(0, 1);
 };
+/**
+ * Returns a random number between a specified range
+ *
+ * @param {number} min - The lowest number in the range
+ * @param {number} max - The highest number in the range
+ *
+ * @returns {number} A random number between min and max
+ */
 Random.uniform = (min, max) => {
     return Math.random() * (max - min) + min;
 };

package/dist/lib/util/Random.js.map

@@ -1 +1 @@
-{"version":3,"file":"Random.js","sourceRoot":"","sources":["../../../src/lib/util/Random.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,OAAO,OAAO,MAAM;;AAClB,UAAG,GAAG,GAAG,EAAE;IAChB,OAAO,MAAM,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;AAC7B,CAAC,CAAA;AAEM,cAAO,GAAG,CAAC,GAAW,EAAE,GAAW,EAAE,EAAE;IAC5C,OAAO,IAAI,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,GAAG,GAAG,CAAC,GAAG,GAAG,CAAA;AAC1C,CAAC,CAAA"}
+{"version":3,"file":"Random.js","sourceRoot":"","sources":["../../../src/lib/util/Random.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,CAAC,OAAO,OAAO,MAAM;;AACzB;;;;;;GAMG;AACI,UAAG,GAAG,GAAG,EAAE;IAChB,OAAO,MAAM,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;AAC7B,CAAC,CAAA;AAED;;;;;;;GAOG;AACI,cAAO,GAAG,CAAC,GAAW,EAAE,GAAW,EAAE,EAAE;IAC5C,OAAO,IAAI,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,GAAG,GAAG,CAAC,GAAG,GAAG,CAAA;AAC1C,CAAC,CAAA"}

package/dist/lib/util/maths.d.ts

@@ -1,7 +1,24 @@
 declare const _default: {
     EPSILON: number;
+    /**
+     * Clamps a value between a minimum and maximum value
+     * @param {number} value - the value to be clamped
+     * @param {number} min - the minimum value
+     * @param {number} max - the maximum value
+     * @returns {number} - the clamped value
+     */
     clamp: (value: number, min: number, max: number) => number;
+    /**
+     * Converts degrees to radians
+     * @param {number} degrees - the number of degrees
+     * @returns {number} - the number of radians
+     */
     degreesToRadians: (degrees: number) => number;
+    /**
+     * Converts radians to degrees
+     * @param {number} radians - the number of radians
+     * @returns {number} - the number of degrees
+     */
     radiansToDegrees: (radians: number) => number;
 };
 export default _default;

package/dist/lib/util/maths.js

@@ -2,12 +2,29 @@ const DEGREES_MULTIPLIER = Math.PI / 180.0;
 const RADIANS_MULTIPLIER = 180 / Math.PI;
 export default {
     EPSILON: 2.220446049250313e-16,
+    /**
+     * Clamps a value between a minimum and maximum value
+     * @param {number} value - the value to be clamped
+     * @param {number} min - the minimum value
+     * @param {number} max - the maximum value
+     * @returns {number} - the clamped value
+     */
     clamp: (value, min, max) => {
         return Math.max(min, Math.min(value, max));
     },
+    /**
+     * Converts degrees to radians
+     * @param {number} degrees - the number of degrees
+     * @returns {number} - the number of radians
+     */
     degreesToRadians: (degrees) => {
         return degrees * DEGREES_MULTIPLIER;
     },
+    /**
+     * Converts radians to degrees
+     * @param {number} radians - the number of radians
+     * @returns {number} - the number of degrees
+     */
     radiansToDegrees: (radians) => {
         return radians * RADIANS_MULTIPLIER;
     },

package/dist/lib/util/maths.js.map

@@ -1 +1 @@
-{"version":3,"file":"maths.js","sourceRoot":"","sources":["../../../src/lib/util/maths.ts"],"names":[],"mappings":"AAAA,MAAM,kBAAkB,GAAG,IAAI,CAAC,EAAE,GAAG,KAAK,CAAA;AAC1C,MAAM,kBAAkB,GAAG,GAAG,GAAG,IAAI,CAAC,EAAE,CAAA;AAExC,eAAe;IACb,OAAO,EAAE,qBAAqB;IAE9B,KAAK,EAAE,CAAC,KAAa,EAAE,GAAW,EAAE,GAAW,EAAE,EAAE;QACjD,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,CAAA;IAC5C,CAAC;IAED,gBAAgB,EAAE,CAAC,OAAe,EAAE,EAAE;QACpC,OAAO,OAAO,GAAG,kBAAkB,CAAA;IACrC,CAAC;IAED,gBAAgB,EAAE,CAAC,OAAe,EAAE,EAAE;QACpC,OAAO,OAAO,GAAG,kBAAkB,CAAA;IACrC,CAAC;CACF,CAAA"}
+{"version":3,"file":"maths.js","sourceRoot":"","sources":["../../../src/lib/util/maths.ts"],"names":[],"mappings":"AAAA,MAAM,kBAAkB,GAAG,IAAI,CAAC,EAAE,GAAG,KAAK,CAAA;AAC1C,MAAM,kBAAkB,GAAG,GAAG,GAAG,IAAI,CAAC,EAAE,CAAA;AAExC,eAAe;IACb,OAAO,EAAE,qBAAqB;IAE9B;;;;;;OAMG;IACH,KAAK,EAAE,CAAC,KAAa,EAAE,GAAW,EAAE,GAAW,EAAE,EAAE;QACjD,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,CAAA;IAC5C,CAAC;IAED;;;;OAIG;IACH,gBAAgB,EAAE,CAAC,OAAe,EAAE,EAAE;QACpC,OAAO,OAAO,GAAG,kBAAkB,CAAA;IACrC,CAAC;IAED;;;;OAIG;IACH,gBAAgB,EAAE,CAAC,OAAe,EAAE,EAAE;QACpC,OAAO,OAAO,GAAG,kBAAkB,CAAA;IACrC,CAAC;CACF,CAAA"}

package/package.json

@@ -38,5 +38,5 @@
     "build": "npm run clean-dist && tsc && node copy.js",
     "clean-dist": "rimraf dist/*"
   },
-  "version": "4.0.20"
+  "version": "4.0.22"
 }