Maxis Piggy Bank Made Functional!

Updates!

• 2024-08-17:
  (1) Fixed a bug in the Extended version where some constants were flipped, leading to Sims with 0 Nice points always trying to steal the bank instead of only 10% of the time as intended, and Sims with 1 Nice point being unable to steal despite being intended. I apologise if this caused tragedy! Users of the Extended version, please re-download.
  (2) Added a Hungarian translation. Nagyon szépen köszönöm, kaligi!
• 2023-10-04: Added a Spanish translation. ¡Muchas gracias, bothersomecryptid!

It's that chaos-loving Yosh', back with another mod he desperately needed in his game - now wanting to share it with you all, too!

All the way back in January when they were first uploaded, I noticed Corax' amazing recolours of the Maxis piggy bank, which Azaya extracted from the lemonade stand introduced in Open for Business as part of her "Eclectic Minutiae" set. And I was sad that it was merely a decorational object. I hate useless objects. The slot to put money in was right there! Why couldn't Sims do just that?

I started putting a mod together but put the project on hold for a long time to focus on real life, as well as other mods that were on my agenda. Two weeks ago, I promised to myself to finally finish it off. With input from my beloved fiancée (and my own crazy thoughts), out came some pretty neat ideas for additional features that went beyond the scope of a mere piggy bank.

We'll get to all those in a bit. For now, I hereby proudly present... a functional piggy bank for The Sims 2! This is my most ambitious mod thus far, so I hope you'll find enjoyment in it!

