Modding:Tokenizable strings - Revision history

imported>Sunbeam135 at 19:49, 9 January 2026

2026-01-09T19:49:03Z

← Older revision		Revision as of 19:49, 9 January 2026
Line 139:		Line 139:
	[[Category:Modding]]		[[Category:Modding]]

			[[ru:Модификации:Строки с токенами]]
	[[zh:模组:模板字符串]]		[[zh:模组:模板字符串]]

imported>Pathoschild: /* Game data */ link FarmerStat to the new Modding:Stats page, fix typo

2025-09-20T22:03:06Z

Game data: link FarmerStat to the new Modding:Stats page, fix typo

← Older revision		Revision as of 22:03, 20 September 2025
Line 47:		Line 47:
	\|-		\|-
	\| <samp>[FarmerStat {{t\|key}}]</samp>		\| <samp>[FarmerStat {{t\|key}}]</samp>
	\| The value of a ~~tracked stat for the current player. See the~~ [[Modding:~~Game state queries~~\|~~<samp>PLAYER_STAT</samp> game state query~~]] for ~~a list of useful stats~~.		\| The value of a [[Modding:Stats\|tracked stat]] for the current player.

	For example:		For example:
	<syntaxhighlight lang="js">"You've walked [FarmerStat stepsTaken] so far."</syntaxhighlight>		<syntaxhighlight lang="js">"You've walked [FarmerStat stepsTaken] steps so far."</syntaxhighlight>
	\|-		\|-
	\| <samp>[Season]</samp>		\| <samp>[Season]</samp>

imported>Malevolent-bagel: /* Localization */ , quick grammar fix

2025-09-19T18:15:14Z

Localization: , quick grammar fix

← Older revision		Revision as of 18:15, 19 September 2025
Line 108:		Line 108:
	\|-		\|-
	\| <samp>[SpouseGenderedText {{t\|male text}} {{t\|female text}} {{o\|other text}}]</samp>		\| <samp>[SpouseGenderedText {{t\|male text}} {{t\|female text}} {{o\|other text}}]</samp>
	\| Equivalent to <samp>GenderedText</samp>, but based on the gender of the player's NPC or player ~~spouse~~ instead.		\| Equivalent to <samp>GenderedText</samp>, but based on the gender of the player's spouse (NPC or another player) instead.
	\|-		\|-
	\| <samp>[ToolName {{t\|id}} {{o\|upgrade level}}]</samp>		\| <samp>[ToolName {{t\|id}} {{o\|upgrade level}}]</samp>

imported>BarleyZP: /* Localization */ Add note about "other text" for gendered tokens

2025-05-19T19:14:43Z

Localization: Add note about "other text" for gendered tokens

