Tutorial:Sims 3 In Depth Scripting - Revision history

Raziel17o1: /* Methods */

2018-09-09T15:46:04Z

‎Methods

Nonamena: /* Requirements */

2013-01-18T22:28:49Z

‎Requirements

Odistant: /* Test */

2011-10-09T15:12:25Z

‎Test

Odistant: /* Compiling */

2011-10-09T15:12:01Z

‎Compiling

Odistant: /* Compiling */

2011-10-09T15:11:11Z

‎Compiling

Odistant: /* Classes */

2011-10-09T15:09:45Z

‎Classes

Odistant: /* Compiling */

2011-10-09T15:08:37Z

‎Compiling

Odistant: /* Compiling */

2011-10-09T15:06:00Z

‎Compiling

Odistant: /* Compiling */

2011-10-09T14:51:09Z

‎Compiling

Odistant: /* Interaction Methods */

2011-10-09T14:50:41Z

‎Interaction Methods

@@ Line 63: / Line 63: @@
 Methods tell Sims 3 what to do when something happens. The game already comes with a variety of methods that you can use to implement into your script. The most common one is WorldEventHandler, TNSMessages, and Interaction methods.
 <br>
-Think of methods as steps to solve a math problem or functions. When you do a math problem, you follow certain steps to get to the final outcome. This is essentially the same with methods. They give the game steps on what to do when someone clicks on the object or uses a interaction.
+Think of methods as steps to solve a math problem or functions. When you do a math problem, you follow certain steps to get to the final outcome. This is essentially the same with methods. They give the game steps on what to do when someone clicks on the object or uses an interaction.
 === Interaction Methods ===
 <br>

@@ Line 6: / Line 6: @@
 == Requirements ==
-* '''[http://www.microsoft.com/visualstudio/en-us/products/2008-editions/express Microsoft Visual C# Express 2008]''' - I will call this program VS for short. I highly reccomend that you use this version instead of the 2010 as it seems to not work correctly when it comes to referencing.
+* '''[http://www.microsoft.com/visualstudio/en-us/products/2008-editions/express Microsoft Visual C# Express 2008]''' - I will call this program VS for short.
 * '''[http://dino.drealm.info/den/denforum/index.php?board=19.0 Sims3 Package Editor]''' - I call it S3PE for short in this guide.
 * '''[http://dino.drealm.info/den/denforum/index.php?board=20.0 Sims3 Object Cloner]''' - S3OC isn't mentioned very much in this guide until the very end. You'll normally use this program for finding what objects are derived from what and cloning items to change their scripts.

@@ Line 179: / Line 179: @@
 public override bool Test(Sim actor, MyFishTank target, bool isAutonomous, ref GreyedOutTooltipCallback greyedOutTooltipCallback)
+                 {
-                     throw new NotImplementedException();
+                     return !isAutonomous;
+                 }
 </pre>
 == Compiling ==
 <br>

@@ Line 259: / Line 259: @@
                  public override bool Test(Sim actor, MyFishTank target, bool isAutonomous, ref GreyedOutTooltipCallback greyedOutTooltipCallback)
+                 {
-                     throw new NotImplementedException();
+                     return !isAutonomous;
+                 }
+             }

← Older revision		Revision as of 15:11, 9 October 2011
Line 223:		Line 223:
	<br>		<br>
	After that, you can attempt the Intermediate portion of this tutorial which will go over Tunables.		After that, you can attempt the Intermediate portion of this tutorial which will go over Tunables.
		+	<br>
		+	Your final code should end up looking something like this.
		+	<pre>
		+	using System;
		+	using System.Collections.Generic;
		+	using System.Text;
		+	using Sims3.Gameplay.Objects.Decorations;
		+	using Sims3.Gameplay.Interactions;
		+	using Sims3.Gameplay.Actors;
		+	using Sims3.UI;
		+	using Sims3.Gameplay.Autonomy;
		+	using Sims3.SimIFace;
		+	using Sims3.Gameplay.ObjectComponents;
		+
		+	namespace ScriptTutorial
		+	{
		+	public class MyFishTank : FishTank
		+	{
		+	public sealed class Hello : Interaction<Sim, MyFishTank>
		+	{
		+	public static readonly InteractionDefinition Singleton = new Definition();
		+
		+	public override bool Run()
		+	{
		+	base.Actor.ShowTNSIfSelectable("Hi", StyledNotification.NotificationStyle.kSimTalking);
		+	return true;
		+	}
		+
		+	public sealed class Definition : InteractionDefinition<Sim, MyFishTank, Hello>
		+	{
		+	public override string GetInteractionName(Sim actor, MyFishTank target, InteractionObjectPair iop)
		+	{
		+	return "Hello";
		+	}
		+	public override bool Test(Sim actor, MyFishTank target, bool isAutonomous, ref GreyedOutTooltipCallback greyedOutTooltipCallback)
		+	{
		+	throw new NotImplementedException();
		+	}
		+	}
		+	}
		+
		+	[Tunable]
		+	public static CleanableComponent.Tuning kCleanableTuning = new CleanableComponent.Tuning();
		+
		+	[Tunable]
		+	public static FishTank.FishTankTuning kFishTankTuning = new FishTank.FishTankTuning();
		+
		+	public override CleanableComponent.Tuning CleanableTuning
		+	{
		+	get
		+	{
		+	return kCleanableTuning;
		+	}
		+	}
		+
		+	public override string SoundLoopName
		+	{
		+	get
		+	{
		+	return "aquarium_pump_lp";
		+	}
		+	}
		+
		+	public override FishTank.FishTankTuning Tuning
		+	{
		+	get
		+	{
		+	return kFishTankTuning;
		+	}
		+	}
		+
		+	public override void OnStartup()
		+	{
		+	base.OnStartup();
		+	base.AddInteraction(Hello.Singleton);
		+	}
		+	}
		+	}
		+
		+	</pre>

