From 4919fb7496a777e033402e976a54e6c1243f9302 Mon Sep 17 00:00:00 2001
From: Skriv <skrivelese@gmail.com>
Date: Fri, 14 Feb 2020 17:59:44 +0100
Subject: [PATCH] whitespace and JSDoc
---
src/js/DefaultRules.js | 105 +++++++++++++++++++++--------------------
1 file changed, 54 insertions(+), 51 deletions(-)
diff --git a/src/js/DefaultRules.js b/src/js/DefaultRules.js
index 7d3741db213..1f1636d69e2 100644
--- a/src/js/DefaultRules.js
+++ b/src/js/DefaultRules.js
@@ -1,37 +1,37 @@
// this code applies RA rules onto slaves
-
window.DefaultRules = (function() {
"use strict";
const assignedTypes = {
- "auto": {success:"has been automatically assigned", unable: "could not be assigned"},
- "allowed": {success:"is allowed", unable: "could not be allowed"},
+ "auto": {success: "has been automatically assigned", unable: "could not be assigned"},
+ "allowed": {success: "is allowed", unable: "could not be allowed"},
};
- const getAssignmentDescription = function({rule, slave, assignmentResult, append=null}) {
+ const getAssignmentDescription = function({rule, slave, assignmentResult, append = null}) {
const job = App.Utils.jobForAssignment(rule.setAssignment).desc;
let work = job.assignment;
let descriptionType = "auto";
const assignmentInfo = (job.description || {}).rulesAssistant;
- if(assignmentInfo != null) {
- if(assignmentInfo.assigned != null) {
+ if (assignmentInfo != null) {
+ if (assignmentInfo.assigned != null) {
work = assignmentInfo.assigned({slave, pronouns, rule});
}
- if(assignmentInfo.assignedType != null) {
+ if (assignmentInfo.assignedType != null) {
descriptionType = assignmentInfo.assignedType;
}
}
const assignedTypeInfo = assignedTypes[descriptionType];
- if(assignedTypeInfo == null) { throw Error(`Unknown description type ${JSON.stringify(descriptionType)} in ${JSON.stringify(rule.setAssignment)}`); }
+ if (assignedTypeInfo == null) { throw Error(`Unknown description type ${JSON.stringify(descriptionType)} in ${JSON.stringify(rule.setAssignment)}`); }
const hasBeenAssigned = assignedTypeInfo[assignmentResult];
return `<br>${slave.slaveName} ${hasBeenAssigned} to ${work}${append || ''}.`;
};
+ /** @type {string} */
let r;
let pronouns, he, him, his;
/**
* @param {App.Entity.SlaveState} slave
- * @returns {object}
+ * @returns {string}
*/
function DefaultRules(slave) {
if (slave.useRulesAssistant === 0) { return r; } // exempted
@@ -108,7 +108,7 @@ window.DefaultRules = (function() {
/** @type {App.RA.Rule[]} */
const rules = V.defaultRules.filter((x) => ruleAppliesP(x.condition, slave));
const ruleIds = [], assignments = [];
- for(const rule of rules) {
+ for (const rule of rules) {
ruleIds.push(rule.ID);
assignments.push(ProcessAssignments(slave, Object.assign({}, rule.set)));
}
@@ -149,8 +149,8 @@ window.DefaultRules = (function() {
removeAssignment();
} else if (!job.facility.hasFreeSpace) {
r += getAssignmentDescription({
- rule, slave, assignmentResult:"unable",
- append:" because it was full"
+ rule, slave, assignmentResult: "unable",
+ append: " because it was full"
});
removeAssignment();
}
@@ -167,7 +167,7 @@ window.DefaultRules = (function() {
// place slave on assignment defined by the rule
if ((rule.setAssignment !== undefined && rule.setAssignment !== null)) {
if (((rule.setAssignment === "choose her own job" && !slave.choosesOwnAssignment) || rule.setAssignment !== slave.assignment)) {
- r += getAssignmentDescription({rule, slave, assignmentResult:"success"});
+ r += getAssignmentDescription({rule, slave, assignmentResult: "success"});
assignJob(slave, rule.setAssignment);
}
}
@@ -522,7 +522,7 @@ window.DefaultRules = (function() {
/**
* @param {App.Entity.SlaveState} slave
- * @param {object} rule
+ * @param {App.RA.RuleSetters} rule
*/
function ProcessNonVirginDildos(slave, rule) {
// apply vaginal dildos to non-virgins
@@ -582,7 +582,7 @@ window.DefaultRules = (function() {
/**
* @param {App.Entity.SlaveState} slave
- * @param {object} rule
+ * @param {App.RA.RuleSetters} rule
*/
function ProcessVaginalAttachments(slave, rule) {
// apply vaginal accessories to slaves
@@ -622,7 +622,7 @@ window.DefaultRules = (function() {
/**
* @param {App.Entity.SlaveState} slave
- * @param {object} rule
+ * @param {App.RA.RuleSetters} rule
*/
function ProcessDickAccessories(slave, rule) {
// apply dick accessories to slave
@@ -655,7 +655,7 @@ window.DefaultRules = (function() {
/**
* @param {App.Entity.SlaveState} slave
- * @param {object} rule
+ * @param {App.RA.RuleSetters} rule
*/
function ProcessChastity(slave, rule) {
// apply chastity to slave
@@ -697,7 +697,7 @@ window.DefaultRules = (function() {
/**
* @param {App.Entity.SlaveState} slave
- * @param {object} rule
+ * @param {App.RA.RuleSetters} rule
*/
function ProcessShoes(slave, rule) {
// apply shoes to slave
@@ -713,7 +713,7 @@ window.DefaultRules = (function() {
/**
* @param {App.Entity.SlaveState} slave
- * @param {object} rule
+ * @param {App.RA.RuleSetters} rule
*/
function ProcessBellyAccessories(slave, rule) {
// apply belly accessories to slave
@@ -736,7 +736,7 @@ window.DefaultRules = (function() {
/**
* @param {App.Entity.SlaveState} slave
- * @param {object} rule
+ * @param {App.RA.RuleSetters} rule
*/
function ProcessArmAccessory(slave, rule) {
if (rule.armAccessory !== undefined && rule.armAccessory !== null && hasAnyArms(slave) && slave.armAccessory !== rule.armAccessory) {
@@ -747,7 +747,7 @@ window.DefaultRules = (function() {
/**
* @param {App.Entity.SlaveState} slave
- * @param {object} rule
+ * @param {App.RA.RuleSetters} rule
*/
function ProcessLegAccessory(slave, rule) {
if (rule.legAccessory !== undefined && rule.legAccessory !== null && hasAnyLegs(slave) && slave.legAccessory !== rule.legAccessory) {
@@ -758,7 +758,7 @@ window.DefaultRules = (function() {
/**
* @param {App.Entity.SlaveState} slave
- * @param {object} rule
+ * @param {App.RA.RuleSetters} rule
*/
function ProcessAnalAccessories(slave, rule) {
// apply buttplugs and buttplug accessories to slave
@@ -774,7 +774,7 @@ window.DefaultRules = (function() {
/**
* @param {App.Entity.SlaveState} slave
- * @param {object} rule
+ * @param {App.RA.RuleSetters} rule
*/
function ProcessAnalVirginButtplugs(slave, rule) {
// apply buttplugs to virgins
@@ -835,7 +835,7 @@ window.DefaultRules = (function() {
/**
* @param {App.Entity.SlaveState} slave
- * @param {object} rule
+ * @param {App.RA.RuleSetters} rule
*/
function ProcessNonVirginButtplugs(slave, rule) {
// apply buttplugs to non-virgins
@@ -896,7 +896,7 @@ window.DefaultRules = (function() {
/**
* @param {App.Entity.SlaveState} slave
- * @param {object} rule
+ * @param {App.RA.RuleSetters} rule
*/
function ProcessButtplugAttachments(slave, rule) {
// apply buttplug accessories to slaves
@@ -922,7 +922,7 @@ window.DefaultRules = (function() {
/**
* @param {App.Entity.SlaveState} slave
- * @param {object} rule
+ * @param {App.RA.RuleSetters} rule
*/
function ProcessBellyImplant(slave, rule) {
// Here is belly implant size control, it's used in Surgery Degradation passage to setup devotion and trust changes.
@@ -1004,7 +1004,7 @@ window.DefaultRules = (function() {
/**
* @param {App.Entity.SlaveState} slave
- * @param {object} rule
+ * @param {App.RA.RuleSetters} rule
*/
function ProcessContraceptives(slave, rule) {
if ((rule.preg !== undefined) && (rule.preg !== null)) {
@@ -1020,7 +1020,7 @@ window.DefaultRules = (function() {
/**
* @param {App.Entity.SlaveState} slave
- * @param {object} rule
+ * @param {App.RA.RuleSetters} rule
*/
function ProcessAbortions(slave, rule) {
if ((rule.abortion !== undefined) && (rule.abortion !== null)) {
@@ -1444,7 +1444,7 @@ window.DefaultRules = (function() {
/**
* @param {App.Entity.SlaveState} slave
- * @param {object} rule
+ * @param {App.RA.RuleSetters} rule
*/
function ProcessEnema(slave, rule) {
if ((rule.inflationType !== undefined) && (rule.inflationType !== null)) {
@@ -1663,7 +1663,7 @@ window.DefaultRules = (function() {
/**
* @param {App.Entity.SlaveState} slave
- * @param {object} rule
+ * @param {App.RA.RuleSetters} rule
*/
function ProcessCuratives(slave, rule) {
if ((rule.curatives !== undefined) && (rule.curatives !== null)) {
@@ -1688,7 +1688,7 @@ window.DefaultRules = (function() {
/**
* @param {App.Entity.SlaveState} slave
- * @param {object} rule
+ * @param {App.RA.RuleSetters} rule
*/
function ProcessAphrodisiacs(slave, rule) {
if ((rule.aphrodisiacs !== undefined) && (rule.aphrodisiacs !== null)) {
@@ -1701,7 +1701,7 @@ window.DefaultRules = (function() {
/**
* @param {App.Entity.SlaveState} slave
- * @param {object} rule
+ * @param {App.RA.RuleSetters} rule
*/
function ProcessPenisHormones(slave, rule) {
if ((slave.dick > 0)) {
@@ -1743,7 +1743,7 @@ window.DefaultRules = (function() {
/**
* @param {App.Entity.SlaveState} slave
- * @param {object} rule
+ * @param {App.RA.RuleSetters} rule
*/
function ProcessFemaleHormones(slave, rule) {
if ((slave.vagina > -1) && (slave.dick === 0) && (rule.XX !== undefined) && (rule.XX !== null)) {
@@ -1762,7 +1762,7 @@ window.DefaultRules = (function() {
/**
* @param {App.Entity.SlaveState} slave
- * @param {object} rule
+ * @param {App.RA.RuleSetters} rule
*/
function ProcessPregnancyDrugs(slave, rule) {
if (slave.pregKnown === 1 && rule.pregSpeed !== null && (slave.breedingMark !== 1 || V.propOutcome === 0 || V.eugenicsFullControl === 1 || V.arcologies[0].FSRestart === "unset") && slave.indentureRestrictions < 1 && slave.broodmother === 0) {
@@ -1792,7 +1792,7 @@ window.DefaultRules = (function() {
/**
* @param {App.Entity.SlaveState} slave
- * @param {object} rule
+ * @param {App.RA.RuleSetters} rule
*/
function ProcessLivingStandard(slave, rule) {
if ((rule.livingRules !== undefined) && (rule.livingRules !== null)) {
@@ -1829,7 +1829,7 @@ window.DefaultRules = (function() {
/**
* @param {App.Entity.SlaveState} slave
- * @param {object} rule
+ * @param {App.RA.RuleSetters} rule
*/
function ProcessSpeech(slave, rule) {
if ((rule.speechRules !== undefined) && (rule.speechRules !== null) && (slave.rules.speech !== rule.speechRules)) {
@@ -1863,7 +1863,7 @@ window.DefaultRules = (function() {
/**
* @param {App.Entity.SlaveState} slave
- * @param {object} rule
+ * @param {App.RA.RuleSetters} rule
*/
function ProcessRelationship(slave, rule) {
if ((slave.fetish !== "mindbroken")) {
@@ -1878,7 +1878,7 @@ window.DefaultRules = (function() {
/**
* @param {App.Entity.SlaveState} slave
- * @param {object} rule
+ * @param {App.RA.RuleSetters} rule
*/
function ProcessRelease(slave, rule) {
if ((rule.releaseRules !== undefined) && (rule.releaseRules !== null)) {
@@ -1905,7 +1905,7 @@ window.DefaultRules = (function() {
/**
* @param {App.Entity.SlaveState} slave
- * @param {object} rule
+ * @param {App.RA.RuleSetters} rule
*/
function ProcessPunishment(slave, rule) {
if ((rule.standardPunishment !== undefined) && (rule.standardPunishment !== null)) {
@@ -1918,7 +1918,7 @@ window.DefaultRules = (function() {
/**
* @param {App.Entity.SlaveState} slave
- * @param {object} rule
+ * @param {App.RA.RuleSetters} rule
*/
function ProcessReward(slave, rule) {
if ((rule.standardReward !== undefined) && (rule.standardReward !== null)) {
@@ -1931,7 +1931,7 @@ window.DefaultRules = (function() {
/**
* @param {App.Entity.SlaveState} slave
- * @param {object} rule
+ * @param {App.RA.RuleSetters} rule
*/
function ProcessToyHole(slave, rule) {
if ((rule.toyHole !== undefined) && (rule.toyHole !== null)) {
@@ -1968,7 +1968,7 @@ window.DefaultRules = (function() {
/**
* @param {App.Entity.SlaveState} slave
- * @param {object} rule
+ * @param {App.RA.RuleSetters} rule
*/
function ProcessDietCum(slave, rule) {
if ((rule.dietCum !== undefined) && (rule.dietCum !== null)) {
@@ -1988,7 +1988,7 @@ window.DefaultRules = (function() {
/**
* @param {App.Entity.SlaveState} slave
- * @param {object} rule
+ * @param {App.RA.RuleSetters} rule
*/
function ProcessDietMilk(slave, rule) {
if ((rule.dietMilk !== undefined) && (rule.dietMilk !== null)) {
@@ -2008,7 +2008,7 @@ window.DefaultRules = (function() {
/**
* @param {App.Entity.SlaveState} slave
- * @param {object} rule
+ * @param {App.RA.RuleSetters} rule
*/
function ProcessSolidFood(slave, rule) {
if ((rule.onDiet !== undefined) && (rule.onDiet !== null)) {
@@ -2025,7 +2025,7 @@ window.DefaultRules = (function() {
/**
* @param {App.Entity.SlaveState} slave
- * @param {object} rule
+ * @param {App.RA.RuleSetters} rule
*/
function ProcessTeeth(slave, rule) {
if ((rule.teeth !== undefined) && (rule.teeth !== null)) {
@@ -2286,7 +2286,10 @@ window.DefaultRules = (function() {
}
}
- /** @param {App.Entity.SlaveState} slave */
+ /**
+ * @param {App.Entity.SlaveState} slave
+ * @param {App.RA.RuleSetters} rule
+ */
function ProcessPiercings(slave, rule) {
if (rule.nipplesPiercing !== undefined && (rule.nipplesPiercing !== null)) {
if ((slave.nipplesPiercing !== rule.nipplesPiercing)) {
@@ -2479,7 +2482,7 @@ window.DefaultRules = (function() {
/**
* @param {App.Entity.SlaveState} slave
- * @param {object} rule
+ * @param {App.RA.RuleSetters} rule
*/
function ProcessSmartPiercings(slave, rule) {
if ((slave.clitPiercing === 3)) {
@@ -2549,7 +2552,7 @@ window.DefaultRules = (function() {
/**
* @param {App.Entity.SlaveState} slave
- * @param {object} rule
+ * @param {App.RA.RuleSetters} rule
*/
function ProcessTattoos(slave, rule) {
if (rule.boobsTat !== undefined && (rule.boobsTat !== null)) {
@@ -2833,7 +2836,7 @@ window.DefaultRules = (function() {
/**
* @param {App.Entity.SlaveState} slave
- * @param {object} rule
+ * @param {App.RA.RuleSetters} rule
*/
function ProcessPornFeedEnabled(slave, rule) {
if (rule.pornFeed === undefined || rule.pornFeed == null) {
@@ -2911,13 +2914,13 @@ window.DefaultRules = (function() {
try {
// TODO: This should use a cached Function, which should be the same as below.
new Function(`return ${code}`);
- } catch(e) {
+ } catch (e) {
return false;
}
return true;
};
window.RuleHasError = (rule) => rule.condition.function === "custom"
- &&(rule.condition.data.match(rxCheckEqual)
+ && (rule.condition.data.match(rxCheckEqual)
|| !compileCheck(rule.condition.data));
window.DefaultRulesError = () => V.defaultRules.some(r => RuleHasError(r));
return DefaultRules;
--
GitLab