mikl/hollow-knight-completion-check
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

various safety checks and comments

Browse source
This commit is contained in:
ReznoRMichael 2021-07-10 14:44:37 +02:00
parent f937f56586
commit c5918bd58e
4 changed files with 57 additions and 35 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

53
build/app.js
View file

@ -76,15 +76,24 @@ function HKCheckCompletion(jsonObject) {
if (jsonObject.hasOwnProperty("playerData")) { if (jsonObject.hasOwnProperty("playerData")) {
HKPlayerData = jsonObject.playerData; HKPlayerData = jsonObject.playerData;
} else return false; } else {
_hk_database_js__WEBPACK_IMPORTED_MODULE_0__.default.saveAnalyzed = false;
return false;
}
if (jsonObject.hasOwnProperty("sceneData")) { if (jsonObject.hasOwnProperty("sceneData")) {
HKSceneData = jsonObject.sceneData; HKSceneData = jsonObject.sceneData;
if (jsonObject.sceneData.hasOwnProperty("persistentBoolItems")) { if (jsonObject.sceneData.hasOwnProperty("persistentBoolItems")) {
HKWorldItems = jsonObject.sceneData.persistentBoolItems; HKWorldItems = jsonObject.sceneData.persistentBoolItems;
} else return false; } else {
} else return false; // Pre-Cleaning and filling initial data (h2, id) needed for PrepareHTMLString() _hk_database_js__WEBPACK_IMPORTED_MODULE_0__.default.saveAnalyzed = false;
return false;
}
} else {
_hk_database_js__WEBPACK_IMPORTED_MODULE_0__.default.saveAnalyzed = false;
return false;
} // Pre-Cleaning and filling initial data (h2, id) needed for PrepareHTMLString()
// PrefillHTML(HK.sections); // PrefillHTML(HK.sections);
// Prevents adding current percent data after each function call and resets what the analyzing has done to the original object. Prevents wrong data display after subsequent save analyzing. // Prevents adding current percent data after each function call and resets what the analyzing has done to the original object. Prevents wrong data display after subsequent save analyzing.
@ -154,8 +163,8 @@ function HKCheckCompletion(jsonObject) {
CheckHintsTrue(_hk_database_js__WEBPACK_IMPORTED_MODULE_0__.default.sections.hints, _hk_database_js__WEBPACK_IMPORTED_MODULE_0__.default.sections.hints.entries, HKPlayerData, HKWorldItems); // ------------------------- Fill completion ----------------------------- // CheckHintsTrue(_hk_database_js__WEBPACK_IMPORTED_MODULE_0__.default.sections.hints, _hk_database_js__WEBPACK_IMPORTED_MODULE_0__.default.sections.hints.entries, HKPlayerData, HKWorldItems); // ------------------------- Fill completion ----------------------------- //
/* CompletionHTML(HK.sections, HKPlayerData.completionPercentage); */ /* Percent completion is filled inside GenerateInnerHTML() using CompletionFill() */
// ------------------------- Indicate that the save file was loaded and analyzed ----------------------------- // // ------------------------- Indicate that the save file was loaded and analyzed correctly ----------------------------- //
_hk_database_js__WEBPACK_IMPORTED_MODULE_0__.default.saveAnalyzed = true; // ------------------------- Generate everything on the page with updated values ----------------------------- // _hk_database_js__WEBPACK_IMPORTED_MODULE_0__.default.saveAnalyzed = true; // ------------------------- Generate everything on the page with updated values ----------------------------- //
@ -1318,8 +1327,8 @@ function CheckHintsTrue(section, dataObject, playerData, worldData) {
function HKReadTextArea() { function HKReadTextArea() {
var textAreaId = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : ""; var textAreaId = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : "";
// refresh and prepare document for filling with data from the save // starts the main HTML generating function GenerateInnerHTML() and ensures proper checkbox behaviour
InitialHTMLPopulate(_hk_database_js__WEBPACK_IMPORTED_MODULE_0__.default); InitializeHTMLPopulation(_hk_database_js__WEBPACK_IMPORTED_MODULE_0__.default);
var contents = document.getElementById(textAreaId).value; var contents = document.getElementById(textAreaId).value;
if (contents.length) { if (contents.length) {
@ -1328,8 +1337,9 @@ function HKReadTextArea() {
if (jsonObject.hasOwnProperty("playerData")) HKCheckCompletion(jsonObject); // console.log(jsonObject); if (jsonObject.hasOwnProperty("playerData")) HKCheckCompletion(jsonObject); // console.log(jsonObject);
} catch (error) { } catch (error) {
alert("This seems like not a valid Hollow Knight save. ".concat(error)); _hk_database_js__WEBPACK_IMPORTED_MODULE_0__.default.saveAnalyzed = false;
console.info("This seems like not a valid Hollow Knight save. ".concat(error)); alert("This seems like not a valid Hollow Knight save.\n".concat(error));
console.info("This seems like not a valid Hollow Knight save.\n".concat(error));
} }
} }
} }
@ -1339,7 +1349,7 @@ function HKReadTextArea() {
*/ */
function InitialHTMLPopulate(db) { function InitializeHTMLPopulation(db) {
/* let sFillText = ""; /* let sFillText = "";
CurrentDataFalse(); */ CurrentDataFalse(); */
(0,_page_functions_js__WEBPACK_IMPORTED_MODULE_1__.GenerateInnerHTML)(db); // PrefillHTML(sections); (0,_page_functions_js__WEBPACK_IMPORTED_MODULE_1__.GenerateInnerHTML)(db); // PrefillHTML(sections);
@ -1543,7 +1553,7 @@ function FillInnerHTML(elementId, textFill) {
document.addEventListener("DOMContentLoaded", function () { document.addEventListener("DOMContentLoaded", function () {
InitialHTMLPopulate(_hk_database_js__WEBPACK_IMPORTED_MODULE_0__.default); InitializeHTMLPopulation(_hk_database_js__WEBPACK_IMPORTED_MODULE_0__.default);
}); // Does an action when the save file location input text is clicked once (auto select & copy to clipboard) }); // Does an action when the save file location input text is clicked once (auto select & copy to clipboard)
document.getElementById("save-location-input").addEventListener("click", function (e) { document.getElementById("save-location-input").addEventListener("click", function (e) {
@ -4883,7 +4893,6 @@ function TranslateMapName(mapCode) {
"use strict"; "use strict";
__webpack_require__.r(__webpack_exports__); __webpack_require__.r(__webpack_exports__);
/* harmony export */ __webpack_require__.d(__webpack_exports__, { /* harmony export */ __webpack_require__.d(__webpack_exports__, {
/* harmony export */ "CompletionHTML": () => (/* binding */ CompletionHTML),
/* harmony export */ "GenerateInnerHTML": () => (/* binding */ GenerateInnerHTML), /* harmony export */ "GenerateInnerHTML": () => (/* binding */ GenerateInnerHTML),
/* harmony export */ "AppendHTML": () => (/* binding */ AppendHTML), /* harmony export */ "AppendHTML": () => (/* binding */ AppendHTML),
/* harmony export */ "CheckboxHintsToggle": () => (/* binding */ CheckboxHintsToggle), /* harmony export */ "CheckboxHintsToggle": () => (/* binding */ CheckboxHintsToggle),
@ -5046,7 +5055,7 @@ function GenerateInnerHTML(db) {
var geoShadeImage = "<img src='".concat(_img_geo_shade_png__WEBPACK_IMPORTED_MODULE_7__, "' class='geo-symbol' alt='shade geo symbol image' title='Shade Geo'>"); var geoShadeImage = "<img src='".concat(_img_geo_shade_png__WEBPACK_IMPORTED_MODULE_7__, "' class='geo-symbol' alt='shade geo symbol image' title='Shade Geo'>");
var div = "<div class='single-entry'>"; var div = "<div class='single-entry'>";
var divFlex = "<div class='flex-container align-center'>"; var divFlex = "<div class='flex-container align-center'>";
/* #################### Different behaviour depending on the section ####################### */ /* ############################## create all main entries ############################## */
for (var section in sections) { for (var section in sections) {
entries = sections[section].entries; entries = sections[section].entries;
@ -5061,18 +5070,19 @@ function GenerateInnerHTML(db) {
} else { } else {
textFill += CompletionFillNoSave(sections[section]); textFill += CompletionFillNoSave(sections[section]);
} }
/* ############################## create all main entries ############################## */ /* #################### Different behaviour depending on the section ####################### */
switch (section) { switch (section) {
/* ############### Game Status (intro) ################ */ /* ############### Game Status (intro) ################ */
case "intro": case "intro":
/* ############## Looping entries (intro) ############### */ /* ############## Create each single entry (intro) ############### */
for (var entry in entries) { for (var entry in entries) {
obj.b = ["", ""]; obj.b = ["", ""];
obj.p = "<span class='p-left-small'></span>"; obj.p = "<span class='p-left-small'></span>";
obj.span = ["<b>", "</b>"]; obj.span = ["<b>", "</b>"];
obj.div = div; obj.div = div;
/* -------- Icons (next to each entry) --------- */
if (entries[entry].hasOwnProperty("icon")) { if (entries[entry].hasOwnProperty("icon")) {
switch (entries[entry].icon) { switch (entries[entry].icon) {
@ -5098,7 +5108,7 @@ function GenerateInnerHTML(db) {
obj.textPrefix = entries[entry].name; obj.textPrefix = entries[entry].name;
obj.textSuffix = entries[entry].spoiler; obj.textSuffix = entries[entry].spoiler;
obj.spoilerAfter = ""; obj.spoilerAfter = "";
/* Different text and images for each entry in the "Game Status" section */ /* Different text and images for each entry in the "Game Status" (intro) section */
switch (entry) { switch (entry) {
case "gameCompletion": case "gameCompletion":
@ -5201,10 +5211,12 @@ function GenerateInnerHTML(db) {
textFill += SingleEntryFill(obj); textFill += SingleEntryFill(obj);
break; break;
/* ###################### All other sections ##################### */ /* ###################### Create all other sections ##################### */
default: default:
/* ###################### Create each single entry (from all other sections) ##################### */
for (var _entry in entries) { for (var _entry in entries) {
/* -------- Icons (next to each entry) --------- */
if (entries[_entry].hasOwnProperty("icon")) { if (entries[_entry].hasOwnProperty("icon")) {
switch (entries[_entry].icon) { switch (entries[_entry].icon) {
case "clock": case "clock":
@ -5298,12 +5310,12 @@ function GenerateInnerHTML(db) {
finalHTMLFill += "".concat(textFill, "\n</div>\n\n"); finalHTMLFill += "".concat(textFill, "\n</div>\n\n");
} }
/* Final HTML Fill here */
/* console.groupCollapsed("finalHTMLFill"); /* console.groupCollapsed("finalHTMLFill");
console.log(finalHTMLFill); console.log(finalHTMLFill);
console.groupEnd(); */ console.groupEnd(); */
/* Final single HTML access and fill here */
document.getElementById("generated").innerHTML = finalHTMLFill; document.getElementById("generated").innerHTML = finalHTMLFill;
} }
@ -5616,7 +5628,8 @@ function SingleEntryFill(obj) {
spoiler[1], spoiler[1],
span[1], span[1],
"</div>\n" "</div>\n"
].join(""); */ ].join("");
*/
return [obj.div, obj.icon, "".concat(obj.b[0]).concat(obj.textPrefix).concat(obj.b[1]), obj.span[0], obj.p, obj.spoiler[0], "".concat(obj.textSuffix).concat(obj.spoilerAfter), obj.spoiler[1], obj.span[1], "</div>\n"].join(""); return [obj.div, obj.icon, "".concat(obj.b[0]).concat(obj.textPrefix).concat(obj.b[1]), obj.span[0], obj.p, obj.spoiler[0], "".concat(obj.textSuffix).concat(obj.spoilerAfter), obj.spoiler[1], obj.span[1], "</div>\n"].join("");
} }
/** /**

2
build/app.js.map
View file

File diff suppressed because one or more lines are too long

33
src/js/HKCheckCompletion.js
View file

@ -7,7 +7,6 @@ import HK from "./hk-database.js";
/* ----------------- Helper functions --------------------------------------- */ /* ----------------- Helper functions --------------------------------------- */
import { import {
CompletionHTML,
GenerateInnerHTML, GenerateInnerHTML,
AppendHTML, AppendHTML,
CheckboxHintsToggle, CheckboxHintsToggle,
@ -80,14 +79,23 @@ function HKCheckCompletion(jsonObject) {
if (jsonObject.hasOwnProperty("playerData")) { if (jsonObject.hasOwnProperty("playerData")) {
HKPlayerData = jsonObject.playerData; HKPlayerData = jsonObject.playerData;
} else return false; } else {
HK.saveAnalyzed = false;
return false;
}
if (jsonObject.hasOwnProperty("sceneData")) { if (jsonObject.hasOwnProperty("sceneData")) {
HKSceneData = jsonObject.sceneData; HKSceneData = jsonObject.sceneData;
if (jsonObject.sceneData.hasOwnProperty("persistentBoolItems")) { if (jsonObject.sceneData.hasOwnProperty("persistentBoolItems")) {
HKWorldItems = jsonObject.sceneData.persistentBoolItems; HKWorldItems = jsonObject.sceneData.persistentBoolItems;
} else return false; } else {
} else return false; HK.saveAnalyzed = false;
return false;
}
} else {
HK.saveAnalyzed = false;
return false;
}
// Pre-Cleaning and filling initial data (h2, id) needed for PrepareHTMLString() // Pre-Cleaning and filling initial data (h2, id) needed for PrepareHTMLString()
// PrefillHTML(HK.sections); // PrefillHTML(HK.sections);
@ -223,9 +231,9 @@ function HKCheckCompletion(jsonObject) {
// ------------------------- Fill completion ----------------------------- // // ------------------------- Fill completion ----------------------------- //
/* CompletionHTML(HK.sections, HKPlayerData.completionPercentage); */ /* Percent completion is filled inside GenerateInnerHTML() using CompletionFill() */
// ------------------------- Indicate that the save file was loaded and analyzed ----------------------------- // // ------------------------- Indicate that the save file was loaded and analyzed correctly ----------------------------- //
HK.saveAnalyzed = true; HK.saveAnalyzed = true;
@ -1384,8 +1392,8 @@ function CheckHintsTrue(section, dataObject, playerData, worldData) {
*/ */
function HKReadTextArea(textAreaId = "") { function HKReadTextArea(textAreaId = "") {
// refresh and prepare document for filling with data from the save // starts the main HTML generating function GenerateInnerHTML() and ensures proper checkbox behaviour
InitialHTMLPopulate(HK); InitializeHTMLPopulation(HK);
let contents = document.getElementById(textAreaId).value; let contents = document.getElementById(textAreaId).value;
@ -1397,8 +1405,9 @@ function HKReadTextArea(textAreaId = "") {
if (jsonObject.hasOwnProperty("playerData")) HKCheckCompletion(jsonObject); if (jsonObject.hasOwnProperty("playerData")) HKCheckCompletion(jsonObject);
// console.log(jsonObject); // console.log(jsonObject);
} catch (error) { } catch (error) {
alert(`This seems like not a valid Hollow Knight save. ${error}`); HK.saveAnalyzed = false;
console.info(`This seems like not a valid Hollow Knight save. ${error}`); alert(`This seems like not a valid Hollow Knight save.\n${error}`);
console.info(`This seems like not a valid Hollow Knight save.\n${error}`);
} }
} }
} }
@ -1407,7 +1416,7 @@ function HKReadTextArea(textAreaId = "") {
* Populate all HTML with given ID and their initial data set as false (used at DOM load) * Populate all HTML with given ID and their initial data set as false (used at DOM load)
* @param {object} db JavaScript Object containing all HTML IDs to populate * @param {object} db JavaScript Object containing all HTML IDs to populate
*/ */
function InitialHTMLPopulate(db) { function InitializeHTMLPopulation(db) {
/* let sFillText = ""; /* let sFillText = "";
@ -1632,7 +1641,7 @@ function FillInnerHTML(elementId, textFill) {
// Populate HTML at load (before img and css) // Populate HTML at load (before img and css)
document.addEventListener("DOMContentLoaded", () => { document.addEventListener("DOMContentLoaded", () => {
InitialHTMLPopulate(HK); InitializeHTMLPopulation(HK);
}); });
// Does an action when the save file location input text is clicked once (auto select & copy to clipboard) // Does an action when the save file location input text is clicked once (auto select & copy to clipboard)

4
src/js/page-functions.js
View file

@ -777,7 +777,8 @@ function SingleEntryFill(obj) {
spoiler[1], spoiler[1],
span[1], span[1],
"</div>\n" "</div>\n"
].join(""); */ ].join("");
*/
return [ return [
obj.div, obj.div,
@ -971,7 +972,6 @@ document.getElementById("checkbox-spoilers").addEventListener("click", CheckboxS
/* ------------------------- Exports ------------------------------- */ /* ------------------------- Exports ------------------------------- */
export { export {
CompletionHTML,
GenerateInnerHTML, GenerateInnerHTML,
AppendHTML, AppendHTML,
CheckboxHintsToggle, CheckboxHintsToggle,