Modding:Mail data - Revision history

imported>Selph: fix incorrect spelling of JojaMember

2026-09-07T02:57:18Z

fix incorrect spelling of JojaMember

← Older revision		Revision as of 02:57, 7 September 2026
Line 331:		Line 331:
	The game tracks ''mail flags'' for each player. This is used for two purposes:		The game tracks ''mail flags'' for each player. This is used for two purposes:
	* Tracking received letters. The key for each letter in <samp>Data\Mail</samp> is a mail flag; if the player has the flag for a letter, the game considers it to be received.		* Tracking received letters. The key for each letter in <samp>Data\Mail</samp> is a mail flag; if the player has the flag for a letter, the game considers it to be received.
	* Tracking non-mail changes in the world. For example, <samp>artifactFound</samp> means the player has found at least one artifact, <samp>~~jojaMember~~</samp> means the player has a Joja membership, etc. These have no letter associated with them.		* Tracking non-mail changes in the world. For example, <samp>artifactFound</samp> means the player has found at least one artifact, <samp>JojaMember</samp> means the player has a Joja membership, etc. These have no letter associated with them.

	Letter IDs can be used as mail flags once they are received by the player. Alternatively, you can define and send a letter ID in the mail send command itself (such as by using [[Modding:Trigger actions\|trigger actions]] or [[Modding:Event data\|event commands]]) without including a corresponding Data/Mail entry. Doing so will lead to the player receiving the mail flag, which can be checked using the methods below, without the player receiving an actual letter in their mailbox.		Letter IDs can be used as mail flags once they are received by the player. Alternatively, you can define and send a letter ID in the mail send command itself (such as by using [[Modding:Trigger actions\|trigger actions]] or [[Modding:Event data\|event commands]]) without including a corresponding Data/Mail entry. Doing so will lead to the player receiving the mail flag, which can be checked using the methods below, without the player receiving an actual letter in their mailbox.
Line 408:		Line 408:
	\| The movie theater has been constructed, either through the community path (only <samp>ccMovieTheater</samp> is set) or through Joja (both are set).		\| The movie theater has been constructed, either through the community path (only <samp>ccMovieTheater</samp> is set) or through Joja (both are set).
	\|-		\|-
	\| <samp>~~jojaMember~~</samp>		\| <samp>JojaMember</samp>
	\| The player bought a [[JojaMart]] membership.		\| The player bought a [[JojaMart]] membership.
	\|}		\|}

imported>SiTheGreat: Clarified mail flags

2026-05-04T08:55:52Z

Clarified mail flags

← Older revision		Revision as of 08:55, 4 May 2026
Line 332:		Line 332:
	* Tracking received letters. The key for each letter in <samp>Data\Mail</samp> is a mail flag; if the player has the flag for a letter, the game considers it to be received.		* Tracking received letters. The key for each letter in <samp>Data\Mail</samp> is a mail flag; if the player has the flag for a letter, the game considers it to be received.
	* Tracking non-mail changes in the world. For example, <samp>artifactFound</samp> means the player has found at least one artifact, <samp>jojaMember</samp> means the player has a Joja membership, etc. These have no letter associated with them.		* Tracking non-mail changes in the world. For example, <samp>artifactFound</samp> means the player has found at least one artifact, <samp>jojaMember</samp> means the player has a Joja membership, etc. These have no letter associated with them.

			Letter IDs can be used as mail flags once they are received by the player. Alternatively, you can define and send a letter ID in the mail send command itself (such as by using [[Modding:Trigger actions\|trigger actions]] or [[Modding:Event data\|event commands]]) without including a corresponding Data/Mail entry. Doing so will lead to the player receiving the mail flag, which can be checked using the methods below, without the player receiving an actual letter in their mailbox.

			In other words, if the letter has a Data/Mail entry, the player will receive both the mail flag and the visible mail in their mailbox. If the letter does not have a Data/Mail entry, the player will only receive the mail flag, which is invisible to them.

	You can check the mail flags in-game:		You can check the mail flags in-game:

imported>SiTheGreat: added a letter example

2026-05-04T08:15:36Z

added a letter example

@@ Line 279: / Line 279: @@
 | Attach a special order with the given ID to the letter. If {{o|immediately}} is true, the order is accepted automatically. (If the player has the <samp>NOSPECIALORDER_{{t|order ID}}</samp> mail flag set, it won't be added automatically.)
 |}
 ====Deprecated mail commands====

imported>Abagaianye: Added info about ^ being a line break

2026-03-23T07:38:28Z

Added info about ^ being a line break

← Older revision		Revision as of 07:38, 23 March 2026
Line 228:		Line 228:
	! token		! token
	! description		! description
			\|-
			\| <samp>^</samp>
			\| Replaced with a line break. Can be repeated to insert multiple line breaks.
	\|-		\|-
	\| <samp>@</samp>		\| <samp>@</samp>

imported>Margotbean: rm underscores

2025-11-22T17:50:57Z

rm underscores

← Older revision		Revision as of 17:50, 22 November 2025
Line 215:		Line 215:
	It's not recommended to use the date-based format for compatibility reasons, because if multiple mods add mail with the same key only one will get sent. If you need your mail to be sent on a specific date, see [[Modding:Trigger actions\|trigger actions]].		It's not recommended to use the date-based format for compatibility reasons, because if multiple mods add mail with the same key only one will get sent. If you need your mail to be sent on a specific date, see [[Modding:Trigger actions\|trigger actions]].

	Careful! Any keys which contain the words '<samp>Cooking</samp>' or '<samp>passOut</samp>', case sensitive, will never be "received" when sent through the mailbox (i.e. have a Letter attached). This impacts their ability to be used in [[Modding:~~Game_state_queries~~\|game state queries]] or other conditions, consider adjusting the key if you need to check for it later.		Careful! Any keys which contain the words '<samp>Cooking</samp>' or '<samp>passOut</samp>', case sensitive, will never be "received" when sent through the mailbox (i.e. have a Letter attached). This impacts their ability to be used in [[Modding:Game state queries\|game state queries]] or other conditions, consider adjusting the key if you need to check for it later.

	===Value===		===Value===
