Removes the icon from this VYI.
+
Removes the icon passed or the icon with the name pName.
@@ -1113,10 +1113,17 @@
Params:
- | - |
+ pIcon |
Icon |
|
- The icon to remove.
+ | The state to remove from this icon. pName should be not be used in tandem with this method of removing.
+ |
+
+
+ | pName |
+ string |
+ |
+ The name of the icon to remove. pIcon must be undefined to use this method for removing.
|
diff --git a/docs/file/src/icon.mjs.html b/docs/file/src/icon.mjs.html
index 0dd77e7..8c11125 100644
--- a/docs/file/src/icon.mjs.html
+++ b/docs/file/src/icon.mjs.html
@@ -266,7 +266,7 @@
}
}
/**
- * Removes the state with the name pName.
+ * Removes the state passed or the state with the name pName.
* @param {Icon} pState - The state to remove from this icon. pName should be not be used in tandem with this method of removing.
* @param {string} pName - The name of the state to remove. pState must be undefined to use this method for removing.
* @returns {self} This icon instance.
@@ -315,7 +315,7 @@
}
}
/**
- * Removes the frame from this icon via passed frame reference or via index passed.
+ * Removes the frame passed or the frame that exists at pIndex.
* @param {Frame} pFrame - The frame to remove from this icon. pIndex should be not be used in tandem with this method of removing.
* @param {number} pIndex - The index of the frame to remove. pFrame must be undefined to use this method for removing.
* @returns {self} This icon instance.
diff --git a/docs/file/src/vyi.mjs.html b/docs/file/src/vyi.mjs.html
index 26819b7..76fce76 100644
--- a/docs/file/src/vyi.mjs.html
+++ b/docs/file/src/vyi.mjs.html
@@ -146,12 +146,16 @@
}
}
/**
- * Removes the icon from this VYI.
- * @param {Icon} - The icon to remove.
+ * Removes the icon passed or the icon with the name pName.
+ * @param {Icon} pIcon - The state to remove from this icon. pName should be not be used in tandem with this method of removing.
+ * @param {string} pName - The name of the icon to remove. pIcon must be undefined to use this method for removing.
*/
- removeIcon(pIcon) {
- if (this.icons.includes(pIcon)) {
- this.icons.splice(this.icons.indexOf(pIcon), 1);
+ removeIcon(pIcon, pName) {
+ const icon = pIcon || this.getIcon(pName);
+ if (icon) {
+ if (this.icons.includes(icon)) {
+ this.icons.splice(this.icons.indexOf(icon), 1);
+ }
}
}
/**
diff --git a/docs/index.json b/docs/index.json
index c2c1155..92fb1ef 100644
--- a/docs/index.json
+++ b/docs/index.json
@@ -912,7 +912,7 @@
"__docId__": 65,
"kind": "file",
"name": "src/icon.mjs",
- "content": "import { VYI } from './vyi.mjs';\r\nimport { Frame } from './frame.mjs';\r\n\r\nexport class Icon {\r\n /**\r\n * An array of Icon's that are state of this icon.\r\n * @private\r\n * @type {Array}\r\n */\r\n states = [];\r\n /**\r\n * An arary of Frame's that are the frames of this icon.\r\n * @private\r\n * @type {Array}\r\n */\r\n frames = [];\r\n /**\r\n * The width of this icon. All states and frames of this icon must match this size.\r\n * @private\r\n * @type {number}\r\n */\r\n width = 32;\r\n /**\r\n * The height of this icon. All states and frames of this icon must match this size.\r\n * @private\r\n * @type {number}\r\n */\r\n height = 32;\r\n /**\r\n * The data URL of the sprite in this frame.\r\n * @private\r\n * @type {string}\r\n */\r\n dataURL;\r\n /**\r\n * The delay of this frame.\r\n * @private\r\n * @type {number}\r\n */\r\n delay = 100;\r\n /**\r\n * The name of this icon.\r\n * @private\r\n * @type {string}\r\n */\r\n name = 'rename-this-icon';\r\n /**\r\n * Creates this icon instance.\r\n * @param {Object} pIconData - The icon data that is used to build this icon.\r\n * @private\r\n */\r\n constructor(pIconData) {\r\n this.parse(pIconData);\r\n }\r\n /**\r\n * parses through the icon data and adds data to this icon.\r\n * @param {Object} pIconData - The icon data that is used to build this icon.\r\n * @private\r\n */\r\n parse(pIconData) {\r\n // Loop through pIconData and create this icon\r\n const iconName = pIconData[0];\r\n const iconWidth = pIconData[1];\r\n const iconHeight = pIconData[2];\r\n const iconDelay = pIconData[3];\r\n const iconDataURL = pIconData[4];\r\n const frameArray = pIconData[5];\r\n const stateArray = pIconData[6];\r\n\r\n // Set name\r\n this.rename(iconName);\r\n // Set size\r\n this.setSize(iconWidth, iconHeight);\r\n // Set icon delay\r\n this.setDelay(iconDelay);\r\n // Set dataURL\r\n this.setDataURL(iconDataURL);\r\n // Check if the frame data is an array\r\n if (Array.isArray(frameArray)) {\r\n // If the frame array has data then we need to store it.\r\n if (frameArray.length) {\r\n frameArray.forEach((pFrame) => {\r\n // pFrame is an array holding the datalURL and frameDelay of the frame\r\n this.addFrame(pFrame);\r\n });\r\n }\r\n }\r\n // Check if the states data is an array\r\n if (Array.isArray(stateArray)) {\r\n // If the state array has data then we need to store it.\r\n if (stateArray.length) {\r\n stateArray.forEach((pState) => {\r\n // Here we create a icon with aggregated data because the state data is not enough to make it an icon.\r\n // We do this because a state is basically an icon, but it just \"inherits\" alot of the data. But this makes it easier to manage if we treat it internally as an icon.\r\n const aggregatedIconData = [];\r\n // iconName\r\n aggregatedIconData[0] = pState[0];\r\n // iconWidth\r\n aggregatedIconData[1] = iconWidth;\r\n // iconHeight\r\n aggregatedIconData[2] = iconHeight;\r\n // frame delay\r\n aggregatedIconData[3] = pState[2];\r\n // iconDataURL\r\n aggregatedIconData[4] = pState[1];\r\n // frame array\r\n aggregatedIconData[5] = pState[3];\r\n this.addState(aggregatedIconData);\r\n });\r\n }\r\n }\r\n }\r\n /**\r\n * Sets the size of this icon.\r\n * @param {number} pWidth - The width of this icon.\r\n * @param {number} pHeight - THe height of this icon.\r\n * @returns {self} This icon instance.\r\n */\r\n setSize(pWidth, pHeight) {\r\n if (typeof(pWidth) === 'number') {\r\n this.width = pWidth;\r\n }\r\n if (typeof(pHeight) === 'number') {\r\n this.height = pHeight;\r\n }\r\n }\r\n /**\r\n * Gets the width and height of this icon and returns it.\r\n * @returns {Object} An object with the width and height of this icon.\r\n */\r\n getSize() {\r\n return { width: this.width, height: this.height };\r\n }\r\n /**\r\n * Sets the data url of this icon.\r\n * @param {DataURL} pDataURL - The base64 data of this image.\r\n * @returns {self} This icon instance.\r\n */\r\n setDataURL(pDataURL) {\r\n if (pDataURL) {\r\n if (typeof(pDataURL) === 'string') {\r\n this.dataURL = pDataURL;\r\n } else {\r\n VYI.logger.prefix('VYI-module').error('Invalid data url type!');\r\n }\r\n }\r\n return this;\r\n }\r\n /**\r\n * Gets the data URL of this icon.\r\n * @returns {DataURL} - The base64 data of this image.\r\n */\r\n getDataURL() {\r\n return this.dataURL;\r\n }\r\n /**\r\n * Sets the frame delay of this icon.\r\n * @param {number} pDelay - The delay to set this frame to.\r\n * @returns {self} This icon instance.\r\n */\r\n setDelay(pDelay) {\r\n if (pDelay) {\r\n if (typeof(pDelay) === 'number') {\r\n this.delay = pDelay;\r\n } else {\r\n VYI.logger.prefix('VYI-module').error('Invalid delay type!');\r\n }\r\n }\r\n return this;\r\n }\r\n /**\r\n * Gets the delay of this icon.\r\n * @returns {number} The delay of this icon.\r\n */\r\n getDelay() {\r\n return this.delay;\r\n }\r\n /**\r\n * Changes the name of this icon.\r\n * @param {string} pName - The new name of the icon.\r\n * @returns {self} This icon instance.\r\n */\r\n rename(pName) {\r\n if (pName) {\r\n if (typeof(pName) === 'string') {\r\n this.name = pName;\r\n } else {\r\n VYI.logger.prefix('VYI-Module').error('Invalid type for pName!');\r\n }\r\n }\r\n return this;\r\n }\r\n /**\r\n * Returns the name of this icon.\r\n * @returns {string} The name of this icon.\r\n */\r\n getName() {\r\n return this.name;\r\n }\r\n /**\r\n * Sets all the frames belonging to this icon to the same delay.\r\n * @param {number} pDelay - The delay to set all frames to.\r\n * @returns {self} This icon instance.\r\n */\r\n setAllFrameDelays(pDelay) {\r\n if (pDelay) {\r\n if (typeof(pDelay) === 'number') {\r\n this.frames.forEach((pFrame) => {\r\n pFrame.setDelay(pDelay);\r\n });\r\n } else {\r\n VYI.logger.prefix('VYI-Module').error('Invalid type for pDelay!');\r\n }\r\n }\r\n return this;\r\n }\r\n /**\r\n * Adds this icon data as a state. A state is also an icon.\r\n * @param {Object} pIconData - The data used to create this state icon.\r\n * @returns {Icon|undefined} The state that was added or undefined.\r\n */\r\n addState(pIconData) {\r\n if (pIconData instanceof Object) {\r\n const state = new Icon(pIconData);\r\n this.states.push(state);\r\n return state;\r\n }\r\n }\r\n /**\r\n * Removes the state with the name pName.\r\n * @param {Icon} pState - The state to remove from this icon. pName should be not be used in tandem with this method of removing.\r\n * @param {string} pName - The name of the state to remove. pState must be undefined to use this method for removing.\r\n * @returns {self} This icon instance.\r\n */\r\n removeState(pState, pName) {\r\n // The index used to remove this frame.\r\n let index;\r\n // Remove via reference to state.\r\n if (this.states.includes(pState)) {\r\n index = this.states.indexOf(pState);\r\n // Remove via reference to name\r\n } else if (typeof(pName) === 'string') {\r\n const state = this.getState(pName);\r\n if (state) {\r\n index = this.states.indexOf(state);\r\n }\r\n } else {\r\n VYI.logger.prefix('VYI-Module').error('Failed to remove state!');\r\n return this;\r\n }\r\n if (typeof(index) === 'number') {\r\n // Remove the state\r\n this.states.splice(index, 1);\r\n }\r\n return this;\r\n }\r\n /**\r\n * Adds a new frame to this icon.\r\n * @param {Object} pFrameData - The frame data to give this frame.\r\n * @returns {Frame|undefined} The frame that was added or undefined.\r\n */\r\n addFrame(pFrameData) {\r\n if (pFrameData) {\r\n if (pFrameData instanceof Object) {\r\n const frame = new Frame(pFrameData, this);\r\n // Add the frame to the frames array.\r\n this.frames.push(frame);\r\n // Re-index frames after a change\r\n this.indexFrames();\r\n return frame;\r\n } else {\r\n VYI.logger.prefix('VYI-Module').error('Invalid frame data passed!');\r\n }\r\n } else {\r\n VYI.logger.prefix('VYI-Module').error('No frame data passed!');\r\n }\r\n }\r\n /**\r\n * Removes the frame from this icon via passed frame reference or via index passed.\r\n * @param {Frame} pFrame - The frame to remove from this icon. pIndex should be not be used in tandem with this method of removing.\r\n * @param {number} pIndex - The index of the frame to remove. pFrame must be undefined to use this method for removing.\r\n * @returns {self} This icon instance.\r\n */\r\n removeFrame(pFrame, pIndex) {\r\n // The index used to remove this frame.\r\n let index;\r\n // Remove via reference to frame.\r\n if (this.frames.includes(pFrame)) {\r\n index = this.frames.indexOf(pFrame);\r\n // Remove via index passed.\r\n } else if (pIndex || pIndex === 0) {\r\n if (typeof(pIndex) === 'number') {\r\n const frame = this.getFrame(pIndex);\r\n if (frame) {\r\n index = pIndex;\r\n }\r\n } else {\r\n VYI.logger.prefix('VYI-Module').error('Invalid pIndex type!');\r\n }\r\n } else {\r\n VYI.logger.prefix('VYI-Module').error('Failed to remove frame!');\r\n }\r\n if (typeof(index) === 'number') {\r\n // Remove the frame\r\n this.frames.splice(index, 1);\r\n // Re-index frames after a change\r\n this.indexFrames();\r\n }\r\n return this;\r\n }\r\n /**\r\n * Index the frames properly.\r\n * @private\r\n */\r\n indexFrames() {\r\n // Reorder the frames after removing.\r\n this.frames.forEach((pFrame, pIndex) => {\r\n pFrame.index = pIndex;\r\n });\r\n }\r\n /**\r\n * Reorders the frame in the animation. The index of the passed frame will be swapped with the frame at pIndex.\r\n * The \"first\" frame of the animation is technically this icon's dataURL. So if you are aiming to change the order of this icon and convert it into a frame.\r\n * pCurrentIndex must be set to -1 to match this icon.\r\n * @param {number} pCurrentIndex - The current index of the frame.\r\n * @param {number} pIndex - The index the frame will be moving to.\r\n * @returns {self} This icon instance.\r\n */\r\n reorderFrame(pCurrentIndex, pIndex) {\r\n if (typeof(pCurrentIndex) === 'number' && typeof(pIndex) === 'number') {\r\n let frameAtIndex;\r\n let currentFrame;\r\n // We check if the current index is -1, if it is then it means we want to treat this icon as a frame. As the icon data and delay of this icon serves\r\n // as the frame 0.\r\n if (pCurrentIndex === -1) {\r\n currentFrame = this;\r\n // Otherwise if the index passed can be found in the frames array, then we use that frame.\r\n } else if (this.frames[pCurrentIndex]) {\r\n currentFrame = this.frames[pCurrentIndex];\r\n }\r\n\r\n // We get the frame at the specified index.\r\n if (this.frames[pIndex]) {\r\n frameAtIndex = this.frames[pIndex];\r\n }\r\n\r\n // If both frames can be found, we can swap their data.\r\n if (currentFrame && frameAtIndex) {\r\n // Store frame data\r\n const currentFrameDataURL = currentFrame.getDataURL();\r\n const currentFrameDelay = currentFrame.getDelay();\r\n\r\n const frameAtIndexDataURL = frameAtIndex.getDataURL();\r\n const frameAtIndexDelay = frameAtIndex.getDelay();\r\n\r\n // Swap data from frame\r\n currentFrame.setDataURL(frameAtIndexDataURL);\r\n currentFrame.setDelay(frameAtIndexDelay);\r\n // Swap data to frame\r\n frameAtIndex.setDataURL(currentFrameDataURL);\r\n frameAtIndex.setDelay(currentFrameDelay);\r\n } else {\r\n VYI.logger.prefix('VYI-Module').error('There was no frame found at pCurrentIndex, or there was no frame found at pIndex!');\r\n }\r\n } else {\r\n VYI.logger.prefix('VYI-Module').error('Invalid type used!');\r\n }\r\n return this;\r\n }\r\n /**\r\n * Gets the frame existing at pIndex.\r\n * Frame 0 will actually be frame \"1\" in the animation. As this icon will actually be frame 0.\r\n * If you are trying to get \"frame\" 1. Then you will need to use the icon's delay and data url. As that is frame 0.\r\n * @param {number} pIndex - The index of the frame to get.\r\n * @returns {Frame|undefined} The frame found at pIndex.\r\n */\r\n getFrame(pIndex) {\r\n if (typeof(pIndex) === 'number') {\r\n return this.frames[pIndex];\r\n } else {\r\n VYI.logger.prefix('VYI-Module').error('Invalid type used!');\r\n }\r\n }\r\n /**\r\n * Returns an array of all the frames this icons has.\r\n * @returns {Array} An array of frames this icon has.\r\n */\r\n getFrames() {\r\n return [ ...this.frames ];\r\n }\r\n /**\r\n * Gets all the frames belonging to this icon.\r\n * @private\r\n * @returns {Array} An array containing the frame data of all frames.\r\n */\r\n getFramesData() {\r\n const frameDataArray = [];\r\n this.frames.forEach((pFrame) => {\r\n frameDataArray.push(pFrame.export());\r\n });\r\n return frameDataArray;\r\n }\r\n /**\r\n * Gets the state that has the name pName.\r\n * @param {string} pName - The name of the state to get.\r\n * @returns {Icon} The state that has the name of pName.\r\n */\r\n getState(pName) {\r\n for (const icon of this.states) {\r\n // If the state has the same name, return that state\r\n if (icon.getName() === pName) {\r\n return icon;\r\n }\r\n };\r\n }\r\n /**\r\n * Returns an array of all the states this icons has.\r\n * @returns {Array} An array of states this icon has.\r\n */\r\n getStates() {\r\n return [ ...this.states ];\r\n }\r\n /**\r\n * Gets all the states belonging to this icon.\r\n * @private\r\n * @returns {Array} An array containing the state data of all frames.\r\n */\r\n getStatesData() {\r\n const stateDataArray = [];\r\n // Loop state array to export relevant information.\r\n this.states.forEach((pState) => {\r\n stateDataArray.push(pState.exportAsState());\r\n });\r\n return stateDataArray; \r\n }\r\n /**\r\n * Exports this icon as if it was a state in the proper vyi format.\r\n * @private\r\n * @returns {Array} An array of data related to this icon as if it were a state.\r\n */\r\n exportAsState() {\r\n const stateData = [];\r\n // state name\r\n stateData[0] = this.getName();\r\n // state dataURL\r\n stateData[1] = this.getDataURL();\r\n // state frame delay\r\n stateData[2] = this.getDelay();\r\n // state frame array\r\n stateData[3] = [];\r\n\r\n // Loop frame array to export relevant information.\r\n this.frames.forEach((pFrame) => {\r\n stateData[3].push(pFrame.export());\r\n });\r\n return stateData;\r\n }\r\n /**\r\n * Exports this icon's data into proper vyi format.\r\n * @private\r\n * @returns {Array} An array of data related to this icon in the proper vyi format.\r\n */\r\n export() {\r\n const iconData = [];\r\n // icon name\r\n iconData[0] = this.getName();\r\n // Get the size of this icon.\r\n const size = this.getSize();\r\n // icon width\r\n iconData[1] = size.width;\r\n // icon height\r\n iconData[2] = size.height;\r\n // frame delay\r\n iconData[3] = this.getDelay();\r\n // icon DataURL\r\n iconData[4] = this.getDataURL();\r\n // frame array\r\n iconData[5] = this.getFramesData();\r\n\r\n // this is actually an optional data entry into the vyi, only used if states actually exist on this icon.\r\n // this will save data\r\n if (this.states.length) {\r\n // states array\r\n iconData[6] = this.getStatesData();\r\n }\r\n return iconData;\r\n }\r\n}",
+ "content": "import { VYI } from './vyi.mjs';\r\nimport { Frame } from './frame.mjs';\r\n\r\nexport class Icon {\r\n /**\r\n * An array of Icon's that are state of this icon.\r\n * @private\r\n * @type {Array}\r\n */\r\n states = [];\r\n /**\r\n * An arary of Frame's that are the frames of this icon.\r\n * @private\r\n * @type {Array}\r\n */\r\n frames = [];\r\n /**\r\n * The width of this icon. All states and frames of this icon must match this size.\r\n * @private\r\n * @type {number}\r\n */\r\n width = 32;\r\n /**\r\n * The height of this icon. All states and frames of this icon must match this size.\r\n * @private\r\n * @type {number}\r\n */\r\n height = 32;\r\n /**\r\n * The data URL of the sprite in this frame.\r\n * @private\r\n * @type {string}\r\n */\r\n dataURL;\r\n /**\r\n * The delay of this frame.\r\n * @private\r\n * @type {number}\r\n */\r\n delay = 100;\r\n /**\r\n * The name of this icon.\r\n * @private\r\n * @type {string}\r\n */\r\n name = 'rename-this-icon';\r\n /**\r\n * Creates this icon instance.\r\n * @param {Object} pIconData - The icon data that is used to build this icon.\r\n * @private\r\n */\r\n constructor(pIconData) {\r\n this.parse(pIconData);\r\n }\r\n /**\r\n * parses through the icon data and adds data to this icon.\r\n * @param {Object} pIconData - The icon data that is used to build this icon.\r\n * @private\r\n */\r\n parse(pIconData) {\r\n // Loop through pIconData and create this icon\r\n const iconName = pIconData[0];\r\n const iconWidth = pIconData[1];\r\n const iconHeight = pIconData[2];\r\n const iconDelay = pIconData[3];\r\n const iconDataURL = pIconData[4];\r\n const frameArray = pIconData[5];\r\n const stateArray = pIconData[6];\r\n\r\n // Set name\r\n this.rename(iconName);\r\n // Set size\r\n this.setSize(iconWidth, iconHeight);\r\n // Set icon delay\r\n this.setDelay(iconDelay);\r\n // Set dataURL\r\n this.setDataURL(iconDataURL);\r\n // Check if the frame data is an array\r\n if (Array.isArray(frameArray)) {\r\n // If the frame array has data then we need to store it.\r\n if (frameArray.length) {\r\n frameArray.forEach((pFrame) => {\r\n // pFrame is an array holding the datalURL and frameDelay of the frame\r\n this.addFrame(pFrame);\r\n });\r\n }\r\n }\r\n // Check if the states data is an array\r\n if (Array.isArray(stateArray)) {\r\n // If the state array has data then we need to store it.\r\n if (stateArray.length) {\r\n stateArray.forEach((pState) => {\r\n // Here we create a icon with aggregated data because the state data is not enough to make it an icon.\r\n // We do this because a state is basically an icon, but it just \"inherits\" alot of the data. But this makes it easier to manage if we treat it internally as an icon.\r\n const aggregatedIconData = [];\r\n // iconName\r\n aggregatedIconData[0] = pState[0];\r\n // iconWidth\r\n aggregatedIconData[1] = iconWidth;\r\n // iconHeight\r\n aggregatedIconData[2] = iconHeight;\r\n // frame delay\r\n aggregatedIconData[3] = pState[2];\r\n // iconDataURL\r\n aggregatedIconData[4] = pState[1];\r\n // frame array\r\n aggregatedIconData[5] = pState[3];\r\n this.addState(aggregatedIconData);\r\n });\r\n }\r\n }\r\n }\r\n /**\r\n * Sets the size of this icon.\r\n * @param {number} pWidth - The width of this icon.\r\n * @param {number} pHeight - THe height of this icon.\r\n * @returns {self} This icon instance.\r\n */\r\n setSize(pWidth, pHeight) {\r\n if (typeof(pWidth) === 'number') {\r\n this.width = pWidth;\r\n }\r\n if (typeof(pHeight) === 'number') {\r\n this.height = pHeight;\r\n }\r\n }\r\n /**\r\n * Gets the width and height of this icon and returns it.\r\n * @returns {Object} An object with the width and height of this icon.\r\n */\r\n getSize() {\r\n return { width: this.width, height: this.height };\r\n }\r\n /**\r\n * Sets the data url of this icon.\r\n * @param {DataURL} pDataURL - The base64 data of this image.\r\n * @returns {self} This icon instance.\r\n */\r\n setDataURL(pDataURL) {\r\n if (pDataURL) {\r\n if (typeof(pDataURL) === 'string') {\r\n this.dataURL = pDataURL;\r\n } else {\r\n VYI.logger.prefix('VYI-module').error('Invalid data url type!');\r\n }\r\n }\r\n return this;\r\n }\r\n /**\r\n * Gets the data URL of this icon.\r\n * @returns {DataURL} - The base64 data of this image.\r\n */\r\n getDataURL() {\r\n return this.dataURL;\r\n }\r\n /**\r\n * Sets the frame delay of this icon.\r\n * @param {number} pDelay - The delay to set this frame to.\r\n * @returns {self} This icon instance.\r\n */\r\n setDelay(pDelay) {\r\n if (pDelay) {\r\n if (typeof(pDelay) === 'number') {\r\n this.delay = pDelay;\r\n } else {\r\n VYI.logger.prefix('VYI-module').error('Invalid delay type!');\r\n }\r\n }\r\n return this;\r\n }\r\n /**\r\n * Gets the delay of this icon.\r\n * @returns {number} The delay of this icon.\r\n */\r\n getDelay() {\r\n return this.delay;\r\n }\r\n /**\r\n * Changes the name of this icon.\r\n * @param {string} pName - The new name of the icon.\r\n * @returns {self} This icon instance.\r\n */\r\n rename(pName) {\r\n if (pName) {\r\n if (typeof(pName) === 'string') {\r\n this.name = pName;\r\n } else {\r\n VYI.logger.prefix('VYI-Module').error('Invalid type for pName!');\r\n }\r\n }\r\n return this;\r\n }\r\n /**\r\n * Returns the name of this icon.\r\n * @returns {string} The name of this icon.\r\n */\r\n getName() {\r\n return this.name;\r\n }\r\n /**\r\n * Sets all the frames belonging to this icon to the same delay.\r\n * @param {number} pDelay - The delay to set all frames to.\r\n * @returns {self} This icon instance.\r\n */\r\n setAllFrameDelays(pDelay) {\r\n if (pDelay) {\r\n if (typeof(pDelay) === 'number') {\r\n this.frames.forEach((pFrame) => {\r\n pFrame.setDelay(pDelay);\r\n });\r\n } else {\r\n VYI.logger.prefix('VYI-Module').error('Invalid type for pDelay!');\r\n }\r\n }\r\n return this;\r\n }\r\n /**\r\n * Adds this icon data as a state. A state is also an icon.\r\n * @param {Object} pIconData - The data used to create this state icon.\r\n * @returns {Icon|undefined} The state that was added or undefined.\r\n */\r\n addState(pIconData) {\r\n if (pIconData instanceof Object) {\r\n const state = new Icon(pIconData);\r\n this.states.push(state);\r\n return state;\r\n }\r\n }\r\n /**\r\n * Removes the state passed or the state with the name pName.\r\n * @param {Icon} pState - The state to remove from this icon. pName should be not be used in tandem with this method of removing.\r\n * @param {string} pName - The name of the state to remove. pState must be undefined to use this method for removing.\r\n * @returns {self} This icon instance.\r\n */\r\n removeState(pState, pName) {\r\n // The index used to remove this frame.\r\n let index;\r\n // Remove via reference to state.\r\n if (this.states.includes(pState)) {\r\n index = this.states.indexOf(pState);\r\n // Remove via reference to name\r\n } else if (typeof(pName) === 'string') {\r\n const state = this.getState(pName);\r\n if (state) {\r\n index = this.states.indexOf(state);\r\n }\r\n } else {\r\n VYI.logger.prefix('VYI-Module').error('Failed to remove state!');\r\n return this;\r\n }\r\n if (typeof(index) === 'number') {\r\n // Remove the state\r\n this.states.splice(index, 1);\r\n }\r\n return this;\r\n }\r\n /**\r\n * Adds a new frame to this icon.\r\n * @param {Object} pFrameData - The frame data to give this frame.\r\n * @returns {Frame|undefined} The frame that was added or undefined.\r\n */\r\n addFrame(pFrameData) {\r\n if (pFrameData) {\r\n if (pFrameData instanceof Object) {\r\n const frame = new Frame(pFrameData, this);\r\n // Add the frame to the frames array.\r\n this.frames.push(frame);\r\n // Re-index frames after a change\r\n this.indexFrames();\r\n return frame;\r\n } else {\r\n VYI.logger.prefix('VYI-Module').error('Invalid frame data passed!');\r\n }\r\n } else {\r\n VYI.logger.prefix('VYI-Module').error('No frame data passed!');\r\n }\r\n }\r\n /**\r\n * Removes the frame passed or the frame that exists at pIndex.\r\n * @param {Frame} pFrame - The frame to remove from this icon. pIndex should be not be used in tandem with this method of removing.\r\n * @param {number} pIndex - The index of the frame to remove. pFrame must be undefined to use this method for removing.\r\n * @returns {self} This icon instance.\r\n */\r\n removeFrame(pFrame, pIndex) {\r\n // The index used to remove this frame.\r\n let index;\r\n // Remove via reference to frame.\r\n if (this.frames.includes(pFrame)) {\r\n index = this.frames.indexOf(pFrame);\r\n // Remove via index passed.\r\n } else if (pIndex || pIndex === 0) {\r\n if (typeof(pIndex) === 'number') {\r\n const frame = this.getFrame(pIndex);\r\n if (frame) {\r\n index = pIndex;\r\n }\r\n } else {\r\n VYI.logger.prefix('VYI-Module').error('Invalid pIndex type!');\r\n }\r\n } else {\r\n VYI.logger.prefix('VYI-Module').error('Failed to remove frame!');\r\n }\r\n if (typeof(index) === 'number') {\r\n // Remove the frame\r\n this.frames.splice(index, 1);\r\n // Re-index frames after a change\r\n this.indexFrames();\r\n }\r\n return this;\r\n }\r\n /**\r\n * Index the frames properly.\r\n * @private\r\n */\r\n indexFrames() {\r\n // Reorder the frames after removing.\r\n this.frames.forEach((pFrame, pIndex) => {\r\n pFrame.index = pIndex;\r\n });\r\n }\r\n /**\r\n * Reorders the frame in the animation. The index of the passed frame will be swapped with the frame at pIndex.\r\n * The \"first\" frame of the animation is technically this icon's dataURL. So if you are aiming to change the order of this icon and convert it into a frame.\r\n * pCurrentIndex must be set to -1 to match this icon.\r\n * @param {number} pCurrentIndex - The current index of the frame.\r\n * @param {number} pIndex - The index the frame will be moving to.\r\n * @returns {self} This icon instance.\r\n */\r\n reorderFrame(pCurrentIndex, pIndex) {\r\n if (typeof(pCurrentIndex) === 'number' && typeof(pIndex) === 'number') {\r\n let frameAtIndex;\r\n let currentFrame;\r\n // We check if the current index is -1, if it is then it means we want to treat this icon as a frame. As the icon data and delay of this icon serves\r\n // as the frame 0.\r\n if (pCurrentIndex === -1) {\r\n currentFrame = this;\r\n // Otherwise if the index passed can be found in the frames array, then we use that frame.\r\n } else if (this.frames[pCurrentIndex]) {\r\n currentFrame = this.frames[pCurrentIndex];\r\n }\r\n\r\n // We get the frame at the specified index.\r\n if (this.frames[pIndex]) {\r\n frameAtIndex = this.frames[pIndex];\r\n }\r\n\r\n // If both frames can be found, we can swap their data.\r\n if (currentFrame && frameAtIndex) {\r\n // Store frame data\r\n const currentFrameDataURL = currentFrame.getDataURL();\r\n const currentFrameDelay = currentFrame.getDelay();\r\n\r\n const frameAtIndexDataURL = frameAtIndex.getDataURL();\r\n const frameAtIndexDelay = frameAtIndex.getDelay();\r\n\r\n // Swap data from frame\r\n currentFrame.setDataURL(frameAtIndexDataURL);\r\n currentFrame.setDelay(frameAtIndexDelay);\r\n // Swap data to frame\r\n frameAtIndex.setDataURL(currentFrameDataURL);\r\n frameAtIndex.setDelay(currentFrameDelay);\r\n } else {\r\n VYI.logger.prefix('VYI-Module').error('There was no frame found at pCurrentIndex, or there was no frame found at pIndex!');\r\n }\r\n } else {\r\n VYI.logger.prefix('VYI-Module').error('Invalid type used!');\r\n }\r\n return this;\r\n }\r\n /**\r\n * Gets the frame existing at pIndex.\r\n * Frame 0 will actually be frame \"1\" in the animation. As this icon will actually be frame 0.\r\n * If you are trying to get \"frame\" 1. Then you will need to use the icon's delay and data url. As that is frame 0.\r\n * @param {number} pIndex - The index of the frame to get.\r\n * @returns {Frame|undefined} The frame found at pIndex.\r\n */\r\n getFrame(pIndex) {\r\n if (typeof(pIndex) === 'number') {\r\n return this.frames[pIndex];\r\n } else {\r\n VYI.logger.prefix('VYI-Module').error('Invalid type used!');\r\n }\r\n }\r\n /**\r\n * Returns an array of all the frames this icons has.\r\n * @returns {Array} An array of frames this icon has.\r\n */\r\n getFrames() {\r\n return [ ...this.frames ];\r\n }\r\n /**\r\n * Gets all the frames belonging to this icon.\r\n * @private\r\n * @returns {Array} An array containing the frame data of all frames.\r\n */\r\n getFramesData() {\r\n const frameDataArray = [];\r\n this.frames.forEach((pFrame) => {\r\n frameDataArray.push(pFrame.export());\r\n });\r\n return frameDataArray;\r\n }\r\n /**\r\n * Gets the state that has the name pName.\r\n * @param {string} pName - The name of the state to get.\r\n * @returns {Icon} The state that has the name of pName.\r\n */\r\n getState(pName) {\r\n for (const icon of this.states) {\r\n // If the state has the same name, return that state\r\n if (icon.getName() === pName) {\r\n return icon;\r\n }\r\n };\r\n }\r\n /**\r\n * Returns an array of all the states this icons has.\r\n * @returns {Array} An array of states this icon has.\r\n */\r\n getStates() {\r\n return [ ...this.states ];\r\n }\r\n /**\r\n * Gets all the states belonging to this icon.\r\n * @private\r\n * @returns {Array} An array containing the state data of all frames.\r\n */\r\n getStatesData() {\r\n const stateDataArray = [];\r\n // Loop state array to export relevant information.\r\n this.states.forEach((pState) => {\r\n stateDataArray.push(pState.exportAsState());\r\n });\r\n return stateDataArray; \r\n }\r\n /**\r\n * Exports this icon as if it was a state in the proper vyi format.\r\n * @private\r\n * @returns {Array} An array of data related to this icon as if it were a state.\r\n */\r\n exportAsState() {\r\n const stateData = [];\r\n // state name\r\n stateData[0] = this.getName();\r\n // state dataURL\r\n stateData[1] = this.getDataURL();\r\n // state frame delay\r\n stateData[2] = this.getDelay();\r\n // state frame array\r\n stateData[3] = [];\r\n\r\n // Loop frame array to export relevant information.\r\n this.frames.forEach((pFrame) => {\r\n stateData[3].push(pFrame.export());\r\n });\r\n return stateData;\r\n }\r\n /**\r\n * Exports this icon's data into proper vyi format.\r\n * @private\r\n * @returns {Array} An array of data related to this icon in the proper vyi format.\r\n */\r\n export() {\r\n const iconData = [];\r\n // icon name\r\n iconData[0] = this.getName();\r\n // Get the size of this icon.\r\n const size = this.getSize();\r\n // icon width\r\n iconData[1] = size.width;\r\n // icon height\r\n iconData[2] = size.height;\r\n // frame delay\r\n iconData[3] = this.getDelay();\r\n // icon DataURL\r\n iconData[4] = this.getDataURL();\r\n // frame array\r\n iconData[5] = this.getFramesData();\r\n\r\n // this is actually an optional data entry into the vyi, only used if states actually exist on this icon.\r\n // this will save data\r\n if (this.states.length) {\r\n // states array\r\n iconData[6] = this.getStatesData();\r\n }\r\n return iconData;\r\n }\r\n}",
"static": true,
"longname": "C:/Users/jared/Documents/Github/vyi/src/icon.mjs",
"access": "public",
@@ -1486,7 +1486,7 @@
"static": false,
"longname": "src/icon.mjs~Icon#removeState",
"access": "public",
- "description": "Removes the state with the name pName.",
+ "description": "Removes the state passed or the state with the name pName.",
"lineNumber": 235,
"unknown": [
{
@@ -1575,7 +1575,7 @@
"static": false,
"longname": "src/icon.mjs~Icon#removeFrame",
"access": "public",
- "description": "Removes the frame from this icon via passed frame reference or via index passed.",
+ "description": "Removes the frame passed or the frame that exists at pIndex.",
"lineNumber": 284,
"unknown": [
{
@@ -1929,7 +1929,7 @@
"__docId__": 104,
"kind": "file",
"name": "src/vyi.mjs",
- "content": "import { Logger } from './vendor/logger.min.mjs';\r\nimport { Icon } from './icon.mjs';\r\n\r\nexport class VYI {\r\n\t/**\r\n\t * The version of the module.\r\n\t */\r\n\tstatic version = \"VERSION_REPLACE_ME\";\r\n /** The logger module this module uses to log errors / logs.\r\n * @private\r\n * @type {Object}\r\n */\r\n static logger = new Logger();\r\n /**\r\n * An array of icons that belong to this VYI\r\n * @private\r\n * @type {Array}\r\n */\r\n icons = [];\r\n /**\r\n * The name of this vyi.\r\n * @private\r\n * @type {string}\r\n */\r\n name = 'vyi-to-be-renamed';\r\n /**\r\n * The version of the VYI.\r\n * @private\r\n * @type {number}\r\n */\r\n formatVersion;\r\n /**\r\n * Initializes this module with the information from the VYI passed.\r\n * @param {Object} pVYIData - A JSON / Javascript object containing the vyi information.\r\n */\r\n constructor(pVYIData) {\r\n VYI.logger.registerType('VYI-Module', '#ff6600');\r\n if (pVYIData instanceof Object) {\r\n this.parse(pVYIData);\r\n } else {\r\n VYI.logger.prefix('VYI-module').error('Invalid vyiData type! Cannot parse!');\r\n }\r\n }\r\n /**\r\n * Initializes this module with the information from the VYI passed.\r\n * Can call parse multiple times with different data to \"merge\" vyis.\r\n * @async\r\n * @param {Object|string} pVYIData - A string containing the path to the vyi json or a JSON / Javascript object containing the vyi information.\r\n */\r\n async parse(pVYIData) {\r\n try {\r\n if (pVYIData) {\r\n let vyi;\r\n // If the data is a path then we need to use fetch to acquire the data first\r\n if (typeof(pVYIData) === 'string') {\r\n const url = pVYIData;\r\n const response = await fetch(url);\r\n vyi = await response.json();\r\n } else if (pVYIData instanceof Object) {\r\n vyi = pVYIData;\r\n }\r\n // If there is data to parse\r\n // Then parse through it\r\n if (vyi) {\r\n /**\r\n * An array of icons that this vyi holds.\r\n * @type {Array}\r\n */\r\n const icons = vyi.i;\r\n /**\r\n * The version of the vyi. 1 for default if no version is found.\r\n * @type {number}\r\n */\r\n this.formatVersion = vyi.v || 1;\r\n\r\n if (Array.isArray(icons)) {\r\n // Loop through the icons and add them to the vyi module instance.\r\n icons.forEach((pIconData) => {\r\n this.addIcon(pIconData);\r\n });\r\n } else {\r\n VYI.logger.prefix('VYI-module').error('Invalid .vyi file! Cannot parse.');\r\n }\r\n }\r\n }\r\n } catch (pError) {\r\n VYI.logger.prefix('VYI-module').error(`Error processing vyi data: ${pError}`);\r\n }\r\n }\r\n /**\r\n * Adds an icon to this VYI.\r\n * @param {Object} pIconData - The icon data to use.\r\n * @returns {Icon|undefined} - The Icon added or undefined.\r\n */\r\n addIcon(pIconData) {\r\n if (pIconData) {\r\n if (pIconData instanceof Object) {\r\n const icon = new Icon(pIconData);\r\n // Add the icon to the icons array.\r\n this.icons.push(icon);\r\n return icon;\r\n } else {\r\n VYI.logger.prefix('VYI-module').error('Invalid icon data type passed!');\r\n }\r\n } else {\r\n VYI.logger.prefix('VYI-module').error('No icon data passed!');\r\n }\r\n }\r\n /**\r\n * Removes the icon from this VYI.\r\n * @param {Icon} - The icon to remove.\r\n */\r\n removeIcon(pIcon) {\r\n if (this.icons.includes(pIcon)) {\r\n this.icons.splice(this.icons.indexOf(pIcon), 1);\r\n }\r\n }\r\n /**\r\n * Returns all the icon names in this vyi.\r\n * @returns {Array} An array of icon names in this vyi.\r\n */\r\n getIconNames() {\r\n // Array to store the icon names.\r\n const iconNames = [];\r\n this.icons.forEach((pIcon) => {\r\n iconNames.push(pIcon.name);\r\n });\r\n return iconNames;\r\n }\r\n /**\r\n * Gets the icon that has the name pName.\r\n * @param {string} pName - The name of the icon to get.\r\n * @returns {Icon|undefined} The icon that has the name pName or undefined.\r\n */\r\n getIcon(pName) {\r\n for (const icon of this.icons) {\r\n // If the icon has the same name, return that icon\r\n if (icon.getName() === pName) {\r\n return icon;\r\n }\r\n };\r\n }\r\n /**\r\n * Exports this VYI into VYI format.\r\n * @returns {Object} Returns the vyi data.\r\n */\r\n export() {\r\n const vyi = {};\r\n // Set version\r\n vyi.v = this.formatVersion;\r\n // Set the icons array\r\n vyi.i = [];\r\n this.icons.forEach((pIcon) => {\r\n // Push the icon data to the vyi export object.\r\n vyi.i.push(pIcon.export());\r\n });\r\n return vyi;\r\n }\r\n}",
+ "content": "import { Logger } from './vendor/logger.min.mjs';\r\nimport { Icon } from './icon.mjs';\r\n\r\nexport class VYI {\r\n\t/**\r\n\t * The version of the module.\r\n\t */\r\n\tstatic version = \"VERSION_REPLACE_ME\";\r\n /** The logger module this module uses to log errors / logs.\r\n * @private\r\n * @type {Object}\r\n */\r\n static logger = new Logger();\r\n /**\r\n * An array of icons that belong to this VYI\r\n * @private\r\n * @type {Array}\r\n */\r\n icons = [];\r\n /**\r\n * The name of this vyi.\r\n * @private\r\n * @type {string}\r\n */\r\n name = 'vyi-to-be-renamed';\r\n /**\r\n * The version of the VYI.\r\n * @private\r\n * @type {number}\r\n */\r\n formatVersion;\r\n /**\r\n * Initializes this module with the information from the VYI passed.\r\n * @param {Object} pVYIData - A JSON / Javascript object containing the vyi information.\r\n */\r\n constructor(pVYIData) {\r\n VYI.logger.registerType('VYI-Module', '#ff6600');\r\n if (pVYIData instanceof Object) {\r\n this.parse(pVYIData);\r\n } else {\r\n VYI.logger.prefix('VYI-module').error('Invalid vyiData type! Cannot parse!');\r\n }\r\n }\r\n /**\r\n * Initializes this module with the information from the VYI passed.\r\n * Can call parse multiple times with different data to \"merge\" vyis.\r\n * @async\r\n * @param {Object|string} pVYIData - A string containing the path to the vyi json or a JSON / Javascript object containing the vyi information.\r\n */\r\n async parse(pVYIData) {\r\n try {\r\n if (pVYIData) {\r\n let vyi;\r\n // If the data is a path then we need to use fetch to acquire the data first\r\n if (typeof(pVYIData) === 'string') {\r\n const url = pVYIData;\r\n const response = await fetch(url);\r\n vyi = await response.json();\r\n } else if (pVYIData instanceof Object) {\r\n vyi = pVYIData;\r\n }\r\n // If there is data to parse\r\n // Then parse through it\r\n if (vyi) {\r\n /**\r\n * An array of icons that this vyi holds.\r\n * @type {Array}\r\n */\r\n const icons = vyi.i;\r\n /**\r\n * The version of the vyi. 1 for default if no version is found.\r\n * @type {number}\r\n */\r\n this.formatVersion = vyi.v || 1;\r\n\r\n if (Array.isArray(icons)) {\r\n // Loop through the icons and add them to the vyi module instance.\r\n icons.forEach((pIconData) => {\r\n this.addIcon(pIconData);\r\n });\r\n } else {\r\n VYI.logger.prefix('VYI-module').error('Invalid .vyi file! Cannot parse.');\r\n }\r\n }\r\n }\r\n } catch (pError) {\r\n VYI.logger.prefix('VYI-module').error(`Error processing vyi data: ${pError}`);\r\n }\r\n }\r\n /**\r\n * Adds an icon to this VYI.\r\n * @param {Object} pIconData - The icon data to use.\r\n * @returns {Icon|undefined} - The Icon added or undefined.\r\n */\r\n addIcon(pIconData) {\r\n if (pIconData) {\r\n if (pIconData instanceof Object) {\r\n const icon = new Icon(pIconData);\r\n // Add the icon to the icons array.\r\n this.icons.push(icon);\r\n return icon;\r\n } else {\r\n VYI.logger.prefix('VYI-module').error('Invalid icon data type passed!');\r\n }\r\n } else {\r\n VYI.logger.prefix('VYI-module').error('No icon data passed!');\r\n }\r\n }\r\n /**\r\n * Removes the icon passed or the icon with the name pName.\r\n * @param {Icon} pIcon - The state to remove from this icon. pName should be not be used in tandem with this method of removing.\r\n * @param {string} pName - The name of the icon to remove. pIcon must be undefined to use this method for removing.\r\n */\r\n removeIcon(pIcon, pName) {\r\n const icon = pIcon || this.getIcon(pName);\r\n if (icon) {\r\n if (this.icons.includes(icon)) {\r\n this.icons.splice(this.icons.indexOf(icon), 1);\r\n }\r\n }\r\n }\r\n /**\r\n * Returns all the icon names in this vyi.\r\n * @returns {Array} An array of icon names in this vyi.\r\n */\r\n getIconNames() {\r\n // Array to store the icon names.\r\n const iconNames = [];\r\n this.icons.forEach((pIcon) => {\r\n iconNames.push(pIcon.name);\r\n });\r\n return iconNames;\r\n }\r\n /**\r\n * Gets the icon that has the name pName.\r\n * @param {string} pName - The name of the icon to get.\r\n * @returns {Icon|undefined} The icon that has the name pName or undefined.\r\n */\r\n getIcon(pName) {\r\n for (const icon of this.icons) {\r\n // If the icon has the same name, return that icon\r\n if (icon.getName() === pName) {\r\n return icon;\r\n }\r\n };\r\n }\r\n /**\r\n * Exports this VYI into VYI format.\r\n * @returns {Object} Returns the vyi data.\r\n */\r\n export() {\r\n const vyi = {};\r\n // Set version\r\n vyi.v = this.formatVersion;\r\n // Set the icons array\r\n vyi.i = [];\r\n this.icons.forEach((pIcon) => {\r\n // Push the icon data to the vyi export object.\r\n vyi.i.push(pIcon.export());\r\n });\r\n return vyi;\r\n }\r\n}",
"static": true,
"longname": "C:/Users/jared/Documents/Github/vyi/src/vyi.mjs",
"access": "public",
@@ -2146,8 +2146,8 @@
"static": false,
"longname": "src/vyi.mjs~VYI#removeIcon",
"access": "public",
- "description": "Removes the icon from this VYI.",
- "lineNumber": 113,
+ "description": "Removes the icon passed or the icon with the name pName.",
+ "lineNumber": 114,
"params": [
{
"nullable": null,
@@ -2156,8 +2156,18 @@
],
"spread": false,
"optional": false,
- "name": "-",
- "description": "The icon to remove."
+ "name": "pIcon",
+ "description": "The state to remove from this icon. pName should be not be used in tandem with this method of removing."
+ },
+ {
+ "nullable": null,
+ "types": [
+ "string"
+ ],
+ "spread": false,
+ "optional": false,
+ "name": "pName",
+ "description": "The name of the icon to remove. pIcon must be undefined to use this method for removing."
}
],
"return": null
@@ -2173,7 +2183,7 @@
"longname": "src/vyi.mjs~VYI#getIconNames",
"access": "public",
"description": "Returns all the icon names in this vyi.",
- "lineNumber": 122,
+ "lineNumber": 126,
"unknown": [
{
"tagName": "@returns",
@@ -2201,7 +2211,7 @@
"longname": "src/vyi.mjs~VYI#getIcon",
"access": "public",
"description": "Gets the icon that has the name pName.",
- "lineNumber": 135,
+ "lineNumber": 139,
"unknown": [
{
"tagName": "@returns",
@@ -2241,7 +2251,7 @@
"longname": "src/vyi.mjs~VYI#export",
"access": "public",
"description": "Exports this VYI into VYI format.",
- "lineNumber": 147,
+ "lineNumber": 151,
"unknown": [
{
"tagName": "@returns",
diff --git a/docs/source.html b/docs/source.html
index 1aa1e36..914e6fb 100644
--- a/docs/source.html
+++ b/docs/source.html
@@ -57,7 +57,7 @@
- |
3433 byte |
118 |
-
2024-02-01 23:08:06 (UTC) |
+
2024-02-01 23:13:05 (UTC) |
| src/icon.mjs |
@@ -65,15 +65,15 @@
- |
17360 byte |
487 |
- 2024-02-01 23:10:42 (UTC) |
+ 2024-02-01 23:24:16 (UTC) |
| src/vyi.mjs |
VYI |
- |
- 5345 byte |
- 158 |
- 2024-02-01 21:53:20 (UTC) |
+ 5682 byte |
+ 162 |
+ 2024-02-01 23:25:41 (UTC) |
diff --git a/src/icon.mjs b/src/icon.mjs
index 07c8f3c..c45c4b8 100644
--- a/src/icon.mjs
+++ b/src/icon.mjs
@@ -227,7 +227,7 @@ export class Icon {
}
}
/**
- * Removes the state with the name pName.
+ * Removes the state passed or the state with the name pName.
* @param {Icon} pState - The state to remove from this icon. pName should be not be used in tandem with this method of removing.
* @param {string} pName - The name of the state to remove. pState must be undefined to use this method for removing.
* @returns {self} This icon instance.
@@ -276,7 +276,7 @@ export class Icon {
}
}
/**
- * Removes the frame from this icon via passed frame reference or via index passed.
+ * Removes the frame passed or the frame that exists at pIndex.
* @param {Frame} pFrame - The frame to remove from this icon. pIndex should be not be used in tandem with this method of removing.
* @param {number} pIndex - The index of the frame to remove. pFrame must be undefined to use this method for removing.
* @returns {self} This icon instance.
diff --git a/src/vyi.mjs b/src/vyi.mjs
index 02a0ef5..b846ee8 100644
--- a/src/vyi.mjs
+++ b/src/vyi.mjs
@@ -107,12 +107,16 @@ export class VYI {
}
}
/**
- * Removes the icon from this VYI.
- * @param {Icon} - The icon to remove.
+ * Removes the icon passed or the icon with the name pName.
+ * @param {Icon} pIcon - The state to remove from this icon. pName should be not be used in tandem with this method of removing.
+ * @param {string} pName - The name of the icon to remove. pIcon must be undefined to use this method for removing.
*/
- removeIcon(pIcon) {
- if (this.icons.includes(pIcon)) {
- this.icons.splice(this.icons.indexOf(pIcon), 1);
+ removeIcon(pIcon, pName) {
+ const icon = pIcon || this.getIcon(pName);
+ if (icon) {
+ if (this.icons.includes(icon)) {
+ this.icons.splice(this.icons.indexOf(icon), 1);
+ }
}
}
/**
@@ -133,12 +137,16 @@ export class VYI {
* @returns {Icon|undefined} The icon that has the name pName or undefined.
*/
getIcon(pName) {
- for (const icon of this.icons) {
- // If the icon has the same name, return that icon
- if (icon.getName() === pName) {
- return icon;
- }
- };
+ if (typeof(pName) === 'string') {
+ for (const icon of this.icons) {
+ // If the icon has the same name, return that icon
+ if (icon.getName() === pName) {
+ return icon;
+ }
+ };
+ } else {
+ this.logger.prefix('VYI-module').error('Invalid name type used!');
+ }
}
/**
* Exports this VYI into VYI format.