Tutorial:Sims 3 Localized Coding - Revision history

Buzzler: replaced STBL.exe with STBLize.exe

2015-10-02T19:53:30Z

replaced STBL.exe with STBLize.exe

Buzzler: /* What You Need */

2015-10-02T19:51:27Z

‎What You Need

Pljones: Update our URL

2013-11-01T23:55:10Z

Update our URL

Buzzler: /* What You Need */

2012-02-02T21:08:43Z

‎What You Need

Buzzler at 11:10, 19 February 2011

2011-02-19T11:10:08Z

Buzzler at 20:11, 18 February 2011

2011-02-18T20:11:22Z

Buzzler at 20:07, 18 February 2011

2011-02-18T20:07:40Z

Buzzler at 19:53, 18 February 2011

2011-02-18T19:53:31Z

Buzzler at 19:39, 18 February 2011

2011-02-18T19:39:53Z

Buzzler: /* Writing The Lookup Table */

2011-02-18T17:50:42Z

‎Writing The Lookup Table

@@ Line 163: / Line 163: @@
 Ok, what about {0.SimName}? The expression tells the localization code to insert a sim's name at that position and to get that name from the object at index zero, i.e. the first object, of the parameters array in the method call. Take another look at the method call if you don't remember it.
-Now save the file in UNICODE format to your project folder, copy STBL.exe to that same folder and drag&drop the text file on STBL.exe; it will compile the file to an STBL file.
+Now save the file in UNICODE format to your project folder, copy STBLize.exe to that same folder and drag&drop the text file on STBLize.exe; it will compile the file to an STBL file.
 If you release the mod later, you can just give translators the text file and let them translate the part in <STR> tags. You need to explain them a little bit how it works of course, and they need to be aware that they must not change the keys, but the text file has the advantage that translators don't need any special tools.
@@ Line 199: / Line 199: @@
-The STBL will be added to your package, but it's still empty. Right-click on the STBL resource, and select "Replace...". Navigate to your project folder, select the STBL file STBL.exe created and click on Open.
+The STBL will be added to your package, but it's still empty. Right-click on the STBL resource, and select "Replace...". Navigate to your project folder, select the STBL file STBLize created and click on Open.

@@ Line 19: / Line 19: @@
 * The knowledge and the tools to write object mods and/or scripting mods.
 * [[Sims_3:Locales|The locale codes]]
