Forbidden Love - Set Relationship Bits 0.0.7

This is a script mod and meant for fictional game play. In real life there is no 'reboot'. Don't hurt the feelings of people you love and/or interact with. Depending on where you live such relationships in real life might be illegal.

Sims are objects and if you don't go along here and think of them as 'people' or 'animals' please don't use this mod but consult professional help.

This mod allows to set or remove relationship bits for sims, including humans, foxes, cats, dogs and hopefully also horses.
TS4 sets the engage relationship bit already for random sims, even if they are married. Anyhow, the active sim can't initiate such engagements while this mod supports this.
TS4 blocks engagement and marriage without romance and it blocks multiple marriages. In TS4 with fictional money (cheats) there is likely no need to get married to a 2nd sim to protect them from poverty. While for role playing one might want to be able to set such bits. Even in the Bible one may read about the 1000 wives of Solomon.

This mod allows:

• Kids-play temporary marriages for Toddlers and Children (within this age group, cleared on zone-teardown).
• Teen, Young Adult, Adult, Elder and Pets to marry within this group without limits.
• Multiple engagements and marriages for a single sim.
• To terminate an engagement or marriage.

This mod does not:

• Check any friendship or romance settings so a 'forced', 'paid' or 'strategic' engagement or marriage is possible.

• Play romance animations.

• Support any Woohoo or Romance interactions. Vanilla Woohoo and Romance interactions should work normally.

• Support Babies and/or Infants

• Suppress buffs TS4 adds to sims after engagement or marriage, so sims may be happy to be forced into something.
• Suppress jealousy broadcasters. Sims should be careful what they do unless another mod takes care about this.

### Known Issues

• Engagement doesn't always work as expected and the bits are not set in both ways.
• TS4 doesn't yet show multiple marriages while the developers might add this feature.

## Laws and Regulations
(These should be fake news copied from other websites unless one guy back in 1850 was crazy enough to write this.)
In the book of California’s State Laws and Regulations there is a little known law that was passed as the state was being formed in 1850. Article 155, paragraph 10, clearly states: “If a man and a man can get married and a woman and a woman can get married, if ever comes that day, then a human and animal will have the exact same rights to marriage in every eye of the law. God help us if this ever is to happen!”


## Pie Menu Actions
Shift-Click on any sim or pet and select 'Forbidden Love' (likely on 2nd or 3rd page):

• 'Engage' tries to engage the active (or from memory) sim and the selected sim.
• 'Marry' tries to marry the active (or from memory) sim and the selected sim.
• 'Show All' logs all 'inappropriate' relationship bits. As it doesn't really fit in a notification popup please look at the log.
• 'Break Engagement' undo for 'Engage'
• 'Divorce' undo for 'Marry'
• 'Select Sim' - Store a sim in memory for all further 'Engage', 'Marry', 'Break Engagement' and 'Divorce' interactions with random target sims.
• 'Clear selected Sim' - Clear the memorized sim - all interactions will reference the active sim and the target sim.

### Select Sim
'Select Sim' allows to select an NPC human/pet and then engage it with a 2nd NPC human/pet.

E.g. select a random NPC townie to marry it with one or more random NPC sims which are nearby.
E.g. select 'Bella Goth' > 'Select Sim' and then select 'Mortimer Goth' > 'Divorce'.

## Additional Requirements
For the cheat commands to work TS4-SimCache https://github.com/Oops19/TS4-SimCache/releases/latest/ is needed. This is a small library which caches all sims and allows easy access.
To specify a sim one usually needs to specify the sim_id or first_name and last_name. This works fine, but it may be a lot to type.
With SimCache the sim_name (originally defined by scumbumbo as 'first_name#last_name') is used. Only one parameter is specified, like "Bella#Goth".
SimCache also searches for sims if the name doesn't match. 'b#g' may match 'Bella#Goth' or any other sim with 'b' and 'g' in the name. With 'be#go' or 'b#goth' one can be quite sure to get 'Bella#Goth'.
Also, 'a#h' can find 'Bella#Goth' as the characters match somehow. If a sim with these initials exists it will be preferred and if other sims with these letters in the name exist they might be chosen.

### Cheat commands
Make sure to install TS4-SimCache to use them!

• `o19.love.show` prints all romance bits which are set for 2+ other sims.
• `o19.love sim_name_1 sim_name_2` - Only show and check the selected sim names ('b#g' may (not) expand to 'Bella#Goth)
• `o19.love sim_name_1 sim_name_2 e` - Engage sim1 and sim2
• `o19.love sim_name_1 sim_name_2 e -` - Break Engagement of sim1 and sim2
• `o19.love sim_name_1 sim_name_2 m` - Marry sim1 and sim2
• `o19.love sim_name_1 sim_name_2 m -` - Divorce sim1 and sim2

## Game compatibility
This mod has been tested with `The Sims 4` 1.98.158 (2023-06), S4CL 2.7 (2023-06), TS4Lib 0.0.24 (2023-06).
It is expected to be compatible with many upcoming releases of TS4, S4CL and TS4Lib.

## Dependencies

• [The Sims 4] https://www.ea.com/games/the-sims/the-sims-4
• [S4CL] https://github.com/ColonolNutty/Sims4CommunityLibrary/releases/latest
• [TS4Lib] https://github.com/Oops19/TS4-Library/releases/latest
• [TS4-SimCache] https://github.com/Oops19/TS4-SimCache/releases/latest/

If not installed download and install TS4 and these mods.
All are available for free.

## Installation

1. Locate the localized `The Sims 4` folder which contains the `Mods` folder.
2. Extract the ZIP file into this `The Sims 4` folder.
3. It will create the directories/files `Mods/_o19_/$mod_name.ts4script`, `Mods/_o19_/$mod_name.package`, `mod_data/$mod_name/*` and/or `mod_documentation/$mod_name/*`
4. `mod_logs/$mod_name.txt` will be created as soon as data is logged.

Idea

EA added script code for a 'Polygamy' check to TS4 with details what to check and how to fix it. And also the 'Marriages ...' pie menu.
This mod is more or less copied and pasted TS4 code with a 'few' adjustments.

### UI Mod

In case you are looking for traits and buffs there is Open Love Life. I didn't test this mod so I have no idea whether it still works with TS4 and/or together with this mod.