From 0057ec6f85876ad3fafe19d240f3d84eb3339ad1 Mon Sep 17 00:00:00 2001 From: Active Date: Mon, 7 Oct 2024 12:58:31 -0500 Subject: [PATCH] update: docs & bump version --- docs/Frame.html | 162 ++++++++++++++++++++++++++++++++++---------- docs/Icon.html | 76 ++++++++++++--------- docs/VYI.html | 18 ++++- docs/frame.mjs.html | 15 ++-- docs/icon.mjs.html | 9 ++- docs/index.html | 4 +- docs/vyi.mjs.html | 6 +- package.json | 2 +- 8 files changed, 207 insertions(+), 85 deletions(-) diff --git a/docs/Frame.html b/docs/Frame.html index 18f91e0..86d69fe 100644 --- a/docs/Frame.html +++ b/docs/Frame.html @@ -24,7 +24,7 @@
@@ -56,7 +56,7 @@

-

new Frame(pFrameData, pParentIcon)

+

new Frame(pFrameDataopt)

@@ -131,6 +131,8 @@
Parameters:
Type + Attributes + @@ -156,37 +158,21 @@
Parameters:
- - - - - The frame data that is used to build this frame. + - - - - - - - - pParentIcon - - - - + <optional>
-Icon + - - - + + - The icon that created this frame. + The frame data that is used to build this frame. @@ -285,7 +271,7 @@

getDataURL<
Source:
@@ -393,7 +379,7 @@

getDelaySource:
@@ -501,7 +487,7 @@

getHeightSource:
@@ -559,6 +545,114 @@
Returns:
+

+ + +
+ + + +

getIndex() → {number}

+ + + + + +
+ Gets the index of this frame. +
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + +
+
Returns:
+ + + +
+
+ Type: +
+
+ +number + + +
+
+ + +
+ The index of this frame. +
+ + +
+ + +
@@ -609,7 +703,7 @@

getParentSource:
@@ -717,7 +811,7 @@

getSizeSource:
@@ -825,7 +919,7 @@

getVyiSource:
@@ -933,7 +1027,7 @@

getWidthSource:
@@ -1041,7 +1135,7 @@

setDataURL<
Source:
@@ -1201,7 +1295,7 @@

setDelaySource:
@@ -1330,7 +1424,7 @@
Returns:

- Generated by JSDoc 4.0.3 on Thu Sep 26 2024 13:30:19 GMT-0500 (Central Daylight Time) using the Minami theme. + Generated by JSDoc 4.0.3 on Mon Oct 07 2024 12:58:07 GMT-0500 (Central Daylight Time) using the Minami theme.
diff --git a/docs/Icon.html b/docs/Icon.html index 32c320c..e984296 100644 --- a/docs/Icon.html +++ b/docs/Icon.html @@ -24,7 +24,7 @@
@@ -56,7 +56,7 @@

-

new Icon(pIconData)

+

new Icon(pIconDataopt)

@@ -131,6 +131,8 @@
Parameters:
Type + Attributes + @@ -156,6 +158,16 @@
Parameters:
+ + + <optional>
+ + + + + + + @@ -259,7 +271,7 @@

addFrameSource:
@@ -425,7 +437,7 @@

addStateSource:
@@ -588,7 +600,7 @@

getDataURL<
Source:
@@ -696,7 +708,7 @@

getDelaySource:
@@ -804,7 +816,7 @@

getFrameSource:
@@ -967,7 +979,7 @@

getFrame
Source:
@@ -1075,7 +1087,7 @@

getFramesSource:
@@ -1183,7 +1195,7 @@

getHeightSource:
@@ -1291,7 +1303,7 @@

getIdSource:
@@ -1399,7 +1411,7 @@

getNameSource:
@@ -1507,7 +1519,7 @@

getParentSource:
@@ -1618,7 +1630,7 @@

getSizeSource:
@@ -1726,7 +1738,7 @@

getStateSource:
@@ -1886,7 +1898,7 @@

getState
Source:
@@ -1994,7 +2006,7 @@

getStatesSource:
@@ -2102,7 +2114,7 @@

getVyiSource:
@@ -2210,7 +2222,7 @@

getWidthSource:
@@ -2318,7 +2330,7 @@

parseSource:
@@ -2453,7 +2465,7 @@

removeFram
Source:
@@ -2613,7 +2625,7 @@

rem
Source:
@@ -2773,7 +2785,7 @@

removeStat
Source:
@@ -2933,7 +2945,7 @@

remove
Source:
@@ -3093,7 +3105,7 @@

remo
Source:
@@ -3253,7 +3265,7 @@

renameSource:
@@ -3413,7 +3425,7 @@

reorderFr
Source:
@@ -3599,7 +3611,7 @@

setA
Source:
@@ -3759,7 +3771,7 @@

setDataURL<
Source:
@@ -3919,7 +3931,7 @@

setDelaySource:
@@ -4079,7 +4091,7 @@

setSizeSource:
@@ -4234,7 +4246,7 @@
Returns:

