Tutorial:Localisation - Revision history

Natha at 14:22, 21 April 2026

2026-04-21T14:22:31Z

← Older revision		Revision as of 14:22, 21 April 2026
Line 84:		Line 84:
	\|<code>[recipe-name]</code>		\|<code>[recipe-name]</code>
	\|-		\|-
	\|<code>[shortcut]</code>		\|<code>[shortcut-name]</code>
	\|-		\|-
	\|<code>[story]</code>		\|<code>[story]</code>

Bilka: /* List of built-in parameters */ Updated to 2.0.66

2025-09-20T14:37:57Z

List of built-in parameters: Updated to 2.0.66

← Older revision		Revision as of 14:37, 20 September 2025
Line 144:		Line 144:
	* <code>__ALT_CONTROL_LEFT_CLICK__n__</code> is replaced with <code>control-keys.mouse-button-1-alt-n</code> or <code>control-keys.controller-button-alt-n</code> (with parameter <code>control-keys.controller-b</code>)		* <code>__ALT_CONTROL_LEFT_CLICK__n__</code> is replaced with <code>control-keys.mouse-button-1-alt-n</code> or <code>control-keys.controller-button-alt-n</code> (with parameter <code>control-keys.controller-b</code>)
	* <code>__ALT_CONTROL_RIGHT_CLICK__n__</code> is replaced with <code>control-keys.mouse-button-2-alt-n</code> or <code>control-keys.controller-button-alt-n</code> (with parameter <code>control-keys.controller-x</code>)		* <code>__ALT_CONTROL_RIGHT_CLICK__n__</code> is replaced with <code>control-keys.mouse-button-2-alt-n</code> or <code>control-keys.controller-button-alt-n</code> (with parameter <code>control-keys.controller-x</code>)
			* <code>__ALT_CONTROL__n__name__</code>
			* <code>__CONTROL_MOVE__</code> - The Movement keys, squished together. Example: "WASD", from a conventional QWERTY English keyboard.
	* <code>__REMARK_COLOR_BEGIN__</code>		* <code>__REMARK_COLOR_BEGIN__</code>
	* <code>__REMARK_COLOR_END__</code>		* <code>__REMARK_COLOR_END__</code>
	* <code>__ALT_CONTROL__n__name__</code>
	* <code>__CONTROL_MOVE__</code> - The Movement keys, squished together. Example: "WASD", from a conventional QWERTY English keyboard.
	* <code>__ENTITY__name__</code> - The localised name of the [https://lua-api.factorio.com/latest/prototypes/EntityPrototype.html EntityPrototype] subclass.		* <code>__ENTITY__name__</code> - The localised name of the [https://lua-api.factorio.com/latest/prototypes/EntityPrototype.html EntityPrototype] subclass.
			* <code>__FLUID__name__</code> - The localised name of the [https://lua-api.factorio.com/latest/prototypes/FluidPrototype.html FluidPrototype].
	* <code>__ITEM__name__</code> - The localised name of the [https://lua-api.factorio.com/latest/prototypes/ItemPrototype.html ItemPrototype] or subclass.		* <code>__ITEM__name__</code> - The localised name of the [https://lua-api.factorio.com/latest/prototypes/ItemPrototype.html ItemPrototype] or subclass.
			* <code>__PLANET__name__</code> - The localised name of the [https://lua-api.factorio.com/latest/prototypes/SpaceLocationPrototype.html SpaceLocationPrototype] or subclass.
	* <code>__TILE__name__</code> - The localised name of the [https://lua-api.factorio.com/latest/prototypes/TilePrototype.html TilePrototype].		* <code>__TILE__name__</code> - The localised name of the [https://lua-api.factorio.com/latest/prototypes/TilePrototype.html TilePrototype].
	* <code>__FLUID__name__</code> - The localised name of the [https://lua-api.factorio.com/latest/prototypes/FluidPrototype.html FluidPrototype].

	=== Plurals ===		=== Plurals ===

Bilka: /* Plurals */ Clarify negatives and SI prefixes, param doesn't need to be part of the string

2025-09-20T14:34:39Z

Plurals: Clarify negatives and SI prefixes, param doesn't need to be part of the string

← Older revision		Revision as of 14:34, 20 September 2025
Line 161:		Line 161:
	The number after <code>__plural_for_parameter__</code> denotes which parameter is used to determine the plural. This is the parameter 1 in the above example. Anything inside the {} is used to make the plural. Each plural form is separated by a \|.		The number after <code>__plural_for_parameter__</code> denotes which parameter is used to determine the plural. This is the parameter 1 in the above example. Anything inside the {} is used to make the plural. Each plural form is separated by a \|.
	The text in front of the = determines for what the plural form is used. Options for this are:		The text in front of the = determines for what the plural form is used. Options for this are:
	* a simple number, e.g. "1".		* A simple number, e.g. "1".
	* Multiple numbers, e.g. "2,3,4".		* Multiple numbers, e.g. "2,3,4".
	* What the number ends with, e.g. "ends in 11" or "ends in 1"		* What the number ends with, e.g. "ends in 11" or "ends in 1"
Line 167:		Line 167:
	* "decimal" for any number with a fractional part.		* "decimal" for any number with a fractional part.
	* "rest" to give the default plural.		* "rest" to give the default plural.

			For negative numbers the plural is picked as if the number was positive, so a plural like <code>__plural_for_parameter__1__{1=day\|rest=days}__</code> will result in "-1 day" for -1.<br>
			For numbers with a SI prefix the plural is picked as if the number was fully written out, so a plural like <code>__plural_for_parameter__1__{1=day\|1000=eons\|rest=days}__</code> will result in "1k eons" for 1k.

	Plural forms may be empty or contain other keys such as __1__ or spaces. This allows rather large plural forms:		Plural forms may be empty or contain other keys such as __1__ or spaces. This allows rather large plural forms:
Line 172:		Line 175:
	<pre>__plural_for_parameter__1__{1=__1__ player is\|rest=__1__ players are}__ connecting</pre>		<pre>__plural_for_parameter__1__{1=__1__ player is\|rest=__1__ players are}__ connecting</pre>

	The system ~~chooses~~ the first fitting plural that it encounters when multiple would fit:		The system picks the first fitting plural that it encounters when multiple would fit:
	<pre>__plural_for_parameter__1__{ends in 12=option 1\|ends in 2=option 2\|rest=option 3}__</pre>		<pre>__plural_for_parameter__1__{ends in 12=option 1\|ends in 2=option 2\|rest=option 3}__</pre>
	This will result in "option 1" for 12 and in "option 2" for 22 and in "option 3" for numbers not ending with 2.		This will result in "option 1" for 12 and in "option 2" for 22 and in "option 3" for numbers not ending with 2.

			The parameter used for pluralisation does not need to be present in the string. For example, a parameter could represent the number of list items present in another parameter:
			<pre>
			I like __plural_for_parameter__1__{1=only one thing:\|rest=these things:} __2__
			</pre>
			Can result in "I like only one thing: trains", or in "I like these things: trains and turtles".

	=== Concatenating localised strings ===		=== Concatenating localised strings ===

Bilka: /* See also */ and the other one too

2025-08-12T15:20:00Z

Bilka: /* See also */ link fix

2025-08-12T15:18:47Z

Bilka: fixed link#

2025-05-29T09:43:58Z

fixed link#

← Older revision		Revision as of 09:43, 29 May 2025
Line 220:		Line 220:
	Example: The transport-belt item does not have a localised_name, so 1->2. There is a place result, but not localised_name in the entity prototype. 2->3. The place result lacks a localised_name. Use the localised string {"entity-name.transport-belt"}		Example: The transport-belt item does not have a localised_name, so 1->2. There is a place result, but not localised_name in the entity prototype. 2->3. The place result lacks a localised_name. Use the localised string {"entity-name.transport-belt"}

	Such defaults often include a "leading key" using [<group>-name] or [<group>-description] (such as [recipe-name], [mod-setting-description]). However, each prototype may have a distinct search behavior before using those, based on presence/absence of values in the prototype. [~~[Prototype~~/~~Recipe]~~] for example may use the first product's localised_name, or the main_product's localised_name, or the localised string found in {"recipe-name.<recipe name>"], depending on values provided (and lacking) in the prototype.		Such defaults often include a "leading key" using [<group>-name] or [<group>-description] (such as [recipe-name], [mod-setting-description]). However, each prototype may have a distinct search behavior before using those, based on presence/absence of values in the prototype. [https://lua-api.factorio.com/latest/prototypes/RecipePrototype.html RecipePrototype] for example may use the first product's localised_name, or the main_product's localised_name, or the localised string found in {"recipe-name.<recipe name>"], depending on values provided (and lacking) in the prototype.

	== See also ==		== See also ==

Bilka: /* Plurals */ the 2.0 change got incorporated into the examples now

2025-02-10T18:33:26Z

Plurals: the 2.0 change got incorporated into the examples now

← Older revision		Revision as of 18:33, 10 February 2025
Line 167:		Line 167:
	* "decimal" for any number with a fractional part.		* "decimal" for any number with a fractional part.
	* "rest" to give the default plural.		* "rest" to give the default plural.

	'''Starting with version 2.0''', there have to be two underscores surrounding the number that denotes which parameter is used to determine the plural: <code>__plural_for_parameter__1__{1=day\|rest=days}__</code>

	Plural forms may be empty or contain other keys such as __1__ or spaces. This allows rather large plural forms:		Plural forms may be empty or contain other keys such as __1__ or spaces. This allows rather large plural forms:

StrangePan: Add information for localising decimal numbers

2024-11-14T16:42:24Z

Add information for localising decimal numbers

← Older revision		Revision as of 16:42, 14 November 2024
Line 165:		Line 165:
	* What the number ends with, e.g. "ends in 11" or "ends in 1"		* What the number ends with, e.g. "ends in 11" or "ends in 1"
	* Multiple ends with, e.g. "ends in 1,ends in 2,ends in 12".		* Multiple ends with, e.g. "ends in 1,ends in 2,ends in 12".
			* "decimal" for any number with a fractional part.
	* "rest" to give the default plural.		* "rest" to give the default plural.

Nallaj: Fix broken link

2024-11-10T13:27:42Z

Fix broken link

← Older revision		Revision as of 13:27, 10 November 2024
Line 197:		Line 197:

	== Accessing the localised result in code ==		== Accessing the localised result in code ==
	While usually unneeded, it is possible to read the resulting localised text in code, for example to search in localised names. See [https://lua-api.factorio.com/latest/LuaPlayer.html#LuaPlayer.~~request_translation~~ LuaPlayer::~~request_translation~~] and [https://lua-api.factorio.com/latest/events.html#on_string_translated on_string_translated event].		While usually unneeded, it is possible to read the resulting localised text in code, for example to search in localised names.

			See
			[https://lua-api.factorio.com/latest/classes/LuaPlayer.html#request_translation LuaPlayer::request_translation],
			[https://lua-api.factorio.com/latest/classes/LuaPlayer.html#request_translations LuaPlayer::request_translations] and
			[https://lua-api.factorio.com/latest/events.html#on_string_translated on_string_translated event].

	== Default Behavior(s) for finding an Unspecified Localised String ==		== Default Behavior(s) for finding an Unspecified Localised String ==

PennyJim: Update plural_for_parameter's 2.0 syntax

2024-11-09T22:19:06Z

Update plural_for_parameter's 2.0 syntax

← Older revision		Revision as of 22:19, 9 November 2024
Line 156:		Line 156:
	Pluralization can be used in any string that uses a parameter (e.g. __1__) that is numeric, so something like an amount of minutes. It can be used multiple times per string.		Pluralization can be used in any string that uses a parameter (e.g. __1__) that is numeric, so something like an amount of minutes. It can be used multiple times per string.

	<pre>format-days=__1__ ~~__plural_for_parameter_1_~~{1=day\|rest=days}__</pre>		<pre>format-days=__1__ __plural_for_parameter__1__{1=day\|rest=days}__</pre>
	This results in "1 day" and "2 days" / "500 days" etc.		This results in "1 day" and "2 days" / "500 days" etc.

	The number after <code>~~__plural_for_parameter_~~</code> denotes which parameter is used to determine the plural. This is the parameter 1 in the above example. Anything inside the {} is used to make the plural. Each plural form is separated by a \|.		The number after <code>__plural_for_parameter__</code> denotes which parameter is used to determine the plural. This is the parameter 1 in the above example. Anything inside the {} is used to make the plural. Each plural form is separated by a \|.
	The text in front of the = determines for what the plural form is used. Options for this are:		The text in front of the = determines for what the plural form is used. Options for this are:
	* a simple number, e.g. "1".		* a simple number, e.g. "1".
Line 171:		Line 171:
	Plural forms may be empty or contain other keys such as __1__ or spaces. This allows rather large plural forms:		Plural forms may be empty or contain other keys such as __1__ or spaces. This allows rather large plural forms:

	<pre>~~__plural_for_parameter_1_~~{1=__1__ player is\|rest=__1__ players are}__ connecting</pre>		<pre>__plural_for_parameter__1__{1=__1__ player is\|rest=__1__ players are}__ connecting</pre>

	The system chooses the first fitting plural that it encounters when multiple would fit:		The system chooses the first fitting plural that it encounters when multiple would fit:
	<pre>~~__plural_for_parameter_1_~~{ends in 12=option 1\|ends in 2=option 2\|rest=option 3}__</pre>		<pre>__plural_for_parameter__1__{ends in 12=option 1\|ends in 2=option 2\|rest=option 3}__</pre>
	This will result in "option 1" for 12 and in "option 2" for 22 and in "option 3" for numbers not ending with 2.		This will result in "option 1" for 12 and in "option 2" for 22 and in "option 3" for numbers not ending with 2.

← Older revision		Revision as of 15:20, 12 August 2025
Line 223:		Line 223:

	== See also ==		== See also ==
	* [https://lua-api.factorio.com/latest/types/LocalisedString.html data stage doc]		* [https://lua-api.factorio.com/latest/types/LocalisedString.html LocalisedString data stage doc]
	* [https://lua-api.factorio.com/latest/~~Concepts~~.html~~#LocalisedString~~ LocalisedString control stage doc]		* [https://lua-api.factorio.com/latest/concepts/LocalisedString.html LocalisedString control stage doc]

	[[Category:Modding]]		[[Category:Modding]]

← Older revision		Revision as of 15:18, 12 August 2025
Line 223:		Line 223:

	== See also ==		== See also ==
	* [~~[Types~~/LocalisedString~~\|LocalisedString~~ data stage doc]]		* [https://lua-api.factorio.com/latest/types/LocalisedString.html data stage doc]
	* [https://lua-api.factorio.com/latest/Concepts.html#LocalisedString LocalisedString control stage doc]		* [https://lua-api.factorio.com/latest/Concepts.html#LocalisedString LocalisedString control stage doc]

	[[Category:Modding]]		[[Category:Modding]]