Mod The Sims - TUTORIAL: Object Modding (aka adding interactions)

Update1/17/10
This tutorial was extremely outdated with S3OC and S3PE updates as well as Sims 3 updates. The tutorial is now updated for all of these, BUT THE PICTURES ARE NOT. The pictures stop being correct with the S3oc. Also updated was the code, Sims 3 decided to take out the ktip styled notification and made it stop working. Sorry for the long wait, and good luck.

Video Version
This tutorial is now on video and can be found at The Sims Supply, here.

Object Modding is not a very well - defined category. Usually an object mod is one that will clone an object and give it new interactions for it to be able to run. This tutorial will show you how you would set up to create an object mod, and add an interaction to it. By all means interactions are not all you can do with it. With codding experience you tell it to do a lot of things.

What You Need:

1. Microsoft Visual Studip C# 2008 Express Edition : You will use this for making the your new object do what you want it to do instead of just being another cloned object.

2. You need the modding framework and Resource.cfg for your Sims 3 directory, in order to run any mod, and you MUST have the included d3dx9_31.dll file, in the correct directory, to run any core mod. If you don't already have 'em, get them here: Framework .

3. Sims 3 Object Cloner

4. Sims 3 Package Editor

5. The Net Reflector : This will be used to explore through the Sims 3's code content.

6. Knowledge of C# Code: If you have no knowledge of C# code then you will be totally lost some time in this tutorial and will have to start asking questions about everything in your code. I highly advise you to read up on C# before starting this tutorial. (I know from personal experience). This is a pretty good site but it will not teach you everything: http://www.csharp-station.com/Tutorial.aspx

Setting Up:
Its best. when making mods, to create a folder for all of your things. The best place is on the desktop, its easy to reference. After you have your folder you will need to obtain some main Sims 3 dlls that will be used as references later in coding. If you have all ready core modding then you will know what to do.

Open the S3PE
Hit - File - Open
Navigate to your Sims 3 main directory folder (usually in the c drive)
From there go to the Game Folder and then the Bin Folder
You will see 3 packages. These packages contain the dlls that you will be needing.
First open the gameplay package
Four files will appear, you will be exporting 3 of them.
Click on the first sting and hit value. Scroll down the lot of words untill you see Manifest Module:
If the Manifest Module says TestGameplay, you can close out of the window and continue to the next item on the list. If it doesnt say TestGameplay close out of the the window and hit "Grid". At the top of the data grid should be called Assemly. His the down arrow next to the Import/Export and hit "Export"
S3pe will then prompt you to save. Navigate to your mod folder and save the file as what the Manifest Module said followed by ".dll"
After you have saved, hit cancel in the datagrid and move on to the next item in the package.
Extract it the same way you did the first one nameing it with the Manifest Module it has followed by ".dll"
Do these for all of the items in that package.
When done with that pick open up one of the other 3 packages in the Game/Bin directory and do the same. (be sure not to take the test gameplay, it is not needed)
When finished with that package move on to the last package and do the same.

Making you Object
The next step in this process is to make your new cloned object. Start by opening the S3OC (Sims 3 Object Cloner). First time users will have to navigate to their Sims 3 folder to start off the program. Once opened we will want to make our new clone so hit Cloning - and choose the type of object you will be using. For this tutorial we are using Normal Objects. S3OC will then load the object catalog with all the objects in the game. Next you need to choose witch object you want to clone. In this example i'm going to use the Teddy Bear witch is called ToyStufffedAnimalTeddyBear. When you have picked out your object hit the "Clone or Fix" button. S3OC will then ask you to determine some options. You will need to make sure you give it a unique name. We will name ours "Kolipoki_AddInteractiontoBear". At this time you might also want to give it a new name, catalog description, price, and even which categories it will go into. Then hit start, and S3OC will then create your new object and ask you to save it to a new location.

Congratulations you have your own cloned object.

Setting Up MVSC# (Microsoft Visual Studio C#)
Before we start coding we need to set up MVSC# So that we can use it and make the code work. Of course there is all ready a tutorial on that out there. http://www.sims2wiki.info/wiki.php?..._Studio_project. Its small but you need to follow it. The files in step 4 are the files that we extracted in the beginning of this tutorial.

Finding the Original Object's Name
This next step is important because it will later be used to make your script be derived from the previous object making it the same so it will work in game. Start off by open your cloned object in the S3PE (in my case Kolipoki_AddInteractiontoTeddy). Next your going want to make sure that names and tags are on. Click the buttons right next to them as shown in the screen shot. Afterwards find the item in the list with a tag name of OBJK. Open the OBJK with the grid button.

You should see a "Component Data" category click on the category and a small button with three little dots appears to the far right. Click on this button and it will bring up a new menu. On the left of that new pop-up, you should see two items. Click on the second item labeled "[1]CDTString". The data row should have a rather long name usually starting with "Sims3....." That is the original name and how to call that item. Be sure to write it, or paste it somewhere else so that we can use it later. In the case of a cloned teddy bear the co-string is "Sims3.Gameplay.Objects.Miscellaneous.StuffedAnimal".

