diff --git a/src/events/001-base/baseEvent.js b/src/events/001-base/baseEvent.js
index bd14a10f55da84020788990198f41fd24a92797d..9e8167176cf3be1079b65440394511fa33d30f26 100644
--- a/src/events/001-base/baseEvent.js
+++ b/src/events/001-base/baseEvent.js
@@ -2,7 +2,10 @@
App.Events.BaseEvent = class BaseEvent {
/** build a new event
* parameters are necessary for serialization (so that saving with the event active will work correctly) and should not normally be used directly
- * child classes will inherit this implementation automatically, and should not normally need their own constructor implementation */
+ * child classes will inherit this implementation automatically, and should not normally need their own constructor implementation
+ * @param {Array<number>} [actors]
+ * @param {object} [params]
+ */
constructor(actors, params) {
/** @member {Array<number>} actors - a list of IDs for the actors participating in this event. */
this.actors = actors || [];
@@ -10,18 +13,27 @@ App.Events.BaseEvent = class BaseEvent {
this.params = params || {};
}
- /** generate an array of zero or more predicates which must all be true in order for the event to be valid.
+ /** Event predicates determine whether the event will occur or not.
+ * @callback eventPredicate
+ * @returns {boolean}
+ */
+ /** generate an array of zero or more predicates which must all return true in order for the event to be valid.
* lambda predicates may add properties to {@link App.Events.BaseEvent#params the params member} in order to pass information on to the event.
* child classes should implement this.
- * @returns {Array<Function>}
+ * @returns {Array<eventPredicate>}
*/
eventPrerequisites() {
return [];
}
+ /** Actor predicates determine whether an actor is qualified for an event or not.
+ * @callback actorPredicate
+ * @param {App.Entity.SlaveState} slave
+ * @returns {boolean}
+ */
/** generate an array of zero or more arrays, each corresponding to an actor in the event, which contain zero or more predicates which must be satisfied by the actor.
* child classes should implement this.
- * @returns {Array<Array<Function>>}
+ * @returns {Array<Array<actorPredicate>>}
*/
actorPrerequisites() {
return [];
diff --git a/src/events/RESS/hotPC.js b/src/events/RESS/hotPC.js
index ebd65124c531bb1b08a7eb83f3ed83320f7edc61..f31d4645ba781d3541662151b45e82e133971573 100644
--- a/src/events/RESS/hotPC.js
+++ b/src/events/RESS/hotPC.js
@@ -169,7 +169,7 @@ App.Events.RESSHotPC = class RESSHotPC extends App.Events.BaseEvent {
function fuck() {
t = [];
- if (PC.title === 0 || $PC.boobs >= 300 || $PC.belly >= 1500) {
+ if (PC.title === 0 || PC.boobs >= 300 || PC.belly >= 1500) {
t.push("Despite your feminine appearance, you have capable hands.");
} else {
t.push("You have strong hands to go with your masculine appeal.");
diff --git a/src/events/RESS/moistPussy.js b/src/events/RESS/moistPussy.js
index be0fa36f402f0268b8970be405663e93c31c3ae9..dada74e0c7e57fca3635143b3e3d48d6fd626a5f 100644
--- a/src/events/RESS/moistPussy.js
+++ b/src/events/RESS/moistPussy.js
@@ -2,7 +2,6 @@ App.Events.RESSMoistPussy = class RESSMoistPussy extends App.Events.BaseEvent {
eventPrerequisites() {
return []; // always valid if sufficient actors can be cast successfully
}
- /** @type {App.Entity.SlaveState} */
actorPrerequisites() {
return [
diff --git a/src/events/eventUtils.js b/src/events/eventUtils.js
index e24d5a9976999db2539366f8c1f3e19cab0beefb..2faec70e59e1d5dffdb3af5f7e5680ed1aa4fc03 100644
--- a/src/events/eventUtils.js
+++ b/src/events/eventUtils.js
@@ -1,7 +1,7 @@
/** draw event art, with the option to dress the slave in a particular way
- * @param {HTMLElement} node - DOM node to attach art to
+ * @param {Node} node - DOM node to attach art to
* @param {App.Entity.SlaveState|Array<App.Entity.SlaveState>} slaves - one or several slaves to draw art for
- * @param {[string]} clothesMode - if the slaves' clothing should be overridden, what should they be wearing?
+ * @param {string} [clothesMode] - if the slaves' clothing should be overridden, what should they be wearing?
*/
App.Events.drawEventArt = function(node, slaves, clothesMode) {
// do nothing if the player doesn't want images
@@ -59,8 +59,8 @@ App.Events.drawEventArt = function(node, slaves, clothesMode) {
};
/** intelligently adds spaces to an array of mixed strings and DOM nodes, merging consecutive strings in the process
- * @param {Array<string|HTMLElement>} sentences
- * @returns {Array<string|HTMLElement>}
+ * @param {Array<string|HTMLElement|DocumentFragment>} sentences
+ * @returns {Array<string|HTMLElement|DocumentFragment>}
*/
App.Events.spaceSentences = function(sentences) {
if (sentences.length <= 1) {
@@ -89,20 +89,24 @@ App.Events.spaceSentences = function(sentences) {
};
/** assemble a DOM paragraph from an array of DOM nodes, sentences or sentence fragments (which may contain HTML)
- * @param {HTMLElement} node
- * @param {Array<string|HTMLElement>} sentences
+ * @param {Node} node
+ * @param {Array<string|HTMLElement|DocumentFragment>} sentences
*/
App.Events.addParagraph = function(node, sentences) {
let para = document.createElement("p");
- $(para).append(App.Events.spaceSentences(sentences));
+ $(para).append(...App.Events.spaceSentences(sentences));
node.appendChild(para);
};
+/** result handler callback - process the result and return an array of mixed strings and DOM nodes
+ * @callback resultHandler
+ * @returns {Array<string|HTMLElement|DocumentFragment>}
+ */
/** a response to an event, and its result */
App.Events.Result = class {
- /** @param {[string]} text - the link text for the response
- * @param {[Function]} handler - the function to call to generate the result when the link is clicked
- * @param {[string]} note - a note to provide alongside the link (for example, a cost or virginity loss warning)
+ /** @param {string} [text] - the link text for the response
+ * @param {resultHandler} [handler] - the function to call to generate the result when the link is clicked
+ * @param {string} [note] - a note to provide alongside the link (for example, a cost or virginity loss warning)
* To mark an option as disabled, construct the result with only the note.
*/
constructor(text, handler, note) {
@@ -111,9 +115,12 @@ App.Events.Result = class {
this.note = note;
}
+ /** call the result handler, replacing the contents of the given span ID
+ * @param {string} resultSpanID
+ */
handle(resultSpanID) {
let frag = document.createDocumentFragment();
- $(frag).append(App.Events.spaceSentences(this.handler()));
+ $(frag).append(...App.Events.spaceSentences(this.handler()));
App.UI.DOM.replace(`#${resultSpanID}`, frag);
}
@@ -139,7 +146,7 @@ App.Events.Result = class {
};
/** add a list of results for an event
- * @param {HTMLElement} node
+ * @param {Node} node
* @param {Array<App.Events.Result>} results
* @param {string} [elementID="result"]
*/
diff --git a/src/js/generateRelatedSlave.js b/src/js/generateRelatedSlave.js
index 3ca1d676a686db5cf3ed4a909aab1839b1774617..9237088703059413e188aebed11de04baf9e3088 100644
--- a/src/js/generateRelatedSlave.js
+++ b/src/js/generateRelatedSlave.js
@@ -5,8 +5,8 @@ globalThis.generateRelatedSlave = (function() {
* Generate a very similar relative for an existing slave (for use in Household Liquidators, for example).
* @param {App.Entity.SlaveState} slave - the source relative. Note: this slave is NOT changed, calling code is responsible for setting up the source end of the relationship!
* @param {string} relationship - the relationship that the new relative has with the source. Currently supports "parent", "child", "older sibling", "younger sibling", "twin".
- * @param {bool} oppositeSex - set to true if the new relative should be the opposite sex of the old one (otherwise it will be the same sex).
- * @returns {SlaveState} - new relative
+ * @param {boolean} oppositeSex - set to true if the new relative should be the opposite sex of the old one (otherwise it will be the same sex).
+ * @returns {App.Entity.SlaveState} - new relative
*/
function generateRelative(slave, relationship, oppositeSex=false) {
let relative = prepareClone(slave);
@@ -43,7 +43,7 @@ globalThis.generateRelatedSlave = (function() {
/**
* Clone the original slave and do some common preparations to it.
* @param {App.Entity.SlaveState} slave - the source relative
- * @returns {SlaveState} - the new relative
+ * @returns {App.Entity.SlaveState} - the new relative
*/
function prepareClone(slave) {
let relative = clone(slave);
@@ -218,7 +218,7 @@ globalThis.generateRelatedSlave = (function() {
slave.boobs += either(-100, 0, 100);
}
if (slave.butt > 1) {
- slave.butt += random(-1, 0, 1);
+ slave.butt += random(-1, 1);
}
}
diff --git a/src/js/itemAvailability.js b/src/js/itemAvailability.js
index 6897171593e49a8f7c095b2250e268f056f51bb6..436f5c092359b12f84136e3b0ca1468687f827f8 100644
--- a/src/js/itemAvailability.js
+++ b/src/js/itemAvailability.js
@@ -7,8 +7,8 @@ globalThis.isItemAccessible = (function() {
/**
* Checks whether an item is accessible
* @param {string} string Name of wearable item
- * @param {string} category that item is in clothing, collar, etc
- * @param {App.Entity.SlaveState} slave
+ * @param {string} [category="clothing"] that item is in clothing, collar, etc
+ * @param {App.Entity.SlaveState} [slave]
* @returns {boolean|string} Returns true if item is accessible, and false if it is not. If the slave param is set, it may sometimes return a string instead of false, explaining why the item can't be used with that slave.
*/
function entry(string, category = "clothing", slave) {
diff --git a/src/js/slaveCostJS.js b/src/js/slaveCostJS.js
index eac8847772f20c1eae38d006b07e5410bce8b860..79849ba90569f875b576bc90fe8e5df8c8beec59 100644
--- a/src/js/slaveCostJS.js
+++ b/src/js/slaveCostJS.js
@@ -1693,7 +1693,7 @@ globalThis.FResultArray = (function() {
let incestBonus;
/**
* @param {App.Entity.SlaveState} slave
- * @returns {number}
+ * @returns {{text:string, value:number}[]}
*/
function FResult(slave, forSale = 0) {
incestBonus = V.arcologies[0].FSEgyptianRevivalist > 20 || V.arcologies[0].FSEgyptianRevivalistIncestPolicy === 1;
diff --git a/src/js/utilsFC.js b/src/js/utilsFC.js
index f9755534ef33b849004afefcc3cfa70dea41fa7a..55cfb67de3bccb394a3537220f435b01b9490dc6 100644
--- a/src/js/utilsFC.js
+++ b/src/js/utilsFC.js
@@ -697,9 +697,9 @@ globalThis.Height = (function() {
/**
* @param {any} nationality
- * @param {any} race
- * @param {string} genes
- * @param {number} age
+ * @param {any} [race]
+ * @param {string} [genes]
+ * @param {number} [age]
* @returns {number}
*/
const _randomHeight = function(nationality, race, genes, age) {