Tutorial: How to Change the Script Class of an Object

Note: If yu’re reading this because of my Custom Food Script, you can get already edited OBJK overrides here, and you can find out how to do batch processing of OBJK resources here.

The purpose of this tutorial is to teach a mod user how to change the script class of object. This tutorial is intended for use with my Custom Food Script object mod (MTS). However, once you know how to change an object’s script class, you can apply this knowledge to mod other objects (for example, a candle which behaves like an incense burner from WA).

To complete this tutorial, you will need:

1. Custom Food from ATS3, One Billion Pixels, or Parisian Sims.
2. If your custom food is not in package form, you will need to convert it with Delphy’s Multi-Extractor (you can use Delphy’s Multi-Extractor with Mono) or Echo’s Lepid Llama Unpacker,.
3. S3PE, or some other Package Editor. I use S3PE, and this tutorial will show how to use S3PE. It should not be difficult in other package editors.

What is a Script Class?

In short, an object is defined by its script class. Some of the most popular examples of changing an object’s script class to make it work like something else are Jynx’s Rabbit Hole Rugs. Creating a rabbit hole rug is a bit more complicated than simply changing the script class of a rug to that of a rabbit hole, because the slots and footprint of the rug must be changed (Jynx has a tutorial at Custom Sims 3). However, the basic reason that Jynx’s rugs behave as a rabbit hole is because they use a rabbit hole class instead of a rug class. Basically, an object’s model is just that: a  model. It does not determine how the object functions, or what interactions are associated with it.

Similar to Jynx’s Rabbit Hole Rugs, Custom Edible food is merely a custom mesh which uses the WA DriedFood script class. This is why snob sims dislike those custom foods, unless you use my Custom Food Script object mod. Of course, the problem with that is, if creator’s don’t use my script in their creations, users will have to edit the object themselves. This is an extremely easy process, but I thought I’d make a tutorial, with pictures, to make it even easier, for anybody who is nervous or unsure about editing objects.

Script classes available with my Custom Food Script

You can use any of the three following script classes with my Custom Food Script. See the post to find the default hunger gain/buffs.

• Sims3.Gameplay.Objects.FoodObjects.NonaDriedFoodLow
• Sims3.Gameplay.Objects.FoodObjects.NonaDriedFoodMid
• Sims3.Gameplay.Objects.FoodObjects.NonaDriedFoodHigh

Changing an Object’s Script Class

Finally fixed the pictures!

Before you begin: Make a back up of your package, just in case! Also, back up your save game, just in case. This is a really easy process, but you never know what might happen. Best to be safe by having some back ups.

Click on an image to see a larger version.

1. If your object is not already in package format, convert it now using one of the tools I’ve listed above (or any other tool if you have another you prefer).
2. Open the package in s3pe.
3. Click the “Tag” column to sort by Tag.
4. Find the OBJK resource.

We found the OBJK resource.

5. Right-click the OBJK resource and choose “Edit OBJK”

Time to edit the OBJK resource.

6. In the component column, find the cell labeled “Script.” In the same row, you will notice a field labeled “String:” which will likely look like this: Sims3.Gameplay.Objects.FoodObjects.DriedFoodHigh

This is what the OBJK Editor in S3PE look likes.

7.  You can change that string (outlined in pink in the picture above)  to use another script class. For example, you could change it to: Sims3.Gameplay.Objects.FoodObjects.NonaDriedFoodHigh

IMPORTANT: Do not put a space or any other character at the beginning of the string (in front of Sims3 ) or the object will crash your game when you try to buy it in Buy Mode. If this happens, just go back and remove the space/extra character.

8. Once you’ve finished editing the String field, click Save in the bottom left corner (see above).
9. S3PE will ask if you want to commit the changes. Click Yes.

Heck yes, I want to commit changes (SAVE!).

10. Finally, save the edited package: Hit Ctrl+S or go to File | Save. If you did not back up the original file, you may want to use File | Save As.

11. ONE MORE THING: Before you start your game with your edited objects, go to Documents\Electronic Arts\The Sims 3 and delete the scriptcache.package to make sure your objects will use the new script. Any previously purchased objects may need to be sold and re-purchased.

Congratulations! You’ve just edited an object to use a different script class. I recommend that you load your game up and try to buy all the objects you edited, to make sure that you didn’t manage to sneak in a space or extra character at the beginning of the script class name. All objects in the game must have a script class that starts with “Sims3.” or the game will crash when you try to buy the object. If you have a typo in the middle, or at the end, it’s not such a big deal. The game will not recognize the object and you won’t be able to use it. However, if you only discover that you accidentally put a space at the beginning of the script class after you’ve been playing for a few hours and haven’t saved, you might hate me! I don’t want you to hate me, so please go test out your objects 🙂

Easy, wasn’t it? Feel free to ask any questions or post comments. You may also send a PM at MTS.