Starting Your Code
Open up your project that you made in step "Setting up MVSC#". We are going to start off by changing the namespace and the class. The namespace is what contains classes and separates out two of the same classes. Lets name our research after Yourname Followed by mod. For Example:

Code:

namespace Sims3.Gameplay.Objects.Miscellaneous.KolipokiMod

Next we need to change the class name. Its needs to be something that will tell you what you are doing. Since we are adding a simple interaction i'm going to make it:

Code:

public class TalkingTeddy : StuffedAnimal

Now you may notice in my class name that i have what functions as a deriver. What it does is it takes the code with the StuffedAnimal and assigns the TalkingTeddy to it. The deriver should be what was in your co-string. You may be wondering what your co-string was way longer then that and it was. MVSC# will the things before it for you. If it does not right click on it and hit resolve and then it should work. What it is doing is that on the top of the code it is adding a Using qualifier witch makes it so you dont have to say that name space over and over again when calling something within it.

Adding the interaction
Through this step we will be using the reflector for a while so make sure you have it opened and that you opened the dlls that we extracted in the first step.

If you do not know how the game calls an interaction it is best to see how to they do it. Because all we are doing is telling the interaction to tell us hi we need an immediate interaction. In the Sims 3 immediate interactions have those orange circle things next to their name. We are going to be exploring the Stereo TurnOnOff function.

Expand your Sims3GameplayObjects - Sims3GameplayObjects.dll - Sims3.Gameplay.Objects.Electronics - Stero - TurnOnOff. We now need to open the Dissasembler. To open the dissasembler hit space. Once open click on the TurnOnOff to see what it does. Be sure to hit the expand method at the bottom of the dissasembler so you can see the hole code. Look through the disassembler and see how the code works.

When you have finished exploring we are going to need most of the code of the TurnOnOff Method so select the code in the disassembler and copy it. Paste it within your class definition in MVSC#. Because this is for the stero we will need to be changing it.

Change the private sealed class name of TurnOnOff to what you want the name of it to be, make it something that describes the interaction. I'll be naming mine TalktoMe. Also make note that that class is derived from an immediateInteraction class. be sure to change the Stero to the name of your object (the first class). In my case it will say TalkingTeddy instead of stero.

Allot of this stuff we took we will not be needing and we will have to change. With your C# knowledge you can figure out what you have to change and edit but for our example after removing the code. You will also need to change the code so that where it says stereo you refer to your object and where it says TurnOnOff you refer to your interaction name.

Code:

private sealed class TalktoMe : ImmediateInteraction<Sim, TalkingTeddy>
{
    // Fields
    public static readonly InteractionDefinition Singleton = new Definition();
    private const string sLocalizationKey = "Gameplay/Objects/Miscellaneous/TalkingTeddy/TalktoMe";

    // Methods
    private static string LocalizeString(string name, params object[] parameters)
    {
        return Localization.LocalizeString("Gameplay/Objects/Miscellaneous/TalkingTeddy/TalktoMe:" + name, parameters);
    }

    protected override bool Run()
    {
        //do interaction here
        return true;
    }

    // Nested Types
    private sealed class Definition : ImmediateInteractionDefinition<Sim, TalkingTeddy, TalkingTeddy.TalktoMe>
 {
                      // Methods
                      protected override string GetInteractionName(Sim a, TalkingTeddy target, InteractionObjectPair interaction)
                      {
                          return TalkingTeddy.TalktoMe.LocalizeString("TalktoMe", new object[0]);
                      }
                      protected override bool Test(Sim a, TalkingTeddy target, bool isAutonomous, ref GreyedOutTooltipCallback greyedOutTooltipCallback)
                      {
                          return !isAutonomous;
                      }
                  }
}

Making the Interaction Do Something
With the right code, interactions could do anything. They could start a fire to a whole lot like in the ChaosMagePainting. They could lock doors such as in the Lockable door.

For this tutorial i will simply make it say "Hi". The Sims 3 has a nice way of setting up a notification. It's simply:

Code:

                          base.Actor.ShowTNSIfSelectable("Hello", StyledNotification.NotificationStyle.kTip, ObjectGuid.InvalidObjectGuid, base.Actor.ObjectId);
                          base.Target.mRevealingSim = base.Actor;

The first line in this code is calling the ShowTNSIfSelectable, which is a nice method of telling things through notifications. If you search in the relfector for the ShowTNSIfSelectable you will find that the parameters are 1)what you want it to say, 2)the theme of the notification is this case kTip(there are i believe 5 different themes, so go look them up and choose one you like), 3)thumbnail 1 and 4) thumbnail 2. This code will going into the "protected override bool Run" inside your interaction class.

Congratulations now your code will add the interaction and tell you hello. Here is what the final product should look like:

Code:

