From fb27e528f5c6895754cb8e083659e4f6c2b96ea3 Mon Sep 17 00:00:00 2001
From: Svornost <11434-svornost@users.noreply.gitgud.io>
Date: Mon, 27 Apr 2020 21:18:05 -0700
Subject: [PATCH] JSDoc
---
src/npc/startingGirls/startingGirls.js | 25 +++++++++++++++++--------
1 file changed, 17 insertions(+), 8 deletions(-)
diff --git a/src/npc/startingGirls/startingGirls.js b/src/npc/startingGirls/startingGirls.js
index 98b217c3fba..49ca6bc9339 100644
--- a/src/npc/startingGirls/startingGirls.js
+++ b/src/npc/startingGirls/startingGirls.js
@@ -1,6 +1,8 @@
App.StartingGirls = {};
-/* Generate a new slave for the starting girls passage */
+/** Generate a new slave for the starting girls passage
+ * @returns {App.Entity.SlaveState}
+ */
App.StartingGirls.generate = function(params) {
let slave = GenerateNewSlave(null, params);
setHealth(slave, 0);
@@ -15,7 +17,9 @@ App.StartingGirls.generate = function(params) {
return slave;
};
-/* Make sure user-entered values aren't crazy for starting girls */
+/** Make sure user-entered values aren't crazy for starting girls
+ * @param {App.Entity.SlaveState} slave
+ */
App.StartingGirls.cleanup = function(slave) {
slave.actualAge = Math.clamp(slave.actualAge, V.minimumSlaveAge, V.retirementAge-1) || 18;
slave.physicalAge = slave.actualAge;
@@ -91,7 +95,9 @@ App.StartingGirls.cleanup = function(slave) {
}
};
-/* Starting girl PC career bonus */
+/** Apply starting girl PC career bonus
+ * @param {App.Entity.SlaveState} slave
+ */
App.StartingGirls.applyCareerBonus = function(slave) {
function applySexSkillBonus() {
let _seed = 2;
@@ -135,7 +141,7 @@ App.StartingGirls.applyCareerBonus = function(slave) {
slave.trust += 10;
slave.devotion += 10;
} else if (V.PC.career === "gang") {
- increaseCondition(slave, 5);
+ improveCondition(slave, 5);
if (slave.skill.combat < 1) {
slave.skill.combat += 1;
}
@@ -167,7 +173,9 @@ App.StartingGirls.applyCareerBonus = function(slave) {
}
};
-/* randomize things the player doesn't know about the slave */
+/** Randomize things the player doesn't know about the slave
+ * @param {App.Entity.SlaveState} slave
+ */
App.StartingGirls.randomizeUnknowns = function(slave) {
if (slave.attrKnown === 0) {
slave.attrXX = random(0, 100);
@@ -180,8 +188,7 @@ App.StartingGirls.randomizeUnknowns = function(slave) {
}
};
-/**
- * Generate a pipe-separated list of slaves with a given mother or father
+/** Generate a pipe-separated list of slaves with a given mother or father
* @param {string} parent - "mother" or "father"
* @param {number} id - parent's slave ID
* @returns {string}
@@ -199,7 +206,9 @@ App.StartingGirls.listOfSlavesWithParent = function(parent, id) {
return slaveNames.join(" | ");
};
-/* renders the family tree with an uncommitted slave */
+/** Render the family tree with an uncommitted slave
+ * @param {App.Entity.SlaveState} slave
+ */
App.StartingGirls.uncommittedFamilyTree = function(slave) {
let tSlaves = V.slaves.concat([slave]); // returns a new array
renderFamilyTree(tSlaves, slave.ID);
--
GitLab