diff --git a/devNotes/usefulJSFunctionDocumentation.md b/devNotes/usefulJSFunctionDocumentation.md
index 7a483acadca3fab27ef5907f18652f6b8016479f..ff02f275ab8fc975210af5ca71f70dd2be898088 100644
--- a/devNotes/usefulJSFunctionDocumentation.md
+++ b/devNotes/usefulJSFunctionDocumentation.md
@@ -1,4 +1,7 @@
-## Assay Functions ##
+# Useful Functions
+
+## Assay Functions
+
```js
isSlim(slave) // Returns if slave is considered slim or not by arcology standards.
@@ -149,12 +152,14 @@ canLift(actor1, actor2) // Returns if actor2 is capable of picking up and carryi
heelLength(slave) // Returns the length of a slave's heels should she be wearing any
```
-## Player Functions ##
+## Player Functions
+
```js
onBedRest(actor) // Returns if the actor is on mandatory bedrest or just incapable of leaving their bed. (Mostly for player use.)
```
-## Display Functions ##
+## Display Functions
+
```js
properTitle() // Returns the player's proper title. (customTitle, Sir, Ma'am)
@@ -177,74 +182,76 @@ SlaveTitle(slave) // Returns the slave's descriptive title.
relativeTerm(slave1, slave2) // Returns the term for slave2's relation to slave1. (daughter, mother, etc.)
relationshipChecks [script] All work as expected with <<if X.rivalryTarget == $slaves[$i].ID>> preceding them.
- rivalryTerm(id) // Returns the rivalry term for the input. e.g. lines 99-100 of brothelReport.
- //<<if $Madam.rivalryTarget == $slaves[$i].ID>>
- //$He forces $his <<print rivalryTerm($Madam)>>, to service all the men in the brothel.
- //Would print 'She forces her growing rival, to service all the men in the brothel.'
-
- relationshipTerm(id) Returns the long form relationship term for the input. e.g. lines 147-148 of saRules.
- //<<if $slaves[$i].relationship > 0>>
- //$He often asks to save these breaks so $he can spend them with $his <<print relationshipTerm($slaves[$i])>>.
- //Would print '$He often asks to save these breaks so $he can spend them with $his friend.'
-
- relationshipTermShort(id) Prints the short form of the above. e.g. line 321 of slaveInteract.
- //`"Fuck $him with $his <<print relationshipTermShort($activeSlave)>> <<= SlaveFullName($slaves[_si])>>"`
- //Would print 'Fuck $him with $his BFF <<= SlaveFullName($slaves[_si])>>'
-
- PCrelationshipTerm(id) Prints the relationship term for the input (relative to the PC) if the relationship is < -1.
- //<<if $slaves[$i].relationship < -1>>
- //$He loves being your <<print PCrelationshipTerm($slaves[$i])>>.
- //Would print '$He loves being your wife.'
-
- contextualIntro(context, actor, insertComma=false) // Introduces an actor by using any meaningful relationship(s) with an already on-screen actor, and their name.
- //Returns strings like: "your husband John", "his growing rival and mother Alice", or "her best friend and twin sister Carla".
- //If there is no known relationship between them, retuns the name alone. If insertComma is true, it will generate "her father, Dave" instead of "her father Dave".
- //Use this function instead of just printing the slave's name when you'd like to let the player to know if two actors are related, even though it's not going to have any mechanical impact on the scene.
+ rivalryTerm(id) // Returns the rivalry term for the input. e.g. lines 99-100 of brothelReport.
+ //<<if $Madam.rivalryTarget == $slaves[$i].ID>>
+ //$He forces $his <<print rivalryTerm($Madam)>>, to service all the men in the brothel.
+ //Would print 'She forces her growing rival, to service all the men in the brothel.'
+
+ relationshipTerm(id) Returns the long form relationship term for the input. e.g. lines 147-148 of saRules.
+ //<<if $slaves[$i].relationship > 0>>
+ //$He often asks to save these breaks so $he can spend them with $his <<print relationshipTerm($slaves[$i])>>.
+ //Would print '$He often asks to save these breaks so $he can spend them with $his friend.'
+
+ relationshipTermShort(id) Prints the short form of the above. e.g. line 321 of slaveInteract.
+ //`"Fuck $him with $his <<print relationshipTermShort($activeSlave)>> <<= SlaveFullName($slaves[_si])>>"`
+ //Would print 'Fuck $him with $his BFF <<= SlaveFullName($slaves[_si])>>'
+
+ PCrelationshipTerm(id) Prints the relationship term for the input (relative to the PC) if the relationship is < -1.
+ //<<if $slaves[$i].relationship < -1>>
+ //$He loves being your <<print PCrelationshipTerm($slaves[$i])>>.
+ //Would print '$He loves being your wife.'
+
+ contextualIntro(context, actor, insertComma=false) // Introduces an actor by using any meaningful relationship(s) with an already on-screen actor, and their name.
+ //Returns strings like: "your husband John", "his growing rival and mother Alice", or "her best friend and twin sister Carla".
+ //If there is no known relationship between them, returns the name alone. If insertComma is true, it will generate "her father, Dave" instead of "her father Dave".
+ //Use this function instead of just printing the slave's name when you'd like to let the player to know if two actors are related, even though it's not going to have any mechanical impact on the scene.
bellyAdjective(slave) // Returns a string describing her belly size.
-lispReplace(string) // Returns the string lispified.
+lispReplace(string) // Returns the string with a lisp.
nippleColor(slave) // Returns the slave's nipple color.
UtilJS [script]
- num() // Returns the value thousand separated with ',' if $formatNumbers > 0 else provides the raw value. Returns an integer if $showNumbers == 0, numbers up to a preset max as words if $showNumbers == 1, or only words if $showNumbers == 2.
- //line 138 of src/SpecialForce/Report.tw, '...focused their <<print num($SFUnit.Troops)>> troops'
- //if $formatNumbers > 0 'focused their 1,589 troops' else 'focused their 1589 troops'
- //if $showNumbers == 0 'focused their 1,589 troops', if $showNumbers == 1 'focused their 1,589 troops' (unless the max is set to more than 1,589), else 'focused their one thousand five hundred eighty-nine troops'
+ num() // Returns the value thousand separated with ',' if $formatNumbers > 0 else provides the raw value. Returns an integer if $showNumbers == 0, numbers up to a preset max as words if $showNumbers == 1, or only words if $showNumbers == 2.
+ //line 138 of src/SpecialForce/Report.tw, '...focused their <<print num($SFUnit.Troops)>> troops'
+ //if $formatNumbers > 0 'focused their 1,589 troops' else 'focused their 1589 troops'
+ //if $showNumbers == 0 'focused their 1,589 troops', if $showNumbers == 1 'focused their 1,589 troops' (unless the max is set to more than 1,589), else 'focused their one thousand five hundred eighty-nine troops'
- cashFormat() // uses the above function to return the value thousand separated with ',' if $formatNumbers > 0 else provides the raw value. either way prepends ¤ (the fc domination) symbol.
- //line 157 of the previously listed file, '...totaling @@.yellowgreen;<<print cashFormat(_SFIncome)>>@@'
- //if $formatNumbers > 0 'totaling @@.yellowgreen;¤1,500,000@@' else 'totaling @@.yellowgreen;¤1500000@@'
+ cashFormat() // uses the above function to return the value thousand separated with ',' if $formatNumbers > 0 else provides the raw value. either way prepends ¤ (the fc domination) symbol.
+ //line 157 of the previously listed file, '...totaling @@.yellowgreen;<<print cashFormat(_SFIncome)>>@@'
+ //if $formatNumbers > 0 'totaling @@.yellowgreen;¤1,500,000@@' else 'totaling @@.yellowgreen;¤1500000@@'
- isFloat() // Checks if value is float.
+ isFloat() // Checks if value is float.
- isInt() // Checks if value is an integer.
+ isInt() // Checks if value is an integer.
- numberWithCommas() // Currently unused.
+ numberWithCommas() // Currently unused.
- jsRandom() // JS equivalent of SugarCube's random().
+ jsRandom() // JS equivalent of SugarCube's random().
- jsRandomMany() // JS equivalent of SugarCube's randomMany().
+ jsRandomMany() // JS equivalent of SugarCube's randomMany().
- jsEither() // This function wants an array // which explains why it works like array.random(). Give it one or you'll face a NaN. JS equivalent of SugarCube's either() and array.random().
+ jsEither() // This function wants an array // which explains why it works like array.random(). Give it one or you'll face a NaN. JS equivalent of SugarCube's either() and array.random().
- deepCopy() // This function is alternative to clone // usage needed if nested objects present. Slower but result is separate object tree, not with reference to source object.
+ deepCopy() // This function is alternative to clone // usage needed if nested objects present. Slower but result is separate object tree, not with reference to source object.
- hashChoice() // hashes provided input.
+ hashChoice() // hashes provided input.
- hashSum() // totals provided input and then hashes.
+ hashSum() // totals provided input and then hashes.
- arr2obj() // Converts an array to an object. e.g. line 250 of :: init Nationalities [silently]
- <<set $nationalities = arr2obj(setup.baseNationalities)>>
+ arr2obj() // Converts an array to an object. e.g. line 250 of :: init Nationalities [silently]
+ <<set $nationalities = arr2obj(setup.baseNationalities)>>
- hashPush() //Note really sure where input is being pushed to.
+ hashPush() //Note really sure where input is being pushed to.
- weightedArray2HashMap()
+ weightedArray2HashMap()
- def() // Returns whether the input is defined, similar to SugarCube's def.
+ def() // Returns whether the input is defined, similar to SugarCube's def.
```
-## Core Slave Functions ##
+
+## Core Slave Functions
+
```js
newSlave(slave) // Adds slave object to main slave array. Do not use without care!
@@ -292,7 +299,7 @@ removeLimbs(slave, limb) // Remove limb(s) and clean up connected variables.
attachLimbs(slave, limb, id) // Attach limb(s). Expects amputated limbs, will overwrite existing.
//UtilJS [script]
- Height.mean(nationality, race, genes, age) // returns the mean height for the given combination and age in years (>=2).
+ Height.mean(nationality, race, genes, age) // returns the mean height for the given combination and age in years (>=2).
Height.mean(nationality, race, genes) // returns the mean adult height for the given combination.
Height.mean(slave) // returns the mean (expected) height for the given slave.
@@ -313,7 +320,9 @@ attachLimbs(slave, limb, id) // Attach limb(s). Expects amputated limbs, will ov
getSlaveTrustClass(slave) // returns the trust of the target as text. e.g. if (slave.trust < -95) return 'extremely-terrified';
```
-## Health Functions ##
+
+## Health Functions
+
```js
setHealth(slave, condition, shortDamage, longDamage, illness, tired) // Sets the health (primarily) of new slaves, it helps ensure the desired values do not immediately kill the slave and corrects them if needed
@@ -327,7 +336,9 @@ illness(slave) // A start of the 'end week loop' function to see if a slave has
endWeekHealthDamage // An end of the 'end week loop' function to move shortDamage to the appropriate longer term variables and such.
```
-## Sex Functions ##
+
+## Sex Functions
+
```js
knockMeUp(actor, chance, hole, fatherID, displayOverride) // Attempts to impregnate actor.
@@ -349,19 +360,21 @@ SimpleSexAct.Slaves(slave1, slave2, count) // Runs a slave2 on slave1 sex act co
//UtilJS [script]
- dickToInchString() // takes a dick value e.g. $activeSlave.dick, returns a string in the format 6 inches
+ dickToInchString() // takes a dick value e.g. $activeSlave.dick, returns a string in the format 6 inches
- dickToCM() // takes a dick value e.g. $activeSlave.dick, returns an int of the dick length in cm
+ dickToCM() // takes a dick value e.g. $activeSlave.dick, returns an int of the dick length in cm
- ballsToInchString() // takes a ball value e.g. $activeSlave.balls, returns a string in the format 3 inches
+ ballsToInchString() // takes a ball value e.g. $activeSlave.balls, returns a string in the format 3 inches
- ballsToCM() // takes a ball value e.g. $activeSlave.balls, returns an int of the ball size in cm
+ ballsToCM() // takes a ball value e.g. $activeSlave.balls, returns an int of the ball size in cm
- dickToEitherUnit() // takes a dick value e.g. $activeSlave.dick, returns a string in the format of either `20cm (8 inches)`, `8 inches`, or `20cm`
+ dickToEitherUnit() // takes a dick value e.g. $activeSlave.dick, returns a string in the format of either `20cm (8 inches)`, `8 inches`, or `20cm`
- ballsToEitherUnit() // takes a ball value e.g. $activeSlave.balls, returns a string in the format of either `20cm (8 inches)`, `8 inches`, or `20cm`
+ ballsToEitherUnit() // takes a ball value e.g. $activeSlave.balls, returns a string in the format of either `20cm (8 inches)`, `8 inches`, or `20cm`
```
-## Pregnancy Functions ##
+
+## Pregnancy Functions
+
```js
WombInit($slave) // before first pregnancy, at slave creation, of as backward compatibility update.
@@ -375,13 +388,15 @@ $children = WombBirth($slave, $birth_ready_age) // for actual birth. Return arra
WombFlush($slave) // clean womb (array). Can be used at broodmother birthstorm or abortion situations in game. But birthstorm logically should use WombBirth($slave, 35) or so before // some children in this event is live capable, others is not.
-TerminatePregnancy($slave) // end a pregancy early, clean the womb, update the belly size, and automatically set an appropriate postpartum length.
+TerminatePregnancy($slave) // end a pregnancy early, clean the womb, update the belly size, and automatically set an appropriate postpartum length.
$slave.bellyPreg = WombGetVolume($slave) // return double, with current womb volume in CC // for updating $slave.bellyPreg, or if need to update individual fetuses sizes.
findFather(ID) // searches for the ID given and returns an object or undefined
```
-## Release Functions ##
+
+## Release Functions
+
```js
sexAllowed // returns true if both slaves are allowed to have sex with each other. All non-assignment sex should check here first; use disobedience() to determine if the slave or slaves involved will ignore the rules.
@@ -393,31 +408,33 @@ hasNonassignmentSex // returns true if the slave is having some kind of sex whil
releaseRestricted // returns true if the slave has some kind of rule limiting the off-duty sex they have. If it returns false, the slave is completely free to fuck whomever they want.
```
-## Other Functions ##
+
+## Other Functions
+
```js
//UtilJS [script]
- cmToInchString() // takes an integer e.g. $activeSlave.hLength, returns a string in the format 10 inches
+ cmToInchString() // takes an integer e.g. $activeSlave.hLength, returns a string in the format 10 inches
- cmToFootInchString() // takes an integer e.g. $activeSlave.height, returns a string in the format 6'5"
+ cmToFootInchString() // takes an integer e.g. $activeSlave.height, returns a string in the format 6'5"
- lengthToEitherUnit() // takes an int in centimeters e.g. $activeSlave.hLength, returns a string in the format of either `30cm (12 inches)`, `12 inches`, or `30cm`
+ lengthToEitherUnit() // takes an int in centimeters e.g. $activeSlave.hLength, returns a string in the format of either `30cm (12 inches)`, `12 inches`, or `30cm`
- ValidateFacilityDecoration() // checks the value of the associated variable and it if it infinite i.e. NA the text description is reset back to standard.
- /* decoration should be passed as "facilityDecoration" in quotes. For example, ValidateFacilityDecoration("brothelDecoration"). The quotes are important, do not pass it as a story variable. */
+ ValidateFacilityDecoration() // checks the value of the associated variable and it if it infinite i.e. NA the text description is reset back to standard.
+ /* decoration should be passed as "facilityDecoration" in quotes. For example, ValidateFacilityDecoration("brothelDecoration"). The quotes are important, do not pass it as a story variable. */
- FSChangePorn() // //Currently unused, widget version routes directly through FSChange()
+ FSChangePorn() // //Currently unused, widget version routes directly through FSChange()
- HackingSkillMultiplier() // outputs a value based off of the PC's hacking skill.
+ HackingSkillMultiplier() // outputs a value based off of the PC's hacking skill.
- upgradeMultiplierArcology() // outputs a value based off of the PC's engineering skill.
+ upgradeMultiplierArcology() // outputs a value based off of the PC's engineering skill.
- upgradeMultiplierMedicine() // outputs a value based off of the PC's medicine skill.
+ upgradeMultiplierMedicine() // outputs a value based off of the PC's medicine skill.
- upgradeMultiplierTrade() // outputs a value based off of the PC's trading skill.
+ upgradeMultiplierTrade() // outputs a value based off of the PC's trading skill.
- passageLink() // Creates a HTML element with custom SugarCube attributes which works as a passage link
+ passageLink() // Creates a HTML element with custom SugarCube attributes which works as a passage link
- SkillIncrease() // Depreciates the SugarCube functions.
+ SkillIncrease() // Depreciates the SugarCube functions.
- disobedience // Returns a 0-100 value indicating likelihood of a slave ignoring the rules.
-```
\ No newline at end of file
+ disobedience // Returns a 0-100 value indicating likelihood of a slave ignoring the rules.
+```