Translations (SourceMod Scripting) - Revision history

Joinedsenses: Update highlighting

2020-03-29T23:43:18Z

Update highlighting

Nanochip: Added sm_reload_translations command

2018-01-01T19:46:01Z

Added sm_reload_translations command

Xerox8521: /* File Format */

2015-08-23T15:25:57Z

‎File Format

Xerox8521: /* Usage in a Plugin */ Updated to 1.7 Syntax

2015-08-12T23:55:43Z

‎Usage in a Plugin: Updated to 1.7 Syntax

Powerlord: /* Usage in a Plugin */

2013-09-24T21:29:51Z

‎Usage in a Plugin

Powerlord: /* Usage in a Plugin */

2013-09-24T21:29:31Z

‎Usage in a Plugin

Powerlord: FormatNativeString comment

2013-09-24T21:28:54Z

FormatNativeString comment

Javalia: /* File Format */

2011-02-07T11:35:18Z

‎File Format

Javalia: /* File Format */

2011-01-26T11:30:29Z

‎File Format

BAILOPAN at 06:00, 29 December 2008

2008-12-29T06:00:36Z

← Older revision		Revision as of 23:43, 29 March 2020
Line 20:		Line 20:
	<pre>"Phrases"		<pre>"Phrases"
	{		{
−	"Welcome"	+	"Welcome"
−	{	+	{
−	"en" "Welcome to SourceMod"	+	"en" "Welcome to SourceMod"
−	"es" "Bienvenidos a SourceMod"	+	"es" "Bienvenidos a SourceMod"
−	}	+	}
	}</pre>		}</pre>

Line 30:		Line 30:
	<pre>"Phrases"		<pre>"Phrases"
	{		{
−	"Pants"	+	"Pants"
−	{	+	{
−	"en" "pants"	+	"en" "pants"
−	"es" "pantalones"	+	"es" "pantalones"
−	}	+	}
−	//INVALID EXAMPLE: "Bail's pants are on fire"	+	//INVALID EXAMPLE: "Bail's pants are on fire"
−	"OnFire_plural"	+	"OnFire_plural"
−	{	+	{
−	"en" "%s's %s are on fire!"	+	"en" "%s's %s are on fire!"
−	"es" "¡Los %s de %s están en llamas!"	+	"es" "¡Los %s de %s están en llamas!"
−	}	+	}
	}</pre>		}</pre>

Line 46:		Line 46:
	<pre>"Phrases"		<pre>"Phrases"
	{		{
−	//Example: "Bail's pants are on fire"	+	//Example: "Bail's pants are on fire"
−	"OnFire_plural"	+	"OnFire_plural"
−	{	+	{
−	"#format" "{1:s},{2:s}"	+	"#format" "{1:s},{2:s}"
−	"en" "{1}'s {2} are on fire!"	+	"en" "{1}'s {2} are on fire!"
−	"es" "¡Los {2} de {1} están en llamas"	+	"es" "¡Los {2} de {1} están en llamas"
−	}	+	}
−	//Example: "Hello, Bail!"	+	//Example: "Hello, Bail!"
−	"Hello"	+	"Hello"
−	{	+	{
−	"#format" "{1:s}"	+	"#format" "{1:s}"
−	"en" "Hello, {1}"	+	"en" "Hello, {1}"
−	"es" "Hola, {1}"	+	"es" "Hola, {1}"
−	}	+	}
	}</pre>		}</pre>

Line 87:		Line 87:

	Examples of this are:		Examples of this are:
−	<~~pawn~~>char name[32], buffer[128];	+	<sourcepawn>char name[32], buffer[128];
	GetClientName(client, name, sizeof(name));		GetClientName(client, name, sizeof(name));
	PrintToChat(client, "[SourceMod] %T", "Hello", client, name);		PrintToChat(client, "[SourceMod] %T", "Hello", client, name);
−	Format(buffer, sizeof(buffer), "[SourceMod] %T", "Hello", LANG_SERVER, name);</~~pawn~~>	+	Format(buffer, sizeof(buffer), "[SourceMod] %T", "Hello", LANG_SERVER, name);</sourcepawn>

	A breakdown of the format parameters:		A breakdown of the format parameters:
Line 98:		Line 98:

	Lastly, there is a second form of inline translation, using '%t'. This is only allowed in functions which act directly on one or more clients. It eliminates the second parameter, and uses the original client specified. Example:		Lastly, there is a second form of inline translation, using '%t'. This is only allowed in functions which act directly on one or more clients. It eliminates the second parameter, and uses the original client specified. Example:
−	<~~pawn~~>PrintToChat(client, "[SourceMod] %t", "Hello", name);</~~pawn~~>	+	<sourcepawn>PrintToChat(client, "[SourceMod] %t", "Hello", name);</sourcepawn>

	As you can see from this example, we did not have to specify the client index more than once. Thus, it is usually more convenient to use the limited '%t' version in functions such as <tt>PrintToChat</tt>. However, in functions which are not "player directed," such as <tt>Format</tt> or <tt>PrintToServer</tt>, only '%T' can be used.		As you can see from this example, we did not have to specify the client index more than once. Thus, it is usually more convenient to use the limited '%t' version in functions such as <tt>PrintToChat</tt>. However, in functions which are not "player directed," such as <tt>Format</tt> or <tt>PrintToServer</tt>, only '%T' can be used.