What even IS a piggy bank?
A piggy bank is, generally speaking, a mostly decorational ceramics or porcelain sculpture with a slot at the top and - often - a plug on the bottom, for you to insert coins or small bills and take them out when needed. If the plug wasn't present, this would lead to... a fateful end for the piggy bank. It would be smashed with a hammer to get the money inside. :P
They are often shaped after pigs, but can come in many different forms, especially nowadays. Piggy banks are used to teach children the concept of "saving up" at an early age. The tradition is so widespread that a total of 29 countries celebrate a "World Savings Day" on the 31st of October each year.
It is said that the first piggy bank in the classic pig shape originated from the state of Thuringia, Germany, in the 13th century. (Thinking of it... that's not far from where I live, so I guess I have a personal justification to be the first to make a functional piggy bank!)

And with that... thanks for coming to my TED talk!

What does this object mod do?
While I wanted to stay as true to the "piggy bank" concept in the real world as possible, I wanted to make a few limitations, also to promote user-friendliness, so here is what the mod does:

• Most basically, it stores money for you.
• You can choose to insert §1, §2, §5, §10 coins and §20, §50 or §100 bills. Note that children usually don't have a lot of money in their early years, so they can only insert the coins.
• This happens autonomously, but you can always direct a Sim to do it, too.
• Your money is absolutely safe inside the piggy bank. It will not catch on fire, the Repoman will leave it alone (everyone has a heart for children!), and the bank and all money inside the bank will not be added to the household's bills whatsoever. The piggy bank will also never decay in value!
• The piggy bank can be put on almost every surface, from counters over low dressers and desks, all the way down to the ground. The only exceptions are armoires (tall dressers), and displays, where you can sell piggy banks to other Sims, but not actually use them.
• The bank can also be used on business lots and will function as a tip jar this way! No longer is receiving tips limited to just musicians, freestylers, fire dancers and lemonade vendors!
• The piggy bank can be put into a Sim's inventory and will always preserve the amount of money it currently contains. No accidental spilling!
• As soon as any amount of money is in the bank, you can direct your Sim to shake it to release all the money at once. This is, by any means, better than having to smash it. Sims will not do this autonomously, so you have full control over when you'd like to indulge a Sim in the good feeling of earning money that they always had in the first place; and you don't have to fear that someone else may get the money instead.
• Don't want to shake it? Just sell it! The piggy bank is intelligent and knows how much money is inside it, so when you sell it, it just adds the money inside to the sell value and you won't lose anything!
• By default, Zombies, Servos and Pleasure Sims, as well as Sims with less than 4 Nice points or less than 2 Money Interest points are excluded from the autonomous donation of money, but can still be user-directed to do so.
• Also by default, only Family and Fortune Sims, as well as Sims with more than 8 Nice points and more than 6 Money Interest points can make donations of more than §10 autonomously. Again, they may still be user-directed to do so anyway.
• By default, Bigfoot skips all checks and can donate any amount of money even if their personality or interests would normally conflict, because 1. he's kind at heart, and 2. Bigfoot is somewhat of a "reward family member" so I want him to feel as such.
• Piggy banks are small, and thus the capacity is limited. The limit is technically §512. However, this is a flexible cap. You can go a little higher if you are currently close to the limit and insert a large amount of money at once. For example, putting in §50 at a current storage of §490 will lead to a final amount of §540 in the bank, but putting in §10 at a current storage of §505 will lead to a final amount of §515 in the bank.
• You are normally not supposed to know how much is currently inside the piggy bank, but if you still wish to know, you can Shift-click the bank with testingcheatsenabled and find out that way.
• If you directed a Sim to insert money but they don't currently have this amount in their household funds, they will shrug and let you know they are broke. If they were going to autonomously insert money, they will simply cancel the interaction silently before it even began.
• The same applies if you direct a Sim to insert money when the bank is already full.
• The object and Sims are fully animated. Woo! Quick note here though, all animations were "borrowed" from other interactions and reactions that exist in the game, so they may not be a 100% fit for a given situation, or be slightly offset. Unfortunately I have neither the technical nor the artistic knowledge to make my own animations. But I have made sure to bring the animations as close to reality as possible, including differentiating between counters, tables, coffee tables or the ground to pick the best fitting animation.

This all sounds so... normal!
Where's the LimeyYoshi signature in this?

The main mod is indeed just what I put above. There's no catch to it at all! However, as the mod development came to a conclusion, my chaos-loving side kicked in and I wanted to add my typical Limey spin on the mod. Thus, two extra versions were born. Both do similar things, but one is tailored for the Traits Project, and the other works with a Sim's personality instead. I'll explain as I go.

The things listed below can all happen autonomously, and despite it being an autonomous interaction I want the player to know when something fateful is going on, so I have not made the notifications for these events silent:

• Any time a Sim inserts money, there is now a chance they may drop all the money they were going to put in and lose it for good.
  --- Extended Version: Sloppy Sims (3 or less Neat points) have a 10% chance to lose money. Other Sims have a 2% chance to lose money.
  --- Traits Version: "Loser" Sims have a 5% chance to lose money. "Unlucky" or "Clumsy" Sims have a 15% chance to lose money. Don't let them near the piggy bank! Other Sims are completely safe.
• On the contrary, any time a Sim inserts money, there is also a chance Sims may find additional money laying around by the piggy bank, and claim it as their own. This amount is random and ranges between 1 and 10 Simoleons.
  --- Extended Version: Neat Sims (8 or more Neat points) have a 10% chance to find extra money. Other Sims have a 2% chance.
  --- Traits Version: "Lucky" Sims get a 20% chance for a bonus. "Neat" Sims get a 5% chance.
• Any time a Sim shakes the piggy bank to claim the money that's inside, there is a chance they may either spill and lose everything, or find out someone replaced all the money inside with worthless play money, leading to a total loss of all the contents!
  --- Extended Version: The chance is 5% for all Sims, except for Neat Sims (7 or more Neat points) who will never have this happen to them.
  --- Traits Version: Only "Loser", "Unlucky" or "Clumsy" Sims are prone to bad luck, but their chance is upped to 10%.
• Some very mean Sims may even autonomously go and steal a Sim's piggy bank, which will essentially transfer all the money inside and the ownership of the piggy bank to them. Both visitors and service NPC's can do this.
  --- Extended Version: Any Sim with less than 2 Nice points has a 10% chance to steal a piggy bank each time they would normally donate.
  --- Traits Version: Any Sim with less than 2 Nice points, or the "Evil", "Mean-Spirited" or "Kleptomaniac" Trait has a 10% chance to steal a piggy bank each time they would normally donate.
• However, observant Sims - and pets! - have a chance to catch the thief off-guard, either autonomously or guided by you. As long as they reach the thief in time and try to interact with them in any way, they will notice the other Sim, sigh, and put the piggy bank back. Once they leg it though, it's too late!
  --- Extended Version: Everyone is equally observant. Either the Sim is quick enough to notice or you lose.
  --- Traits Version: "Computer Whiz", "Eccentric", "Genius" and "Perceptive" Sims are assumed to have installed a little tracking device on the piggy bank. If the current family has a Sim with one of these traits, the thief will notice the tracker and give up on the spot. But everyone else does get a chance still, too.
• In addition, the list of Sims who will either not donate, or donate only small amounts, increases vastly:
  --- Extended Version: No change.
  --- Traits Version: Any Sim with the "Evil", "Mean-Spirited", "Kleptomaniac", "Mooch", "Snob" or "Frugal" trait will never donate whatsoever, while any Sim with the "Diva", "Dislikes Children", "Grumpy", "Hot-Headed" or "No Sense of Humor" trait will only ever donate small amounts.

Can I have a tl;dr?
I did not want to spare a single detail I considered about the piggy bank because I'm a fan of transparency.
But if you want it as compact as possible: This is a piggy bank, it stores money safely, and you can safely get the money out again, too.
Two variants add a few quirks and some insecurity, but you won't see it happen very often so don't worry about it... too much.

Translations

Language	Available?	Creator
English (US/UK)	✅	Me (LimeyYoshi)
German	✅	Me (LimeyYoshi)
Spanish	✅	bothersomecryptid
Hungarian	✅	kaligi

If you know your way around SimPE and would like to translate into your own language, feel free to contribute! You shall be given due credit.
Text strings to be translated are found in:

• the CTSS (Catalogue Description),
• the TTAs (Piggy Bank Interactions)
• two STR# resources (Dialog prim string set, MakeActionString prim string set).

It is best if you pick either the Extended or the Traits version to translate as the base version is missing a few lines.

Tuning
Honestly, too much to count! I made sure you can adjust almost everything to your personal preference. Don't be overwhelmed, you'll probably thank me later for allowing so much customisation. XD
Here's a breakdown.

BCON 0x1000 "Tuning - Animations":

No.	Constant Label	Meaning	Default value
0x00	min money in bank for good animation	If this amount of money is in the piggy bank, teens and older will cheer	0x0064 (100)
0x01	min money in bank for medium animation	Any less money than this in the piggy bank makes teens and older sigh, and children cry	0x0014 (20)
0x02	max capacity of piggy bank	How much money the piggy bank should be able to hold. Do not set to negative, or higher than 32,767!	0x0200 (512)

BCON 0x1002 "Tuning - Behaviour":

No.	Constant Label	Meaning	Default value
0x00	Min Niceness to Enable Donations	A Sim any grouchier than this can't donate autonomously. Values 0-1000	0x0190 (400)
0x01	Min Niceness to Allow High Donations	A Sim any grouchier than this can't donate more than §10 autonomously. Values 0-1000	0x0320 (800)
0x02	Allow Zombies To Donate (1 = yes, 0 = no)	If set to 0, Zombies are excluded from donating	0x0000 (0)
0x03	Allow Servos To Donate	(Requires OFB) If set to 0, Servos are excluded from donating	0x0000 (0)
0x04	Allow Witches To Donate	(Requires AL) If set to 0, Witches are excluded from donating	0x0001 (1)
0x05	Allow Active Werewolves To Donate	(Requires Pets) If set to 0, Lycanthropy carriers can still donate at daytime, but will be excluded at night	0x0001 (1)
0x06	Allow Vampires To Donate	If set to 0, Vampires are excluded from donating	0x0001 (1)
0x07	Allow PlantSims To Donate	(Requires Seasons) If set to 0, PlantSims are excluded from donating	0x0001 (1)
0x08	Should Bigfoot Skip Checks?	(Requires BV) If set to 1, Bigfoot can donate even with conflicting personality or interests	0x0001 (1)
0x09	Min Money Interest to Enable Donations	A Sim can't donate autonomously if their interest in Money is lower than this. Values 0-1000	0x00C8 (200)
0x0A	Min Money Interest to Allow High Donations	A Sim can't donate more than §10 autonomously if their interest in Money is lower than this. Values 0-1000	0x0258 (600)
0x0B	Allow Pleasure Sims To Donate?	Should Sims with a Pleasure Aspiration be able to make autonomous donations?	0x0000 (0)
0x0C	Allow Grilled Cheese Sims To Donate?	Should Sims with a Grilled Cheese Aspiration be able to make autonomous donations?	0x0001 (1)
0x0D	% Chance To Steal Instead Of Donating	(Ext/Traits) How likely should it be for Sims meeting the criteria to steal the piggy bank?	0x000A (10)
0x0E	Min Niceness To Not Consider Stealing	(Ext/Traits) Minimum Nice personality for a Sim to not consider stealing the piggy bank. Values 0-1000	0x00C8 (200)
0x0F	Allow Service NPCs To Steal Too?	(Ext/Traits) Should Service NPC's be able to steal the piggy bank?	0x0001 (1)
0x10	On Liveable Lots, Can Non-Family Share Bank?	This'll allow Sims that you Make Selectable through the debug menu or a mod to also shake the piggy bank. If set to 0, only a family member can do this	0x0001 (1)

BCON 0x1003 "Tuning - Personality": (Extended version only)

No.	Constant Label	Meaning	Default value
0x00	% Chance for Sloppy Sims to Lose Money	Percentage for a Sim with 3 or less Neat points to lose the money they insert into the bank	0x000A (10)
0x01	% Chance for Other Sims to Lose Money	Percentage for a non-Sloppy Sim to lose the money they insert	0x0002 (2)
0x02	% Chance for Neat Sims to Find Extra Money	Percentage for a Sim with 8 or more Neat points to find 1-10 extra Simoleons	0x000A (10)
0x03	% Chance for Other Sims to Find Extra Money	Percentage for a non-Neat Sim to find 1-10 extra Simoleons	0x0002 (2)
0x04	% Chance for Non-Neat Sims to Lose Everything When Shaking	Percentage for Sims with less than 7 Neat points to lose all money within the bank when shaking to empty it out	0x0005 (5)

BCON 0x1004 "Tuning - Traits": (Traits version only)

No.	Constant Label	Meaning	Default value
0x00	% Chance for Loser Sims to Lose Money	Percentage for a Sim with the Loser Trait to lose the money they insert into the bank	0x0005 (5)
0x01	% Chance for Unlucky Sims to Lose Money	Percentage for a Sim with the Unlucky Trait to lose the money they insert into the bank	0x000F (15)
0x02	% Chance for Sloppy Sims to Lose Money	Percentage for a Sim with the Sloppy Trait to lose the money they insert into the bank	0x000F (15)
0x03	% Chance for Lucky Sims to Find Extra Money	Percentage for a Sim with the Lucky Trait to find 1-10 extra Simoleons	0x0014 (20)
0x04	% Chance for Neat Sims to Find Extra Money	Percentage for a Sim with the Neat Trait to find 1-10 extra Simoleons	0x0005 (5)
0x05	% Chance for Lo/Unl/Cl Sims to Lose Everything When Shaking	Percentage for Sims with a Loser, Unlucky or Clumsy Trait to lose all money within the bank when shaking to empty it out	0x000A (10)

Requirements
Expansion Pack: University, Nightlife.
Mods: Smarter EP Check (all versions), Easy Inventory Check (Traits version only).
University is required for some animations I used, and Nightlife is a requirement because inventories and the Pleasure and Grilled Cheese aspirations were not a thing before this EP.
Smarter EP Check is required because I wanted to make my mod as compatible with different game setups as possible. If I hadn't done this, my mod would also require OFB, Pets, Seasons, BV and AL, which I can't expect everyone to possess.
Easy Inventory Check makes it simple for me to check if a Sim has a certain Trait, which is why it's needed for the Traits version. If you plan to use the base or Extended version, then you will not need this one.

New resources

• A new object, the Piggy Bank itself, is included within the mod. Its GUID is 0x004F6A6B.
  - It's found in Miscellaneous > Children and costs §15.
  - The catalogue will list it as having Comfort 1 and Environment 1, this is merely my subjective opinion on how I felt about the piggy bank in my room when I was little. The bank actually neither boosts Comfort nor Environment. :p
  - By default it comes in white, the same colour as the piggy bank on the OFB lemonade stand.
  - The mesh and texture were extracted by Azaya and originally found here. I have included her mesh and texture as per her Terms of Use.
• With it come various BHAV, BCON and STR# resources which all have the group 0xFFFFFFFF and thus will not conflict with anything.
• Note that any recolours, such as Corax' which inspired me to make this mod, will also work with this functional piggy bank, just like they did with the decorational one beforehand. (In fact, I used some of these recolours for my screenshots!)

Notes
Quick note: The original upload of the extracted piggy bank also comes with a "knocked-over" version of the bank. That one does not carry the same functions. Only the upright one will actually work as a piggy bank!

Credits
Maxis and EA for creating Sims 2 in the first place
The Creators of SimPE, and whoward69 for further facilitating its usage with his new Instruction Wizards. They're a godsend.
My fiancée for contributing ideas, love and comfort... <3
Azaya for extracting the mesh and texture - none of this would've been possible without her groundwork!
Corax for the inspiration and some great recolours!
bothersomecryptid for the Spanish translation
kaligi for the Hungarian translation

Have fun and happy Simming!
~ LimeyYoshi