From 2a64f811ada7c83d74f1ed0569a03414cfd46ff2 Mon Sep 17 00:00:00 2001
From: lowercasedonkey <lowercasedonkey@gmail.com>
Date: Mon, 29 Jun 2020 20:34:31 -0400
Subject: [PATCH] jsdoc
---
js/003-data/policiesData.js | 29 +++++++++++++++-------------
src/interaction/policies/policies.js | 11 +++++++----
src/interaction/policies/policies.tw | 7 +++++++
3 files changed, 30 insertions(+), 17 deletions(-)
diff --git a/js/003-data/policiesData.js b/js/003-data/policiesData.js
index ca1119481c3..a06e24dc7ab 100644
--- a/js/003-data/policiesData.js
+++ b/js/003-data/policiesData.js
@@ -1,6 +1,21 @@
App.Data.Policies.Selection = {
SMR: {
"policies.SMR.basicSMR": [
+ /**
+ * @param {string} title The title of the policy as displayed in the UI, "Health Inspection SMR"
+ * @param {string} [titleClass] The class to apply to the title, "lime"
+ * @param {string} [activatedTitle] The title of the policy if the policy is active. Param "title" is used as a fallback.
+ * @param {string} text Text that describes the policy in detail.
+ * @param {string} [activatedText] Text that describes an active policy in detail. Uses param "text" as a fallback.
+ * @param {Function} [requirements] Function to determine if a policy can be enabled. Returns boolean.
+ * @param {Function} [onImplementation] Beyond applying the policy itself and billing the player, are there other values to change? This allows a shortstack FS policy to revoke some generic tall policies, for example. No return expected.
+ * @param {Function} [onRepeal] same as onImplementation, but fires when a policy is repealed.
+ * @param {number|string} [enable] Value to enable a policy. Defaults to 1 if not defined.
+ * @param {object} [hide] Object controling special hide settings that can hide parts of the policy if needed.
+ * @param {number} [hide.button] Hides the appeal/repeal button if 1
+ * @param {number} [hide.ifActivated] Hides the entire policy if the policy is applied. 1 to enable.
+ * @param {string} [note] Note that appears at the end of the policy display in italics to present further information.
+ */
{
title: "Basic SMR",
text: "the slave market is subject to very basic regulations designed to offer buyers some confidence.",
@@ -1729,18 +1744,6 @@ App.Data.Policies.Selection = {
note: `Will increase your rental income, but the lower class will dislike you.`
}
],
- "propOutcome": [
- {
- title: "Elite Breeder Eligibility",
- text: "Societal Elite may use eligible slaves as breeders.",
- hide: {button: 1, ifDeactivated: 1}
- },
- {
- title: "Elite Breeder Eligibility",
- text: "The Societal Elite have rejected your breeding proposal",
- hide: {button: 1, ifDeactivated: 1}
- },
- ],
"arcologies[0].FSRestartResearch": [
{
title: "Elite Breeder Eligibility",
@@ -1750,7 +1753,7 @@ App.Data.Policies.Selection = {
onImplementation: function() {
repX(-4000, "policies");
},
- hide: {ifActivated: 1},
+ hide: {ifActivated: 1}, // Repeal is not possible.
note: `Will greatly damage your reputation for even proposing.`
}
],
diff --git a/src/interaction/policies/policies.js b/src/interaction/policies/policies.js
index b4c03bc84ad..3a35429d4e0 100644
--- a/src/interaction/policies/policies.js
+++ b/src/interaction/policies/policies.js
@@ -107,8 +107,8 @@ globalThis.policies = (function() {
function cost() { return 5000; }
})();
/**
- * @param {Array} category
- * @returns {node}
+ * @param {string} category
+ * @returns {JQuery}
*/
globalThis.policy = function(category) {
const frag = new DocumentFragment;
@@ -116,7 +116,10 @@ globalThis.policy = function(category) {
frag.append(policyElement(policyVariable));
}
return jQuery(`#${category}`).empty().append(frag);
-
+ /**
+ * @param {string} policyVariable
+ * @returns {node} el
+ */
function policyElement(policyVariable) {
let el = document.createElement("p");
let div;
@@ -129,7 +132,7 @@ globalThis.policy = function(category) {
for (let i = 0; i < policyObject.length; i++) {
const p = policyObject[i];
const enable = p.enable || 1;
- if ((p.hasOwnProperty("hide") && p.hide.ifDeactivated === 1) || (p.hasOwnProperty("requirements") && p.requirements() === false)) { // TODO: may no longer need ifDeactivated and similar
+ if (p.hasOwnProperty("requirements") && p.requirements() === false) {
continue;
}
div = document.createElement("div");
diff --git a/src/interaction/policies/policies.tw b/src/interaction/policies/policies.tw
index 2899043eab9..db05994bc59 100644
--- a/src/interaction/policies/policies.tw
+++ b/src/interaction/policies/policies.tw
@@ -312,6 +312,13 @@
<<if $arcologies[0].FSRestart >= 40 || $arcologies[0].FSSupremacist >= 40 || V.arcologies[0].FSSubjugationist >= 40>>
<h2>Race</h2>
+ <div>
+ <<if $propOutcome>>
+ ''Elite Breeder Eligibility:'' Societal Elite may use eligible slaves as breeders.
+ <<elseif $propOutcome == -1>>
+ ''Elite Breeder Eligibility:'' The Societal Elite have rejected your breeding proposal.
+ <</if>>
+ </div>
<span id="FSRestart"></span>
<script>
policy("FSRestart");
--
GitLab