Line 108:		Line 108:
	<pre>"Phrases"		<pre>"Phrases"
	{		{
−	//Example: "Hello, Bail!"	+	//Example: "Hello, Bail!"
−	"Hello"	+	"Hello"
−	{	+	{
−	"#format" "{1:s}"	+	"#format" "{1:s}"
−	"en" "Hello, {1}"	+	"en" "Hello, {1}"
−	}	+	}
	}</pre>		}</pre>

Line 119:		Line 119:
	<pre>"Phrases"		<pre>"Phrases"
	{		{
−	//Example: "Hello, Bail!"	+	//Example: "Hello, Bail!"
−	"Hello"	+	"Hello"
−	{	+	{
−	"es" "Hola, {1}"	+	"es" "Hola, {1}"
−	}	+	}
	}</pre>		}</pre>

@@ Line 75: / Line 75: @@
 Plugins must call <tt>LoadTranslations</tt> on each translation file they wish to use.  Failure to do so will cause any translations to fail, even if another plugin loads the same file.  This is to help prevent phrase-clashes between plugins.
-'''Note''': Language files are reloaded every mapchange. Even if the plugin gets reloaded, the translation file stays cached until next map.
+'''Note''': Language files are reloaded every mapchange or with the command '''sm_reload_translations'''. Even if the plugin gets reloaded, the translation file stays cached until next map.
 '''Note''': <tt>FormatNativeString</tt> uses phrases from the calling plugin, not your plugin.

@@ Line 68: / Line 68: @@
 *'''s''': String display
 *'''c''': Character display (UTF-8 compatible)
-*'''t''': include and traslate another Phrases
+*'''t''': include and translate another Phrases
 Note that currently, the special "%T" format type is not allowed inside a language translation string. but you still can use %t inside the format string

@@ Line 87: / Line 87: @@
 Examples of this are:
-<pawn>new String:name[32], String:buffer[128];
+<pawn>char name[32], buffer[128];
 GetClientName(client, name, sizeof(name));
 PrintToChat(client, "[SourceMod] %T", "Hello", client, name);

@@ Line 77: / Line 77: @@
 '''Note''': Language files are reloaded every mapchange. Even if the plugin gets reloaded, the translation file stays cached until next map.
-'''Note''': FormatNativeString uses phrases from the calling plugin, not your plugin.
+'''Note''': <tt>FormatNativeString</tt> uses phrases from the calling plugin, not your plugin.
 Inline translation works in any [[Format Class Functions (SourceMod Scripting)|format-class]] of functions.  A new format specifier, '%T', is introduced, which instructs the format routine to insert a translated phrase.  Unlike all other format specifiers, this requires a minimum of two parameters:

← Older revision		Revision as of 21:28, 24 September 2013
Line 76:		Line 76:

	'''Note''': Language files are reloaded every mapchange. Even if the plugin gets reloaded, the translation file stays cached until next map.		'''Note''': Language files are reloaded every mapchange. Even if the plugin gets reloaded, the translation file stays cached until next map.
		+
		+	'''Note''': <pre>FormatNativeString</pre> uses phrases from the calling plugin, not your plugin.

	Inline translation works in any [[Format Class Functions (SourceMod Scripting)\|format-class]] of functions. A new format specifier, '%T', is introduced, which instructs the format routine to insert a translated phrase. Unlike all other format specifiers, this requires a minimum of two parameters:		Inline translation works in any [[Format Class Functions (SourceMod Scripting)\|format-class]] of functions. A new format specifier, '%T', is introduced, which instructs the format routine to insert a translated phrase. Unlike all other format specifiers, this requires a minimum of two parameters:

← Older revision		Revision as of 06:00, 29 December 2008
Line 98:		Line 98:

	As you can see from this example, we did not have to specify the client index more than once. Thus, it is usually more convenient to use the limited '%t' version in functions such as <tt>PrintToChat</tt>. However, in functions which are not "player directed," such as <tt>Format</tt> or <tt>PrintToServer</tt>, only '%T' can be used.		As you can see from this example, we did not have to specify the client index more than once. Thus, it is usually more convenient to use the limited '%t' version in functions such as <tt>PrintToChat</tt>. However, in functions which are not "player directed," such as <tt>Format</tt> or <tt>PrintToServer</tt>, only '%T' can be used.
		+
		+
		+	=Distributing Language Files=
		+	As of SourceMod 1.1, there is a new preferred method of shipping translations. By default, the main translation file should only contain English phrases. Additional translations are made in separate files, under a folder named after the ISO language code in <tt>languages.cfg</tt>.
		+
		+	For example, <tt>translations/stuff.phrases.txt</tt> might contain this:
		+	<pre>"Phrases"
		+	{
		+	//Example: "Hello, Bail!"
		+	"Hello"
		+	{
		+	"#format" "{1:s}"
		+	"en" "Hello, {1}"
		+	}
		+	}</pre>
		+
		+	A user who translates this to Spanish would create <tt>translations/es/stuff.phrases.txt</tt>:
		+	<pre>"Phrases"
		+	{
		+	//Example: "Hello, Bail!"
		+	"Hello"
		+	{
		+	"es" "Hola, {1}"
		+	}
		+	}</pre>
		+
		+	This system makes maintaining and checking the validity of files much easier.