Changes

Jump to navigation Jump to search
remove {{upcoming|1.6}}
Line 1: Line 1: −
{{upcoming|1.6}}
  −
   
← [[Modding:Index|Index]]
 
← [[Modding:Index|Index]]
   Line 36: Line 34:  
! token format
 
! token format
 
! output
 
! output
 +
|-
 +
| <samp>[AchievementName {{t|id}}]</samp>
 +
| The translated display name for an achievement from [[Modding:Achievement data|<samp>Data/Achievements</samp>]]. For example, <samp>[AchievementName 5]</samp> will output ''A Complete Collection'' in English.
 
|-
 
|-
 
| <samp>[ArticleFor {{t|word}}]</samp>
 
| <samp>[ArticleFor {{t|word}}]</samp>
Line 66: Line 67:  
| <samp>[GenderedText {{t|male text}} {{t|female text}}</samp>
 
| <samp>[GenderedText {{t|male text}} {{t|female 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 text or female text. If the text contains spaces, you'll need to escape them using <samp>EscapedText</samp>.
 +
|-
 +
| <samp>[ItemName {{t|id}} {{o|fallback text}}]</samp>
 +
| The translated display name for an item based on its qualified or unqualified item ID. For example, <samp>[ItemName (O)128]</samp> will output ''Pufferfish'' in English.
 +
 +
If the item doesn't exist, it'll output {{o|fallback text}} if specified, else ''Error Item ({{t|id}})''.
 
|-
 
|-
 
| <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>
| Translation text loaded from the given [[Modding:Modder Guide/Game Fundamentals#String keys|string key]]. If the translation has placeholder tokens like <samp>{0}</samp>, you can add the values after the string key.
+
| Translation text loaded from the given [[Modding:Common data field types#Translation keys|translation key]]. If the translation has placeholder tokens like <samp>{0}</samp>, you can add the values after the string key.
 
|-
 
|-
 
| <samp>[LocationName {{t|location ID}}]</samp>
 
| <samp>[LocationName {{t|location ID}}]</samp>
 
| The translated display name for a location given its ID [[Modding:location data|in <samp>Data/Locations</samp>]].
 
| The translated display name for a location given its ID [[Modding:location data|in <samp>Data/Locations</samp>]].
 +
|-
 +
| <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>[NumberWithSeparators {{t|number}}]</samp>
 +
| Format a number with thousands separators based on the current language. For example, <samp>[NumberWithSeparators 5000000]</samp> will output ''5,000,000'' in English.
 
|-
 
|-
 
| <samp>[PositiveAdjective]</samp>
 
| <samp>[PositiveAdjective]</samp>
Line 78: Line 90:  
| <samp>[Season]</samp>
 
| <samp>[Season]</samp>
 
| The current season name, like ''spring''.
 
| The current season name, like ''spring''.
 +
|-
 +
| <samp>[SpecialOrderName {{t|id}}]</samp>
 +
| The translated display name for a special order from [[Modding:Special orders|<samp>Data/SpecialOrders</samp>]]. If the special order is currently active, it'll show the same name shown in the quest log. For example, <samp>[SpecialOrder Caroline]</samp> will output ''Island Ingredients'' in English.
 
|-
 
|-
 
| <samp>[SpouseFarmerText {{t|spouse is farmer text}} {{t|spouse is NPC text}}</samp>
 
| <samp>[SpouseFarmerText {{t|spouse is farmer text}} {{t|spouse is NPC text}}</samp>
Line 89: Line 104:     
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.
 
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.
 +
|-
 +
| <samp>[ToolName {{t|id}} {{o|upgrade level}}]</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.
 
|}
 
|}
    
==Extensibility for C# mods==
 
==Extensibility for C# mods==
C# mods can define custom tokens by calling <code>TokenParser.RegisterParser("tokenName", ...)</code>. To avoid conflicts, prefixing custom condition names with your mod ID (like <samp>Example.ModId_TokenName</samp>) is strongly recommended.
+
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.
    
[[Category:Modding]]
 
[[Category:Modding]]
translators
8,445

edits

Navigation menu