update: add icon.getStateNames() API & tidy up code

EvitcaStudio · Oct 24, 2024 · 57306ee · 57306ee
1 parent 0057ec6
commit 57306ee
Show file tree

Hide file tree

Showing 10 changed files with 362 additions and 28 deletions.
diff --git a/docs/Frame.html b/docs/Frame.html
diff --git a/docs/Icon.html b/docs/Icon.html
diff --git a/docs/VYI.html b/docs/VYI.html
diff --git a/docs/frame.mjs.html b/docs/frame.mjs.html
diff --git a/docs/icon.mjs.html b/docs/icon.mjs.html
diff --git a/docs/index.html b/docs/index.html
diff --git a/docs/vyi.mjs.html b/docs/vyi.mjs.html
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "vyi",
-  "version": "1.6.0",
+  "version": "1.61.0",
   "description": "A lightweight module to read / manage .vyi files created in the Vylocity Game Engine.",
   "main": "src/vyi.mjs",
   "scripts": {

diff --git a/src/frame.mjs b/src/frame.mjs
@@ -179,7 +179,6 @@ export class Frame {
     }
     /**
      * Exports this frame's data into proper vyi format.
-     * @private
      * @returns {Array} An array of data related to this frame in the proper vyi format.
      */
     export() {

diff --git a/src/icon.mjs b/src/icon.mjs
@@ -590,16 +590,23 @@ export class Icon {
         return this.states.get(pId);
     }
     /**
-     * Returns an array of all the states this icons has.
-     * @returns {Array} An array of states this icon has.
+     * Returns an array of all the states this icon has.
+     * @returns {Icon[]} An array of states this icon has.
      */
     getStates() {
         return Array.from(this.states.values());
     }
+    /**
+     * Returns an array of all the state names this icon has.
+     * @returns {string[]} An array of the state names.
+     */
+    getStateNames() {
+        return this.states.map((pState) => pState.getName());
+    }
     /**
      * Gets all the states belonging to this icon.
      * @private
-     * @returns {Array} An array containing the state data of all frames.
+     * @returns {object[]} An array containing the state data of all frames.
      */
     getStatesData() {
         const stateDataArray = this.getStates().map((pState) => pState.exportAsState());
@@ -624,7 +631,6 @@ export class Icon {
     }
     /**
      * Exports this icon's data into proper vyi format.
-     * @private
      * @returns {Array} An array of data related to this icon in the proper vyi format.
      */
     export() {