← Older revision		Revision as of 19:14, 19 May 2025
Line 76:		Line 76:
	\| The translated display name for an NPC, given their internal name.		\| The translated display name for an NPC, given their internal name.
	\|-		\|-
	\| <samp>[GenderedText {{t\|male text}} {{t\|female text}}</samp>		\| <samp>[GenderedText {{t\|male text}} {{t\|female text}} {{o\|other text}}]</samp>
	\| Depending on the target player's gender, show either the male ~~text~~ or ~~female~~ text. If the text contains spaces, you'll need to escape them using <samp>EscapedText</samp>.		\| Depending on the target player's gender, show either the male, female, or other text. If the text contains spaces, you'll need to escape them using <samp>EscapedText</samp>. If the player's gender is neither male nor female, the game will try to user the other text; if not provided, it will fall back on the female text.
	\|-		\|-
	\| <samp>[ItemName {{t\|id}} {{o\|fallback text}}]</samp>		\| <samp>[ItemName {{t\|id}} {{o\|fallback text}}]</samp>
Line 107:		Line 107:
	\| Show a different text depending on whether the target player's spouse is a player or NPC. If the text contains spaces, you'll need to escape them using <samp>EscapedText</samp>.		\| Show a different text depending on whether the target player's spouse is a player or NPC. If the text contains spaces, you'll need to escape them using <samp>EscapedText</samp>.
	\|-		\|-
	\| <samp>[SpouseGenderedText {{t\|male text}} {{t\|female text}}]</samp>		\| <samp>[SpouseGenderedText {{t\|male text}} {{t\|female text}} {{o\|other text}}]</samp>
	\| Equivalent to <samp>GenderedText</samp>, but based on the gender of the player's NPC or player spouse instead.		\| Equivalent to <samp>GenderedText</samp>, but based on the gender of the player's NPC or player spouse instead.
	\|-		\|-

imported>Pathoschild: /* Tokens */ add CapitalizeFirstLetter + ItemNameWithFlavor (added in 1.6.9)

2025-03-25T17:34:41Z

Tokens: add CapitalizeFirstLetter + ItemNameWithFlavor (added in 1.6.9)

← Older revision		Revision as of 17:34, 25 March 2025
Line 83:		Line 83:

	If the item doesn't exist, it'll output {{o\|fallback text}} if specified, else ''Error Item ({{t\|id}})''.		If the item doesn't exist, it'll output {{o\|fallback text}} if specified, else ''Error Item ({{t\|id}})''.
			\|-
			\| <samp>[ItemNameWithFlavor {{t\|flavor type}} {{t\|flavor ID}}]</samp>
			\| The translated display name for a flavored item name, where...
			* {{t\|flavor type}} is one of <samp>AgedRoe</samp>, <samp>Bait</samp>, <samp>DriedFruit</samp>, <samp>DriedMushroom</samp>, <samp>Honey</samp>, <samp>Jelly</samp>, <samp>Juice</samp>, <samp>Pickle</samp>, <samp>Roe</samp>, <samp>SmokedFish</samp>, or <samp>Wine</samp>;
			* {{t\|flavor ID}} is the [[Modding:Common data field types#Item ID\|qualified or qualified item ID]] for the flavor (e.g. the blueberry in blueberry wine).
	\|-		\|-
	\| <samp>[LocalizedText {{t\|string key}}]</samp><br /><samp>[LocalizedText {{t\|string key}} {{t\|token values}}+]</samp>		\| <samp>[LocalizedText {{t\|string key}}]</samp><br /><samp>[LocalizedText {{t\|string key}} {{t\|token values}}+]</samp>
Line 114:		Line 119:
	! token format		! token format
	! output		! output
			\|-
			\| <samp>[CapitalizeFirstLetter {{t\|text}}]</samp>
			\| The input text, with the first letter capitalized.
	\|-		\|-
	\| <samp>[EscapedText]</samp><br /><samp>[EscapedText {{t\|text}}]</samp>		\| <samp>[EscapedText]</samp><br /><samp>[EscapedText {{t\|text}}]</samp>

imported>Pathoschild: /* Tokens */ split into smaller subsections

2025-03-25T17:33:04Z

Tokens: split into smaller subsections

@@ Line 29: / Line 29: @@
 ==Tokens==
-Here are the tokens provided by the base game:
+Here are the tokens provided by the base game.
 {| class="wikitable"
 |-
 ! token format
 ! output
 |-
 | <samp>[DayOfMonth]</samp>
 | The numeric day of month, like <samp>5</samp> on spring 5.
 |-
 | <samp>[FarmerUniqueID]</samp>
@@ Line 64: / Line 51: @@
 For example:
 <syntaxhighlight lang="js">"You've walked [FarmerStat stepsTaken] so far."</syntaxhighlight>
 |-
 | <samp>[GenderedText {{t|male text}} {{t|female text}}</samp>
@@ Line 81: / Line 92: @@
 | <samp>[MovieName {{t|id}}]</samp>
 | The translated display name for a movie from [[Modding:Movie theater data|<samp>Data/Movies</samp>]]. For example, <samp>[MovieName spring_movie_0]</samp> will output ''The Brave Little Sapling'' in English.
 |-
 | <samp>[PositiveAdjective]</samp>
 | A random adjective from the <samp>Strings\Lexicon</samp> data asset's <samp>RandomPositiveAdjective_PlaceOrEvent</samp> entry.
 |-
 | <samp>[SpecialOrderName {{t|id}}]</samp>
@@ Line 100: / Line 105: @@
 | Equivalent to <samp>GenderedText</samp>, but based on the gender of the player's NPC or player spouse instead.
 |-
-| <samp>[SuggestedItem {{o|interval}} {{o|sync key}}]</samp>
+| <samp>[ToolName {{t|id}} {{o|upgrade level}}]</samp>
-| '''(For shops only.)''' The name of a random item currently available in the shop stock.
+| The translated display name for a tool, including its upgrade level if specified. For example, <samp>[ToolName (T)IridiumAxe]</samp> will output ''Iridium Axe'' in English.
-The result will be identical for all queries with the same {{o|sync key}} during the given {{o|interval}} (one of <samp>tick</samp>, <samp>day</samp>, <samp>season</samp>, <samp>year</samp>), including between players in multiplayer mode. If omitted, they default to <samp>day</samp> and the shop ID respectively.
+For example, the <samp>SpouseFarmerText</samp> expects two arguments separated by spaces. This passes an empty string for the first one, and text containing spaces for the second:
 |-
-| <samp>[ToolName {{t|id}} {{o|upgrade level}}]</samp>
+| <samp>[NumberWithSeparators {{t|number}}]</samp>
-| The translated display name for a tool, including its upgrade level if specified. For example, <samp>[ToolName (T)IridiumAxe]</samp> will output ''Iridium Axe'' in English.
+| Format a number with thousands separators based on the current language. For example, <samp>[NumberWithSeparators 5000000]</samp> will output ''5,000,000'' in English.
 |}

imported>Margotbean: /* Extensibility for C# mods */ add missing bracket

2024-09-25T16:11:07Z

Extensibility for C# mods: add missing bracket

← Older revision		Revision as of 16:11, 25 September 2024
Line 111:		Line 111:
	==Extensibility for C# mods==		==Extensibility for C# mods==
	* C# mods can define custom tokens by calling <code>TokenParser.RegisterParser("tokenName", ...)</code>. To avoid conflicts, custom token names should apply the [[Modding:Common data field types#Unique string ID\|unique string ID]] conventions.		* C# mods can define custom tokens by calling <code>TokenParser.RegisterParser("tokenName", ...)</code>. To avoid conflicts, custom token names should apply the [[Modding:Common data field types#Unique string ID\|unique string ID]] conventions.
	* The <samp>TokenStringBuilder</samp> class provides methods for creating token strings. For example, <code>TokenStringBuilder.ItemNameFor(item)</code> will produce a string like <code>[ItemName (O)128]</code> or <code>ItemNameWithFlavor SmokedFish (O)128]</code>.		* The <samp>TokenStringBuilder</samp> class provides methods for creating token strings. For example, <code>TokenStringBuilder.ItemNameFor(item)</code> will produce a string like <code>[ItemName (O)128]</code> or <code>[ItemNameWithFlavor SmokedFish (O)128]</code>.

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

	[[zh:模组:模板字符串]]		[[zh:模组:模板字符串]]

imported>Margotbean: zh link

2024-09-21T15:11:57Z

zh link

← Older revision		Revision as of 15:11, 21 September 2024
Line 114:		Line 114:

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

			[[zh:模组:模板字符串]]

imported>Pathoschild: /* Extensibility for C# mods */ + TokenStringBuilder

2024-09-20T22:43:04Z

Extensibility for C# mods: + TokenStringBuilder

← Older revision		Revision as of 22:43, 20 September 2024
Line 110:		Line 110:

	==Extensibility for C# mods==		==Extensibility for C# mods==
	C# mods can define custom tokens by calling <code>TokenParser.RegisterParser("tokenName", ...)</code>. To avoid conflicts, custom token names should apply the [[Modding:Common data field types#Unique string ID\|unique string ID]] conventions.		* C# mods can define custom tokens by calling <code>TokenParser.RegisterParser("tokenName", ...)</code>. To avoid conflicts, custom token names should apply the [[Modding:Common data field types#Unique string ID\|unique string ID]] conventions.
			* The <samp>TokenStringBuilder</samp> class provides methods for creating token strings. For example, <code>TokenStringBuilder.ItemNameFor(item)</code> will produce a string like <code>[ItemName (O)128]</code> or <code>ItemNameWithFlavor SmokedFish (O)128]</code>.

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

imported>Pathoschild: remove {{upcoming|1.6}}

2024-04-06T18:08:58Z

remove {{upcoming|1.6}}

← Older revision		Revision as of 18:08, 6 April 2024
Line 1:		Line 1:
	~~{{upcoming\|1.6}}~~

	← [[Modding:Index\|Index]]		← [[Modding:Index\|Index]]