using System;
using System.Collections.Generic;
using System.Text;
using Sims3.Gameplay.Objects.Miscellaneous;
using Sims3.Gameplay.Utilities;
using Sims3.Gameplay.Interactions;
using Sims3.Gameplay.Actors;
using Sims3.Gameplay.Autonomy;
using Sims3.SimIFace;
using Sims3.Gameplay.Skills;
using Sims3.UI;
using Sims3.Gameplay.Objects;
      
      namespace Sims3.Gameplay.Objects.Miscellaneous.KolipokiMod
      {
          public class TalkingTeddy : StuffedAnimal
          {
              protected Sim mRevealingSim;

              public override void OnStartup()
              {
                  base.OnStartup();
                  base.AddInteraction(TalktoMe.Singleton);
              }
              private sealed class TalktoMe : ImmediateInteraction<Sim, TalkingTeddy>
              {
                 // Fields
                   public static readonly InteractionDefinition Singleton = new Definition();
                    private const string sLocalizationKey = "Gameplay/Objects/Miscellaneous/TalkingTeddy/TalktoMe";
                // Methods
                   private static string LocalizeString(string name, params object[] parameters)
                  {
                   return Localization.LocalizeString("Gameplay/Objects/Miscellaneous/TalkingTeddy/TalktoMe:" + name, parameters);
                  }
                  protected override bool Run()
                  {
                      //Do the interaction here.                   
                      base.Actor.ShowTNSIfSelectable("Hello", StyledNotification.NotificationStyle.kGameMessagePositive, ObjectGuid.InvalidObjectGuid, base.Actor.ObjectId);
                      base.Target.mRevealingSim = base.Actor;
                      return true;
                  }
                  // Nested Types
                  private sealed class Definition : ImmediateInteractionDefinition<Sim, TalkingTeddy, TalkingTeddy.TalktoMe>
                  {
                      // Methods

                      protected override string GetInteractionName(Sim a, TalkingTeddy target, InteractionObjectPair interaction)
                      {
                          return TalkingTeddy.TalktoMe.LocalizeString("TalktoMe", new object[0]);
                      }
                      protected override bool Test(Sim a, TalkingTeddy target, bool isAutonomous, ref GreyedOutTooltipCallback greyedOutTooltipCallback)
                      {
                          return !isAutonomous;
                      }
                  }
              }
          }
      }

Now that your script is complete save the project and hit "f6". This will build the project see if it has any errors and if it doesn't it will create a nice dll for you. This dll is stored in the Visual Studio 2008 - Projects - [name of saved project here] - [name of saved project here] - obj - release - [nameofproject].dll . That file will be used to add your script to your nice cloned object and make it work. If you ever change the code be sure to run "f6" again or you will get the old dll.

Adding your script to your package
The next step in this process is to add the script to the package. First your going to need to open S3PE and then open your cloned object.

We are going to be making a new resource that will have the tag S3SA. Before we go making a new resource we need to FNV Hash and get an instance name. In S3PE hit ctrl - f or go Tools - FNV Hash. Inside the box that says text to has write the class name of your object. For me i would write "TalkingTeddy". Copy the FNV64 number. That will become the new instance.

Close out of the FNV Hash and hit Resource - Add. The Type number for all S3SA files is 0x073FAA07, and the group number is 0x00000000. The instance number is the number you just obtained in the FNV Hash. Ep flags are used to tell the object if it requires the EP or not (i assume). For those who do not have WA the EP name is 0x00. Hit ok and you will have a new S3SA type resource.

After your new resource is created go to the OBJK, Collection of Keys, 2nd Key and type "[Your Namespace Name].[Your Class Name] For this example it would say Sims3.Gameplay.Objects.Miscellaneous.KolipokiMod.TalkingTeddy. Next you need to import your dll. Click on the S3SA and hit grid. The first item on the list should have an import/export click on it, bring the drop down menu down and click import. Navigate to your dll of your code "Visual Studio 2008 - Projects - [name of saved project here] - [name of saved project here] - obj - release - [nameofproject].dl" and hit open, after that hit commit and save your project. If all went well then you know have a nice object that will tell you Hi.

Finishing Up
If you testing your object in game after finishing the last step you may have noticed that the interaction would say Something like KolipokiMod.TalkingTeddy.TalktoMe . If you would like to change that open your cloned object in s3pe. FNV Hash the name that shows up in game and copy the instance in the FNV64. Find the file with an STBL file type (make sure its your language) and hit editor. A STBL Resource Editor will appear. Change the instance in the bottom to the FNV64 Hash and hit add. A new string will appear. Click on it and in the box to the right write out what you want it to say.

Congratulations
You have now finished your object and should have an understanding of how to make your own object mod. I cannot wait to see what you guys create.

Special Thanks
Special Thanks goes specially to Wito who helped me start out in object modding. I'd also like to thank Rick, Tiger, and ChaosMage for there help answering questions that i had come across. Thanks for Sri for telling me to try Object Modding.

Locked thread \| Locked by: HugeLunatic Reason: Please see updated tutorial in wiki, see first post.	1 2 3 4 Next > Page 1 of 4

Sign in to Mod The Sims