Line 428:		Line 428:
	\| [[The Beach\|Beach]]		\| [[The Beach\|Beach]]
	\| <samp>beachBridgeFixed</samp>		\| <samp>beachBridgeFixed</samp>
	\| The player repaired the bridge to the [[~~The_Beach~~#~~Tide_Pools~~\|East Pier]].		\| The player repaired the bridge to the [[The Beach#Tide Pools\|East Pier]].
	\|-		\|-
	\| [[Fish Shop]]		\| [[Fish Shop]]

imported>SwagChild: /* List */ Added flag for unlocking the beach bridge.

2025-11-21T19:32:31Z

List: Added flag for unlocking the beach bridge.

← Older revision		Revision as of 19:32, 21 November 2025
Line 425:		Line 425:
	\| <samp>openedSewer</samp>		\| <samp>openedSewer</samp>
	\| The player has unlocked the sewers.		\| The player has unlocked the sewers.
			\|-
			\| [[The Beach\|Beach]]
			\| <samp>beachBridgeFixed</samp>
			\| The player repaired the bridge to the [[The_Beach#Tide_Pools\|East Pier]].
	\|-		\|-
	\| [[Fish Shop]]		\| [[Fish Shop]]

imported>EnderTedi: Add Warning about 'Cooking' and 'passOut' names not adding the Mail ID/Key to Farmer.mailReceived

2025-10-17T16:08:59Z

Add Warning about 'Cooking' and 'passOut' names not adding the Mail ID/Key to Farmer.mailReceived

← Older revision		Revision as of 16:08, 17 October 2025
Line 214:		Line 214:

	It's not recommended to use the date-based format for compatibility reasons, because if multiple mods add mail with the same key only one will get sent. If you need your mail to be sent on a specific date, see [[Modding:Trigger actions\|trigger actions]].		It's not recommended to use the date-based format for compatibility reasons, because if multiple mods add mail with the same key only one will get sent. If you need your mail to be sent on a specific date, see [[Modding:Trigger actions\|trigger actions]].

			Careful! Any keys which contain the words '<samp>Cooking</samp>' or '<samp>passOut</samp>', case sensitive, will never be "received" when sent through the mailbox (i.e. have a Letter attached). This impacts their ability to be used in [[Modding:Game_state_queries\|game state queries]] or other conditions, consider adjusting the key if you need to check for it later.

	===Value===		===Value===

imported>BarleyZP: /* List */ Move HasUnlockedSkullDoor mail flag from special items section to unlocked areas section

2025-05-14T19:52:48Z

List: Move HasUnlockedSkullDoor mail flag from special items section to unlocked areas section

← Older revision		Revision as of 19:52, 14 May 2025
Line 463:		Line 463:
	\| <samp>Island_Turtle</samp>		\| <samp>Island_Turtle</samp>
	\| The player unlocked access to the island farm.		\| The player unlocked access to the island farm.
			\|-
			\| [[Skull Cavern]]
			\| <samp>HasUnlockedSkullDoor</samp>
			\| Whether the player has used the [[Skull Key]] to unlock the door in [[Skull Cavern]].
	\|-		\|-
	\| [[Volcano Dungeon\|Volcano]]		\| [[Volcano Dungeon\|Volcano]]
Line 561:		Line 565:
	\| <samp>HasTownKey</samp>		\| <samp>HasTownKey</samp>
	\| {{name\|Key To The Town}}		\| {{name\|Key To The Town}}
	\|-
	~~\| <samp>HasUnlockedSkullDoor</samp>~~
	~~\| Whether the player has used the [[Skull Key]] to unlock the door in [[Skull Cavern]].~~
	\|}		\|}

imported>BarleyZP: /* List */ add info about new mail flags from Modding:Migrate to Stardew Valley 1.6 (main author Pathoschild, with formatting fixes by Margotbean). Descriptions of mail flags by BarleyZP.

2025-05-14T19:50:18Z

List: add info about new mail flags from Modding:Migrate to Stardew Valley 1.6 (main author Pathoschild, with formatting fixes by Margotbean). Descriptions of mail flags by BarleyZP.

@@ Line 527: / Line 527: @@
 | Kill 200 bats
 | {{name|Vampire Ring}}
 |}

imported>BarleyZP: /* Value */ add info about %action command from Modding:Migrate to Stardew Valley 1.6 (main author Pathoschild, with formatting fixes by Margotbean)

2025-05-14T19:37:26Z

Value: add info about %action command from Modding:Migrate to Stardew Valley 1.6 (main author Pathoschild, with formatting fixes by Margotbean)

← Older revision		Revision as of 19:37, 14 May 2025
Line 243:		Line 243:
	! command		! command
	! description		! description
			\|-
			\| <samp>%action {{t\|action}} %%</samp>
			\| Run a [[Modding:Trigger actions\|trigger action string]], like <samp>%action AddMoney 500%%</samp> to add {{price\|500}} to the current player.
	\|-		\|-
	\| <samp>%item id [{{t\|item id}} {{o\|count}}]+ %%</samp>		\| <samp>%item id [{{t\|item id}} {{o\|count}}]+ %%</samp>