-* [http://nraas.wikispaces.com/How+To+Translate twallan's STBL Converter] (scroll down to the bottom) - This one isn't absolutely necessary, but it makes things a lot more convenient and will be used in this tutorial.
+* [http://www.modthesims.info/download.php?&t=565291&posted=1 STBLize] This one isn't absolutely necessary, but it makes things a lot more convenient and will be used in this tutorial.
 =Theory=

← Older revision		Revision as of 23:55, 1 November 2013
Line 220:		Line 220:
	=Final Hints And Specifics=		=Final Hints And Specifics=

−	*In this tutorial we used an external STBL compiler to build the actual string table. There are different ways to it and a couple different tools to do it. Finding the way that suits you best and how to use these tools, will be your job. Maybe have a look at [http://~~dino~~.~~drealm.info/~~den/denforum/index.php?topic=338.0 Jonha's String Tool] which is now in the caring hands of Peter Jones. Another choice may be [http://www.the-isz.com/nraas/index.php?topic=13.0 twallan's The Packer].	+	*In this tutorial we used an external STBL compiler to build the actual string table. There are different ways to it and a couple different tools to do it. Finding the way that suits you best and how to use these tools, will be your job. Maybe have a look at [http://www.den.simlogical.com/denforum/index.php?topic=338.0 Jonha's String Tool] which is now in the caring hands of Peter Jones. Another choice may be [http://www.the-isz.com/nraas/index.php?topic=13.0 twallan's The Packer].

@@ Line 19: / Line 19: @@
 * The knowledge and the tools to write object mods and/or scripting mods.
 * [[Sims_3:Locales|The locale codes]]
-* [http://www.the-isz.com/nraas/index.php?topic=330.0 twallan's STBL Converter] - This one isn't absolutely necessary, but it makes things a lot more convenient and will be used in this tutorial.
+* [http://nraas.wikispaces.com/How+To+Translate twallan's STBL Converter] (scroll down to the bottom) - This one isn't absolutely necessary, but it makes things a lot more convenient and will be used in this tutorial.
-−
-−
 =Theory=

@@ Line 118: / Line 118: @@
-As stated before, the key will be hashed. You can't just use "InteractionName" and "SayHello:InteractionName" would make a very poor string key too. Begin it with something that is unique for you, add something that makes is unique for your mod, i.e. the mod's name, and finally add something that makes it unique for the area of code. In this case, that's "<tt>TwoBTech/LocalizedMod/SayHello:</tt>", but of course that's only an example you shouldn't actually use.
+As stated before, the key will be hashed. You can't just use "InteractionName" and "SayHello:InteractionName" would make a very poor string key too. Begin it with something that is unique for you, add something that makes it unique for your mod, i.e. the mod's name, and finally add something that makes it unique for the area of code. In this case, that's "<tt>TwoBTech/LocalizedMod/SayHello:</tt>", but of course that's only an example you shouldn't actually use.
-The second parameter is for things you want to give the Localization method to build the final string. As you see it's just an empty array in this case, as there are no dependcies on the actor or target of the interaction.
+The second parameter is for things you want to give the Localization method to build the final string. As you see it's just an empty array in this case as there are no dependcies on the actor or target of the interaction.
@@ Line 127: / Line 127: @@
 <pre>Localization.LocalizeString(isFemale, "TwoBTech/LocalizedMod/SayHello:Path", new object[0])</pre>
-The last parameter is still an empty array, but now we pass the isFemale right through to the Localization method. We'll see later what to do with that.
+The last parameter is still an empty array, but now we pass <tt>isFemale</tt> right through to the Localization method. We'll see later what to do with that.
@@ Line 137: / Line 137: @@
 ===Writing The Lookup Table===
 Open a text editor and copy and paste this:
@@ Line 168: / Line 166: @@
 Now save the file in UNICODE format to your project folder, copy STBL.exe to that same folder and drag&drop the text file on STBL.exe; it will compile the file to an STBL file.
 ===String Tables===
@@ Line 215: / Line 216: @@
 ===Debugging The Localizing===
-It can be a pain to find errors in localized coding. When a didn't bring up a string, the localization code will just return an empty string. It used to return the localization key itself, but the devs changed that at some point. The best and only advice is to use a core mod that brings the old behavior back; twallan's ScriptError mod does that.
+It can be a pain to find errors in localized coding. When a key didn't bring up a string value, the localization code will just return an empty string. It used to return the localization key itself, but the devs changed that at some point. The best and only advice is to use a core mod that brings the old behavior back; twallan's ScriptError mod does that.
@@ Line 221: / Line 222: @@
 =Final Hints And Specifics=
-*In this tutorial we used an external STBL compiler to build the actual string table. There are different ways to it and a couple different tools to do it. Finding the way that suits you best and how use these tools, will be your job. Maybe have a look at [http://dino.drealm.info/den/denforum/index.php?topic=338.0 Jonha's String Tool] which is now in the caring hands of Peter Jones. Another choice may be [http://www.the-isz.com/nraas/index.php?topic=13.0 twallan's The Packer].
+*In this tutorial we used an external STBL compiler to build the actual string table. There are different ways to it and a couple different tools to do it. Finding the way that suits you best and how to use these tools, will be your job. Maybe have a look at [http://dino.drealm.info/den/denforum/index.php?topic=338.0 Jonha's String Tool] which is now in the caring hands of Peter Jones. Another choice may be [http://www.the-isz.com/nraas/index.php?topic=13.0 twallan's The Packer].
@@ Line 233: / Line 234: @@
-*Sims aren't the only objects you can pass as a parameter to the Localization methods, of course, and SimName isn't the only keywords. Also you can basically pass as many parameters as you want, just make sure that the number in the string matches the index of the parameter. Keywords without claim to completeness:
+*Sims aren't the only objects you can pass as a parameter to the Localization methods, of course, and SimName isn't the only keyword. Also you can basically pass as many parameters as you want, just make sure that the number in the string matches the index of the parameter. Keywords without claim to completeness:
 ** SimName
 ** SimFirstName

← Older revision		Revision as of 20:11, 18 February 2011
Line 247:		Line 247:

	* In this tutorial we used the localization methods directly. That's all right for smaller mods' code sections. Look at EAxian interactions and you'll find individual <tt>LocalizeString()</tt> methods and <tt>sLocalizationKey</tt> constants. It's probably a good idea to copy that style to have it a bit easier.		* In this tutorial we used the localization methods directly. That's all right for smaller mods' code sections. Look at EAxian interactions and you'll find individual <tt>LocalizeString()</tt> methods and <tt>sLocalizationKey</tt> constants. It's probably a good idea to copy that style to have it a bit easier.
		+
		+
		+
		+	=Questions=
		+	Ask them here: [http://www.modthesims.info/showthread.php?p=3451821 Q&A thread Sims 3 Localized Coding]

← Older revision		Revision as of 20:07, 18 February 2011
Line 215:		Line 215:

	===Debugging The Localizing===		===Debugging The Localizing===
−	It can be a pain to find errors in localized coding, ~~because~~ the ~~devs changed the core to show~~ empty ~~strings instead of~~ the localization ~~keys with~~ some ~~patch~~. The best and only advice is to use a core mod that ~~changes that~~ behavior back, twallan's ScriptError mod does that.	+	It can be a pain to find errors in localized coding. When a didn't bring up a string, the localization code will just return an empty string. It used to return the localization key itself, but the devs changed that at some point. The best and only advice is to use a core mod that brings the old behavior back; twallan's ScriptError mod does that.

← Older revision		Revision as of 19:53, 18 February 2011
Line 246:		Line 246:


−	* In this tutorial we used the localization methods directly. That's all right for smaller mods code sections. Look at EAxian interactions and you'll find individual <tt>LocalizeString()</tt> methods and <tt>sLocalizationKey</tt> constants. It's probably a good idea to copy that style to have it a bit easier.	+	* In this tutorial we used the localization methods directly. That's all right for smaller mods' code sections. Look at EAxian interactions and you'll find individual <tt>LocalizeString()</tt> methods and <tt>sLocalizationKey</tt> constants. It's probably a good idea to copy that style to have it a bit easier.

@@ Line 4: / Line 4: @@
 | __TOC__
 |}
-This tutorial will cover how to use the localization methods in TS3's core, and how to build the STBL resources to store the related strings. It will do so by a concrete example, but it will not cover how to embed that example in a complete script or how to get that script executed in an object mod or scripting mod.
+This tutorial will cover how to use the localization methods from TS3's core, and how to build the STBL resources to store the related strings. It will do so by a concrete example, but it will not cover how to embed that example in a complete script or how to get that script executed in an object mod or scripting mod.
-If you came here after going through the object modding tutorial, going through it successfully that is, you probably couldn't help but why the pie menu button of your interaction was blank. This is exactly the point where this tutorial carries on.
+If you came here after going through the object modding tutorial, going through it successfully that is, you probably couldn't help but wonder why the pie menu button of your interaction was blank. This is exactly the point where this tutorial carries on.
@@ Line 18: / Line 18: @@
 * The knowledge and the tools to write object mods and/or scripting mods.
-* The locale codes - [[Sims_3:Locales]]
+* [[Sims_3:Locales|The locale codes]]
-* twallan's STBL.exe - This one isn't absolutely necessary, but it makes things a lot more convenient and will be used in this tutorial.
+* [http://www.the-isz.com/nraas/index.php?topic=330.0 twallan's STBL Converter] - This one isn't absolutely necessary, but it makes things a lot more convenient and will be used in this tutorial.
@@ Line 221: / Line 221: @@
 =Final Hints And Specifics=
-*In this tutorial we used an external STBL compiler to build the actual string table. There are different ways to it and a couple different tools to do it. Finding the way that suits you best and how use these tools, will be your job. Maybe have a look at [http://dino.drealm.info/den/denforum/index.php?topic=338.0 Jonha's String Tool] which is now in the caring hands of Peter Jones.
+*In this tutorial we used an external STBL compiler to build the actual string table. There are different ways to it and a couple different tools to do it. Finding the way that suits you best and how use these tools, will be your job. Maybe have a look at [http://dino.drealm.info/den/denforum/index.php?topic=338.0 Jonha's String Tool] which is now in the caring hands of Peter Jones. Another choice may be [http://www.the-isz.com/nraas/index.php?topic=13.0 twallan's The Packer].

@@ Line 162: / Line 162: @@
 <pre>{MA.Whiny}{FA.Grumpy} Interactions</pre>
-This one looks a little different than the original hard-coded string, just to show the point of the <tt>isFemale</tt> parameter. MA/FA stands for "Male Actor"/"Female Actor". I'm actually guessing the "Actor" part, but you get the idea. The game will parse the expression and if the isFemale paramter is True, it will insert the string between '{FA.' and '}' in the final string. In this case the final string would be "Grumpy Interactions". If isFemale is False, the final string will be "Whiny Interactions". Not difficult, right?
+This one looks a little different than the original hard-coded string, just to show the point of the <tt>isFemale</tt> parameter. MA/FA stands for "Male Actor"/"Female Actor". I'm actually guessing the "Actor" part, but you get the idea. The game will parse the expression and if the <tt>isFemale</tt> paramter is True, it will insert the string between '{FA.' and '}' in the final string. In this case the final string would be "Grumpy Interactions". If isFemale is False, the final string will be "Whiny Interactions". Not difficult, right?
 <pre>Hello, {0.SimName}!</pre>
@@ Line 168: / Line 168: @@
 Now save the file in UNICODE format to your project folder, copy STBL.exe to that same folder and drag&drop the text file on STBL.exe; it will compile the file to an STBL file.
 ===String Tables===