- Generated by JSDoc 4.0.3 on Thu Sep 26 2024 13:30:19 GMT-0500 (Central Daylight Time) using the Minami theme. + Generated by JSDoc 4.0.3 on Mon Oct 07 2024 12:58:07 GMT-0500 (Central Daylight Time) using the Minami theme.
diff --git a/docs/VYI.html b/docs/VYI.html index bef03be..49ce43c 100644 --- a/docs/VYI.html +++ b/docs/VYI.html @@ -24,7 +24,7 @@
@@ -56,7 +56,7 @@

-

new VYI(pVyiData)

+

new VYI(pVyiDataopt)

@@ -131,6 +131,8 @@
Parameters:
Type + Attributes + @@ -156,6 +158,16 @@
Parameters:
+ + + <optional>
+ + + + + + + @@ -2055,7 +2067,7 @@
Parameters:

- Generated by JSDoc 4.0.3 on Thu Sep 26 2024 13:30:19 GMT-0500 (Central Daylight Time) using the Minami theme. + Generated by JSDoc 4.0.3 on Mon Oct 07 2024 12:58:07 GMT-0500 (Central Daylight Time) using the Minami theme.
diff --git a/docs/frame.mjs.html b/docs/frame.mjs.html index 7916c0a..dd5f72b 100644 --- a/docs/frame.mjs.html +++ b/docs/frame.mjs.html @@ -24,7 +24,7 @@
@@ -83,9 +83,7 @@

frame.mjs

static defaultDelay = 100; /** * Create this frame class instance. - * @param {Array} pFrameData - The frame data that is used to build this frame. - * @param {Icon} pParentIcon - The icon that created this frame. - * @private + * @param {Array} [pFrameData] - The frame data that is used to build this frame. */ constructor(pFrameData) { this.parse(pFrameData); @@ -155,6 +153,13 @@

frame.mjs

getDelay() { return this.delay; } + /** + * Gets the index of this frame. + * @returns {number} The index of this frame. + */ + getIndex() { + return this.index; + } /** * Sets the data url of this frame. * @param {DataURL} pDataURL - The base64 data of this image. @@ -238,7 +243,7 @@

frame.mjs


- Generated by JSDoc 4.0.3 on Thu Sep 26 2024 13:30:19 GMT-0500 (Central Daylight Time) using the Minami theme. + Generated by JSDoc 4.0.3 on Mon Oct 07 2024 12:58:07 GMT-0500 (Central Daylight Time) using the Minami theme.
diff --git a/docs/icon.mjs.html b/docs/icon.mjs.html index 4a58b63..97dba92 100644 --- a/docs/icon.mjs.html +++ b/docs/icon.mjs.html @@ -24,7 +24,7 @@
@@ -135,8 +135,7 @@

icon.mjs

} /** * Creates this icon instance. - * @param {Array} pIconData - The icon data that is used to build this icon. - * @private + * @param {Array} [pIconData] - The icon data that is used to build this icon. */ constructor(pIconData) { this.parse(pIconData); @@ -576,7 +575,7 @@

icon.mjs

*/ removeState(pState) { if (pState instanceof Icon) { - if (this.icons.delete(pState.id)) {; + if (this.states.delete(pState.id)) {; pState.removeParent(); } } @@ -702,7 +701,7 @@

icon.mjs


- Generated by JSDoc 4.0.3 on Thu Sep 26 2024 13:30:19 GMT-0500 (Central Daylight Time) using the Minami theme. + Generated by JSDoc 4.0.3 on Mon Oct 07 2024 12:58:07 GMT-0500 (Central Daylight Time) using the Minami theme.
diff --git a/docs/index.html b/docs/index.html index 739f312..912298d 100644 --- a/docs/index.html +++ b/docs/index.html @@ -24,7 +24,7 @@
@@ -76,7 +76,7 @@

Global Dependency


- Generated by JSDoc 4.0.3 on Thu Sep 26 2024 13:30:19 GMT-0500 (Central Daylight Time) using the Minami theme. + Generated by JSDoc 4.0.3 on Mon Oct 07 2024 12:58:07 GMT-0500 (Central Daylight Time) using the Minami theme.
diff --git a/docs/vyi.mjs.html b/docs/vyi.mjs.html index 5a097e0..d4fa7ca 100644 --- a/docs/vyi.mjs.html +++ b/docs/vyi.mjs.html @@ -24,7 +24,7 @@
@@ -77,7 +77,7 @@

vyi.mjs

formatVersion = 1; /** * Initializes this module with the information from the VYI passed. - * @param {Object} pVyiData - A JSON / Javascript object containing the vyi information.this.ogger + * @param {Object} [pVyiData] - A JSON / Javascript object containing the vyi information.this.ogger */ constructor(pVyiData) { VYI.logger.registerType('Vyi-module', '#ff6600'); @@ -326,7 +326,7 @@

vyi.mjs


- Generated by JSDoc 4.0.3 on Thu Sep 26 2024 13:30:19 GMT-0500 (Central Daylight Time) using the Minami theme. + Generated by JSDoc 4.0.3 on Mon Oct 07 2024 12:58:07 GMT-0500 (Central Daylight Time) using the Minami theme.
diff --git a/package.json b/package.json index 2540ce9..54d65a5 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "vyi", - "version": "1.5.0", + "version": "1.6.0", "description": "A lightweight module to read / manage .vyi files created in the Vylocity Game Engine.", "main": "src/vyi.mjs", "scripts": {