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

hints function docs

Browse source
This commit is contained in:
ReznoRMichael 2020-09-06 02:47:18 +02:00
parent 8c8942a129
commit c49e415b1a
1 changed files with 8 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
HKCheckCompletion.js
View file

@ -531,7 +531,7 @@ function PrefillHTML(jsObj) {
/** /**
* Generates and appends a new entry inside the HTML of a given ID * Generates and appends a new entry inside the HTML of a given ID
* @param {object} divId ID of the HTML element * @param {object} divId object containing div ID and h2 title of the HTML element
* @param {string} textPrefix Main name of the entry * @param {string} textPrefix Main name of the entry
* @param {string} textSuffix Optional suffix after the main name * @param {string} textSuffix Optional suffix after the main name
*/ */
@ -647,8 +647,14 @@ function CheckWorldDataTrue(divId, idText, dataObject, worldData) {
} }
} }
/**
* Checks, validates and shows hints to the player depending on their save progression, in chronological order. Shows only hint for the last uncompleted event. If Hollow Knight is defeated, shows a dummy text.
* @param {object} divId object containing div hints ID and h2 title
* @param {object} dataObject object containing all hints data
* @param {object} playerData object containing HK Player Data to look in
* @param {object} worldData object containing HK World Data to look in
*/
function CheckHintsTrue(divId, dataObject, playerData, worldData) { function CheckHintsTrue(divId, dataObject, playerData, worldData) {
let hollowKnightDefeated = false; let hollowKnightDefeated = false;
for (let i in dataObject) { for (let i in dataObject) {