Hygiene gain from swimming

Update 2017-02-05 There is now a version with different gain rates, ocean and pool/lake swimming hygiene gain is now separate.

Sometimes someone suggests something that makes so much sense you wonder why it didn't work like that to begin with. A few days ago gayars asked me if I could help her with a request she received to make sims gain hygiene when they swim in the ocean and swimming pools. I hadn't thought about it before, but it makes a lot of sense to me so of course I said yes.

What is this?
This is a global mod that adds hygiene gain to swimming. It affects swimming pools, swimmable lakes and swimming in the ocean on beach lots. However, Sims only gain hygiene up to a certain point. While it makes sense that swimming would get rid of some dirt and sweat, I think it's more realistic that they retain some degree of dirtiness to account for the fact that it's swimming pool or ocean water which has more dirt in it than shower/tub water. Once they reach the set cap, the hygiene gain ceases.

There are two versions available.

Swimming gives hygiene
Sims will gain hygiene at a rate equal to taking a bath in the cheapest tub, which is a catalog hygiene rating of 5. Hygiene gain will cap out at 30 hygiene, which means the bar is 65% full.

Swimming gives hygiene separated
In this version the hygiene gain rate is different for oceans and swimming pools/lakes, as requested by CatherineTCJD. Oceans are salty and while it may get rid of dirty and salt, you don't necessarily feel clean when you get out. In this version hygiene gain will be slightly slower in the ocean, and Sims reach the cap earlier.

Ocean swimming has a hygiene gain rate equal to a catalog hygiene rating of 5. Hygiene gain will stop at 25 hygiene, which means the hygiene bar is 62,5% full.
Swimming pools and swimmable lakes has a hygiene gain rate equal to catalog hygiene rating of 6. Hygiene gain will stop at 45 hygiene, which means the hygiene bar is 72,5% full.

This version requires BV.

Limitations with this mod
While testing this I realized Sims will refuse to continue swimming in the ocean if their hygiene is low enough for them to complain. They get in, but immediately stop swimming in order to complain about low hygiene. They will still gain hygiene if they swim, it's just impossible to make them swim long enough to make hygiene go up. This is not due to my mod, it's just how ocean swimming is coded. Swimming pools do not have this problem.

I may try to address it at some point, but for now you might want to make sure your Sims don't get too low on hygiene if you intend to have them ocean swim to get cleaner.

Additionally, swimming does not advertise hygiene which means Sims won't autonomously swim when they are low in hygiene in order to get clean, because they don't realize it'll raise hygiene. I may fix this later on, but for now that's how it is.

Compatibility
Compatible with all EPs/SPs. Depending on which version of the mod you want and what your setup is you should use different versions of the mod. Only use one version.

Swimming gives hygiene
If your highest expansion pack is Base game, Nightlife, University, Open for Business or Pets, use the version called GummiluttSwimmingGivesHygieneBG-Pets.
If your highest is Seasons, Bon Voyage, Freetime, Apartment Life or Mansion and Gardens, use the version called GummiluttSwimmingGivesHygieneSeasons-MG.

Swimming gives hygiene separated
If your highest expansion pack is Bon Voyage, use the version called GummiluttSwimmingGivesHygieneSeparated_BV.
If your highest expansion pack is Freetime, Apartment Life or Mansion and Gardens, use the version called GummiluttSwimmingGivesHygieneSeparated_FT-MG.

Conflicts
No conflicts that I am aware of. May conflict with other mods that affect swimming. If you are unsure if it conflicts with a mod you have, you are welcome to ask me and I'll look at it for you. If you find a conflict please let me know, and I'll see if it can be fixed.

Does not conflict with Lamare's autonomous ocean swimming.

How to edit
This is very easy to edit if you'd like to change how quickly Sims gain hygiene, or what hygiene gain caps out at. I usually include picture instructions and I may later on, but for now it'll be simple instructions for experienced people. Anyone could do this, experienced or not, but if you're new it might be easier to wait for the picture. You are welcome to ask for help if you want to give it a try and get stuck

Edits are done in the BCON
BG-Pets version line 0x6 controls hygiene gain rate, line 0x7 controls hygiene cap
Seasons-MG version line 0x7 controls hygiene gain rate, line 0x8 controls hygiene cap
Seasons-MG separated version line 0x7 controls hygiene gain rate and line 0x8 controls hygiene cap for swimming pools, 0x9 controls hygiene gain rate and line 0xA controls hygiene cap for oceans.

Motives range from from -100 which is completely empty bar, to 100 which is completely full bar. Cap can be set to anything between -100 and 100, hygiene gain will stop once the sims bar reaches that number. Gain rate is per hour, so whatever you set the value to is how much hygiene the Sim will gain in one hour of swimming.

If you want a different rate than what the mod comes with and you can't or don't want to edit it yourself, you are welcome to ask me for help and I'll make it for you when I have time.

Similar or related mods that I recommend
Gayars made her own solution to the concept of gaining hygiene without a bathtub or a shower. She created a functional soap that your Sims can buy and use, with custom animations of them washing themselves with a sponge. There's also a soap stand with buyable functional soap for community lots, that works like the perfume stand but sells the functional soap. It's designed to suit a medieval game, and makes a great alternative to bathtubs and showers.

Inge Jones has a mod called Get In Sea Patch that encourages Sims to swim in the ocean if they are overheated. Lamare improved upon that with her autonomous ocean swimming, that conditions and encourages autonomy depending on body temperature, weather and season. If you plan to use this mod for medieval or fantasy settings where Sims don't have tubs or showers her mod would make a great complement.

Policy
You are very welcome to edit this for your own use, but don't re-upload with just the gain rate adjusted. If you have other ideas on improving it further, be my guest

Credits
Original requesters at AffinitySims for the idea
Gayars for asking me for help with this project. Thanks for involving me, it's a great idea and it was fun to do.
Thank you CatherineTCJD for the request to separate hygiene gain.