From 0efd7ec262e4b9588fc14f28becade32515a090a Mon Sep 17 00:00:00 2001 From: Svornost <11434-svornost@users.noreply.gitgud.io> Date: Wed, 25 Dec 2019 17:42:10 -0800 Subject: [PATCH] Document new utility functions for release and disobedience --- devNotes/Useful JS Function Documentation.txt | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/devNotes/Useful JS Function Documentation.txt b/devNotes/Useful JS Function Documentation.txt index 2953c34658c..b8ff71e8f8b 100644 --- a/devNotes/Useful JS Function Documentation.txt +++ b/devNotes/Useful JS Function Documentation.txt @@ -354,6 +354,19 @@ $slave.bellyPreg = WombGetWolume($slave) - return double, with current womb volu findFather(ID) - searches for the ID given and returns an object or undefined +Release Functions: + +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. + +hasPartnerSex - returns true if the slave has a romantic partner, the relationship is sexual, and they are allowed to sex. Unless you are specifically checking the theoretical rule, check this instead of rules.release.partner. + +hasFamilySex - returns true if the slave has a close family member, they are allowed to have sex, and the player is OK with seeing the result. Unless you are specifically checking the theoretical rule, check this instead of rules.release.family. + +hasNonassignmentSex - returns true if the slave is having some kind of sex while off-duty with a partner other than the PC. This function provides the answer to "can I mention this slave having an off-duty sexual encounter of some kind." + +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: isItemAccessible(itemName) - Returns if the string is available for use. Defaults to true. @@ -384,3 +397,4 @@ UtilJS [script] SkillIncrease() - Depreciates the sugarcube functions. + disobedience - Returns a 0-100 value indicating likelyhood of a slave ignoring the rules. -- GitLab