@@ Line 38: / Line 38: @@
+|
 This is used for making a class unaccessable by anyone but you. This means that if someone references your DLL they will not be able to use methods inside that class.
 |}
 <br>
@@ Line 53: / Line 57: @@
 Now we have not just any type of DellComputer but a DellInspirion. We want the DellInspirion to have the same features as a DellComputer would have but more added to it. We would do "public class DellInspirion : DellComputer". Again, the DellInspirion is a DellComputer and the DellComputer is a Computer. So the DellInspirion would be able to use methods from DellComputer and Computer. You can keep going on with this for ever and ever.
 <br>
 == Methods ==
 Methods tell Sims 3 what to do when something happens. The game already comes with a variety of methods that you can use to implement into your script. The most common one is WorldEventHandler, TNSMessages, and Interaction methods.

@@ Line 211: / Line 211: @@
+         }
 </pre>
-This will get the tuning files that the game needs to read on our FishTank. If we had derived off of FishTankModern then we wouldn't of needed to add in these methods since it already contained them. You should now be able to compile your script.
+This will get the tuning files that the game needs to read on our FishTank. If we had derived off of FishTankModern then we wouldn't of needed to add in these methods since it already contained them. You should now be able to compile your script. For adding this to your game, refer to Buzzlers tutorial as this tutorial is meant only for scripting. http://modthesims.info/wiki.php?title=Tutorial:Sims_3_Object_Modding#Adding_The_Script_To_The_Package
 <br>
 <br>
 After that, you can attempt the Intermediate portion of this tutorial which will go over Tunables.

← Older revision		Revision as of 15:06, 9 October 2011
Line 178:		Line 178:
	</pre>		</pre>
	== Compiling ==		== Compiling ==
		+	<br>
		+	Compiling is putting all of our code together and into a DLL, or S3SA, which the game will use to read. Go under the Build>Build Solution tab. You should end up with some errors if you derived off of FishTank. That is because FishTank requires some certain methods to be inserted into our code. Inside the main class (MyFishTank), add in this:
		+	<pre>
		+	[Tunable]
		+	public static CleanableComponent.Tuning kCleanableTuning = new CleanableComponent.Tuning();
		+
		+	[Tunable]
		+	public static FishTank.FishTankTuning kFishTankTuning = new FishTank.FishTankTuning();
		+
		+	public override CleanableComponent.Tuning CleanableTuning
		+	{
		+	get
		+	{
		+	return kCleanableTuning;
		+	}
		+	}
		+
		+	public override string SoundLoopName
		+	{
		+	get
		+	{
		+	return "aquarium_pump_lp";
		+	}
		+	}
		+
		+	public override FishTank.FishTankTuning Tuning
		+	{
		+	get
		+	{
		+	return kFishTankTuning;
		+	}
		+	}
		+	</pre>
		+	This will get the tuning files that the game needs to read on our FishTank. If we had derived off of FishTankModern then we wouldn't of needed to add in these methods since it already contained them. You should now be able to compile your script.
		+	<br>
		+	Once you can now attempt Buzzlers tutorial. It gives more information about the certain types and methods that he uses and why he uses them. You should not have trouble following along after you've done this tutorial.
		+	<br>
		+	After that, you can attempt the Intermediate portion of this tutorial which will go over Tunables.

@@ Line 177: / Line 177: @@
+                 }
 </pre>
-=== Compiling ===
+== Compiling ==

← Older revision		Revision as of 14:50, 9 October 2011
Line 177:		Line 177:
	}		}
	</pre>		</pre>
		+	=== Compiling ===