Modding:Weather data - Revision history

imported>VulpesLucida: +zh link

2025-01-10T23:45:38Z

+zh link

← Older revision		Revision as of 23:45, 10 January 2025
Line 299:		Line 299:
	[[pt:Modificações:Dados climáticos]]		[[pt:Modificações:Dados climáticos]]
	[[ru:Модификации:Погодные явления]]		[[ru:Модификации:Погодные явления]]
			[[zh:模组:天气数据]]

imported>VulpesLucida: add info from Modding:Migrate to Stardew Valley 1.6 (main author Pathoschild, with formatting fixes by Margotbean)

2025-01-10T11:37:29Z

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

← Older revision		Revision as of 11:37, 10 January 2025
Line 46:		Line 46:

	==Algorithm==		==Algorithm==
			You can now change the weather algorithm by editing [[Modding:Migrate to Stardew Valley 1.6#Custom location contexts\|location context data]], and (with a C# mod) implement custom weathers.

			Fields like <samp>Game1.weather</samp> and <samp>Game1.weatherForTomorrow</samp> are now strings to support custom mod weather IDs. The change for vanilla weather has no effect on Content Patcher packs, since the new weather IDs match the ones Content Patcher was using before (i.e. <samp>Sun</samp>, <samp>Rain</samp>, <samp>Snow</samp>, <samp>Storm</samp>, and <samp>Wind</samp>). C# mods may also see a <samp>Festival</samp> weather, while Content Patcher packs will see <samp>Sun</samp> for it. The constants like <samp>Game1.weather_sunny</samp> have the new string values (with new constants like <samp>Game1.legacy_weather_sunny</samp> for the legacy values).

			The base game will treat an invalid weather as sunny. C# mods can implement custom weather effects using [[Modding:Modder Guide/APIs/Events\|normal SMAPI events]] like <samp>UpdateTicked</samp>, or by [[Modding:Modder Guide/APIs/Harmony\|patching]] methods like <samp>Game1.ApplyWeatherForNewDay</samp> and <samp>Game1.populateDebrisWeatherArray</samp>.

	===Forced weather===		===Forced weather===
	Certain dates always have the same weather:		Certain dates always have the same weather:

imported>VulpesLucida: /* Save files */ update

2025-01-10T11:31:50Z

Save files: update

← Older revision		Revision as of 11:31, 10 January 2025
Line 223:		Line 223:
	! <samp>isLightning</samp>		! <samp>isLightning</samp>
	! <samp>isSnowing</samp>		! <samp>isSnowing</samp>
			! <samp>isGreenRain</samp>
	\|-		\|-
	\| sunny		\| sunny
			\| ☐
	\| ☐		\| ☐
	\| ☐		\| ☐
Line 232:		Line 234:
	\| rainy		\| rainy
	\| ☑		\| ☑
			\| ☐
	\| ☐		\| ☐
	\| ☐		\| ☐
Line 240:		Line 243:
	\| ☐		\| ☐
	\| ☑		\| ☑
			\| ☐
	\| ☐		\| ☐
	\|-		\|-
Line 245:		Line 249:
	\| ☐		\| ☐
	\| ☑		\| ☑
			\| ☐
	\| ☐		\| ☐
	\| ☐		\| ☐
Line 253:		Line 258:
	\| ☐		\| ☐
	\| ☑		\| ☑
			\| ☐
	\|-		\|-
	\| festival		\| festival
			\| ☐
	\| ☐		\| ☐
	\| ☐		\| ☐
Line 265:		Line 272:
	\| ☐		\| ☐
	\| ☐		\| ☐
			\| ☐
			\|-
			\| green rain
			\| ☐
			\| ☐
			\| ☐
			\| ☐
			\| ☑
	\|}		\|}

imported>VulpesLucida: /* Weather Icon */ update

2025-01-10T11:28:31Z

Weather Icon: update

← Older revision		Revision as of 11:28, 10 January 2025
Line 172:		Line 172:
	# If fall: 6.		# If fall: 6.
	# If winter: 7 (same as snowing).		# If winter: 7 (same as snowing).
			# If green rain: 999.

	===Rain Totem===		===Rain Totem===

imported>VulpesLucida: /* Generated weather */

2025-01-10T11:27:28Z

Generated weather

← Older revision		Revision as of 11:27, 10 January 2025
Line 91:		Line 91:
	The game follows these steps to decide which weather and debris to set for the next day:		The game follows these steps to decide which weather and debris to set for the next day:

			# Load the possible weather for the new day for each location, which is set just after the old day started.
	# Check for [[#Forced weather\|forced weather]].		# Check for [[#Forced weather\|forced weather]].
	# If today is a ~~festival~~, set the weather to <samp>~~weather_festival~~</samp>.		# If today is a wedding, set the weather to <samp>Wedding</samp>.
	# ~~If today is a wedding, set~~ the ~~weather to~~ <samp>~~weather_wedding~~</samp>.		# Sync the <samp>WeatherForTomorrow</samp> field for each location.
	# Set <samp>Game1::wasRainingYesterday</samp> based on whether it was raining or storming.		# Set <samp>Game1::wasRainingYesterday</samp> based on whether it was raining or storming.
			# Clear the debris weather array.
	# Reset all weather flags, and sets them in the following pattern		# Reset all weather flags, and sets them in the following pattern
	## If it is going to rain ~~or storm~~, set the rain flag to true		## If it is going to rain, set the rain flag to true (this does ''not'' include the green rain).
	## If it is ~~going to storm~~, set the ~~storm~~ flag to true		## If the weather is green rain, set the green rain flag to true.
	## If ~~the weather~~ is ~~(sunny~~, ~~debris) or (festival \|\| snowy \|\| wedding), clear all~~ the flags		## If it is going to storm, set the rain and storm flags to true.
	~~## and then if it's snowy, set snowy~~ to true		## If it is going to be windy, set the debris flag to true.
	## ~~It then sets the song based on this~~		## If it is going to snow, set the snow flag to true,
	~~## Clear the debris weather array and clear the flag~~		# Prepare for the possible weather the day after the new day:
	~~## if bloom isn't null, clear~~ it~~'s visibility~~		## Default to <samp>Sun</samp>;
	~~## If the wedding~~ is ~~debris~~, ~~populate~~ the debris ~~array~~.		## If the day after the new day is an active festival, set the weather to be <samp>Festival</samp> and return;
	# If it~~'s not raining~~, ~~and~~ the ~~chance~~ to ~~rain tomorrow is less than .1~~, ~~it will try to create a bloom day.~~		## If the day after the new day is a passive festival, set the weather to be <samp>Sun</samp> and return;
	# ~~It then calculates the rain chance~~ for ~~tomorrow. It follows~~ the ~~following algorithm~~		## Apply randomized [[Modding:Migrate to Stardew Valley 1.6#What's new for locations & weather#Custom location contexts\|weather conditions]] from location contexts to get a possible weather.
	~~## Check to see if it's summer.~~		# Prepare for the possible weather the day after the new day for those locations with [[Modding:Migrate to Stardew Valley 1.6#What's new for locations & weather#Custom location contexts\|<samp>CopyWeatherFromLocation</samp>]] specified (copy from source locations).
	~~### If not, check to see if it's winter.~~		# Sync the weather.
	~~#### If it's not,~~ the ~~rain chance is .183~~		# Apply all the weather flags to the valley area.
	~~#### Else, it's .63~~		# Populate the debris array if it is debris weather.
	~~## If it is, it uses~~ the ~~following~~: ~~Check if it's day 1.~~		# Reset (on the first day of a month) or increment the <samp>monthlyNonRainyDayCount</samp> for each location.
	##~~# If it's not, the chance is .12 +~~ <samp>~~Game1::dayOfMonth~~</samp> * 3/1000		# Apply the green rain response logic (''e.g.'', show global message, send a mail, etc.)
	### If ~~it is,~~ the ~~chance is 0. Which.. is kinda redundant, as~~ the ~~force days take care of this.~~
	~~# Check to see if a random number is less than the odds. If it~~ is, ~~it follows~~ the ~~following algorithm~~
	~~## Set <samp>Game1::weatherForTomorrow</samp>~~ to <samp>~~weather_rain~~</samp>
	~~## If:~~
	~~### It's summer,~~ and ~~if a random number is less than .85~~
	##~~# Or~~ If ~~it's not winter, and if a random number is less than .25 AND~~ the day of the ~~month~~ is ~~more than 2 and more than 27 days have been played~~
	~~### Set <samp>Game1::weatherForTomorrow</samp>~~ to <samp>~~weather_lightning~~</samp>
	## ~~If it is winter~~
	~~### Set <samp>Game1:~~:~~weatherForTomorrow</samp>~~ to ~~<samp>weather_snow</samp>~~
	# ~~Else, if it~~'s ~~over the rain odds.~~
	#~~# If you've played less than 3 days~~.
	#~~# Or~~: if
	~~### It's not spring or a random number is greater than or equal~~ to .~~2 (so 80%) and spring.~~
	#~~## And it~~'s ~~not fall or a random number is greater than or equal to .6 (so 40%) and fall.~~
	#~~## Or: If there is a wedding today~~
	~~#### Set~~ <samp>~~Game1::weatherForTomorrow~~</samp> ~~to <samp>weather_sunny</samp> if true~~
	##~~## Set <samp>Game1::weatherForTomorrow</samp>~~ to ~~<samp>weather_debris</samp> if false~~
	#~~# Check~~ if ~~tomorrow~~ is ~~a festival, and set~~ weather ~~to <samp>weather_festival</samp> if true~~.
	#~~# Again force~~ the ~~3rd~~ day ~~to be~~ <samp>~~weather_rain~~</samp>

	At this point, the main function is done setting weather.		At this point, the main function is done setting weather.

imported>VulpesLucida: /* Forced weather */ update

2025-01-10T09:50:09Z

Forced weather: update

← Older revision		Revision as of 09:50, 10 January 2025
Line 53:		Line 53:
	! date		! date
	! weather		! weather
	~~! overridden by~~
	\|-		\|-
	\| spring 1		\| spring 1
	\| <samp>weather_sunny</samp>		\| <samp>weather_sunny</samp>
	~~\| <samp>newday</samp> and <samp>tv</samp>~~
	\|-		\|-
	\| spring 2 (year 1)		\| spring 2 (year 1)
	\| <samp>weather_sunny</samp>		\| <samp>weather_sunny</samp>
	~~\| <samp>newday</samp>~~
	\|-		\|-
	\| spring 3 (year 1)		\| spring 3 (year 1)
	\| <samp>weather_rain</samp>		\| <samp>weather_rain</samp>
	~~\| <samp>newday</samp>~~
	\|-		\|-
	\| spring 4 (year 1)		\| spring 4 (year 1)
	\| <samp>weather_sunny</samp>		\| <samp>weather_sunny</samp>
	~~\| <samp>newday</samp>~~
	\|-
	~~\| spring 13~~
	~~\| <samp>weather_festival</samp>~~
	~~\| <samp>newday</samp>~~
	\|-
	~~\| spring 24~~
	~~\| <samp>weather_festival</samp>~~
	~~\| <samp>newday</samp>~~
	\|-		\|-
	\| summer 1		\| summer 1
	\| <samp>weather_sunny</samp>		\| <samp>weather_sunny</samp>
	~~\| <samp>newday</samp> and <samp>tv</samp>~~
	\|-
	~~\| summer 11~~
	~~\| <samp>weather_festival</samp>~~
	~~\| <samp>newday</samp>~~
	\|-		\|-
	\| summer 13		\| summer 13
	\| <samp>weather_lightning</samp>		\| <samp>weather_lightning</samp>
	~~\| <samp>newday</samp>~~
	\|-		\|-
	\| summer 26		\| summer 26
	\| <samp>weather_lightning</samp>		\| <samp>weather_lightning</samp>
	~~\| <samp>newday</samp>~~
	\|-
	~~\| summer 28~~
	~~\| <samp>weather_festival</samp>~~
	~~\| <samp>newday</samp>~~
	\|-		\|-
	\| fall 1		\| fall 1
	\| <samp>weather_sunny</samp>		\| <samp>weather_sunny</samp>
	~~\| <samp>newday</samp> and <samp>tv</samp>~~
	\|-
	~~\| fall 16~~
	~~\| <samp>weather_festival</samp>~~
	~~\| <samp>newday</samp>~~
	\|-
	~~\| fall 27~~
	~~\| <samp>weather_festival</samp>~~
	~~\| <samp>newday</samp>~~
	\|-		\|-
	\| winter 1		\| winter 1
	\| <samp>weather_sunny</samp>		\| <samp>weather_sunny</samp>
	~~\| <samp>newday</samp> and <samp>tv</samp>~~
	\|-
	~~\| winter 8~~
	~~\| <samp>weather_festival</samp>~~
	~~\| <samp>newday</samp>~~
	\|-
	~~\| winter 14~~
	~~\| <samp>weather_sunny</samp>~~
	~~\| <samp>newday</samp>~~
	\|-
	~~\| winter 15~~
	~~\| <samp>weather_sunny</samp>~~
	~~\| <samp>newday</samp>~~
	\|-
	~~\| winter 16~~
	~~\| <samp>weather_sunny</samp>~~
	~~\| <samp>newday</samp>~~
	\|-
	~~\| winter 25~~
	~~\| <samp>weather_festival</samp>~~
	~~\| <samp>newday</samp>~~
	\|}		\|}

			Green rain can only occur on Summer 5, 6, 7, 14, 16, 18 and 23.

			Active festivals (defined in <samp>Data/Festivals</samp>) always have the <samp>Festival</samp> weather while passive festivals (defined in <samp>Data/PassiveFestivals</samp>) always have the <samp>Sun</samp> weather.

	===Generated weather===		===Generated weather===

imported>VulpesLucida: /* TV Channel */

2025-01-10T09:19:21Z

TV Channel

← Older revision		Revision as of 09:19, 10 January 2025
Line 192:		Line 192:
	! message		! message
	\|-		\|-
	\| sunny ~~or wedding~~		\| <samp>Festival</samp>
			\| "It's going to be clear and sunny tomorrow... perfect weather for the Festival! The event will take place Location, starting between Time. Don't be late!"
			Failed to fetch the data: "Um... that's odd. My information sheet just says 'null'. This is embarrassing... "
			\|-
			\| <samp>Snow</samp>
	\| 50% chance each:		\| 50% chance each:
	* "It's going to ~~be clear and sunny all day.~~"		* "Bundle up, folks. It's going to snow tomorrow!"
	* "~~It's going to be~~ a ~~beautiful, sunny day tommorow!~~"		* "Expect a few inches of snow tomorrow."
	\|-		\|-
	\| ~~rain~~		\| <samp>Rain</samp>
	\| "It's going to rain all day tomorrow"		\| "It's going to rain all day tomorrow"
	\|-		\|-
	\| ~~debris~~		\| <samp>GreenRain</samp>
	\| ~~Per conditions:~~		\| "Um... There appears to be some kind of... anomalous reading... I... don't know what this means..."
	~~# If spring:~~ "~~Partially cloudy with a light breeze~~. ~~Expect lots of pollen!"~~
	~~# If not fall: "It's going to snow all day~~. ~~Make sure you bundle up, folks!" and defaults with: "It's going~~ to be ~~cloudy, with gusts~~ of ~~wind throughout the day~~."
	~~# If storm: "Looks like a storm is approaching~~. ~~Thunder and lightning is expected~~."
	~~# If festival, it attempts to read the festival data~~. ~~If it fails, it will say "Um~~... ~~that's odd~~. ~~My information sheet just says 'null~~'. ~~This is embarrassing..." If it succeeds, it will read out where it is and when it is~~.
	~~# If snow, a 50% chance of one of two strings: "Expect a few inches of snow tomorrow" or "Bundle up, folks~~. ~~It's going to snow tomorrow!~~"
	\|-		\|-
	\| ~~green rain~~		\| <samp>Storm</samp>
	\| "Um... ~~There appears~~ to be ~~some kind~~ of.~~.. anomalous reading... I... don~~'~~t know what this means..~~."		\| "Looks like a storm is approaching. Thunder and lightning is expected."
			\|-
			\| <samp>Wind</samp>
			\| Per condition:
			* Spring: "Partially cloudy with a light breeze. Expect lots of pollen!"
			* Fall: "It's going to be cloudy, with gusts of wind throughout the day."
			* Default: "It's going to snow all day. Make sure you bundle up, folks!"
	\|-		\|-
	\| ''~~any other~~''		\| ''default''
	\| ~~Fall back~~ to sunny.		\| 50% chance each:
			* "It's going to be clear and sunny all day."
			* "It's going to be a beautiful, sunny day tommorow!"
	\|}		\|}

imported>VulpesLucida: /* TV Channel */ update

2025-01-10T09:03:16Z

TV Channel: update

@@ Line 185: / Line 185: @@
 ===TV Channel===
 The TV will check the weather and show the following message:
@@ Line 234: / Line 207: @@
 # If festival, it attempts to read the festival data. If it fails, it will say "Um... that's odd. My information sheet just says 'null'. This is embarrassing..." If it succeeds, it will read out where it is and when it is.
 # If snow, a 50% chance of one of two strings: "Expect a few inches of snow tomorrow" or "Bundle up, folks. It's going to snow tomorrow!"
 |-
 | ''any other''
-| Returns an empty string (should never happen).
+| Fall back to sunny.
 |}
 '''Note:''' the TV will not necessarily be accurate for any other day than non festival days, the first of the month and the 3rd of spring, which are force-set by the <samp>Game1::newDayAfterFade</samp> method. Farmhands (and not host players) may not even get that accuracy for the first of the month and 3rd of spring.
-'''Note 2:''' The Night Market is not considered a festival for the purposes of weather.
+'''Note 2:''' Passive festivals such as the Night Market are not considered to have "festival" weather. Instead, all passive festivals in the valley have "sunny" weather.
 ===Weather Icon===

imported>VulpesLucida: /* Data */ update

2025-01-10T05:03:44Z

Data: update

← Older revision		Revision as of 05:03, 10 January 2025
Line 4:		Line 4:

	==Data==		==Data==
	The weather is controlled by the ~~integer~~ field <samp>Game1::weatherForTomorrow</samp>. The possible values are:		The weather is controlled by the string field <samp>Game1::weatherForTomorrow</samp>. The possible values are:

	{\| class="wikitable"		{\| class="wikitable"
Line 12:		Line 12:
	! weather		! weather
	\|-		\|-
	\| 0		\| <samp>Sun</samp>
	\| <samp>weather_sunny</samp>		\| <samp>weather_sunny</samp>
	\| sunny		\| sunny
	\|-		\|-
	\| 1		\| <samp>Rain</samp>
	\| <samp>weather_rain</samp>		\| <samp>weather_rain</samp>
	\| rain		\| rain
	\|-		\|-
	\| 2		\| <samp>GreenRain</samp>
			\| <samp>weather_green_rain</samp>
			\| green rain
			\|-
			\| <samp>Wind</samp>
	\| <samp>weather_debris</samp>		\| <samp>weather_debris</samp>
	\| windy		\| windy
	\|-		\|-
	\| 3		\| <samp>Storm</samp>
	\| <samp>weather_lightning</samp>		\| <samp>weather_lightning</samp>
	\| lightning		\| lightning
	\|-		\|-
	\| 4		\| <samp>Festival</samp>
	\| <samp>weather_festival</samp>		\| <samp>weather_festival</samp>
	\| festival		\| festival
	\|-		\|-
	\| 5		\| <samp>Snow</samp>
	\| <samp>weather_snow</samp>		\| <samp>weather_snow</samp>
	\| snow		\| snow
	\|-		\|-
	\| 6		\| <samp>Wedding</samp>
	\| <samp>weather_wedding</samp>		\| <samp>weather_wedding</samp>
	\| wedding		\| wedding

imported>Minosprimefromultrakill: Fixed a misspelling of "throughout" in the TV messages section.

2024-10-17T21:39:01Z

Fixed a misspelling of "throughout" in the TV messages section.

← Older revision		Revision as of 21:39, 17 October 2024
Line 226:		Line 226:
	\| Per conditions:		\| Per conditions:
	# If spring: "Partially cloudy with a light breeze. Expect lots of pollen!"		# If spring: "Partially cloudy with a light breeze. Expect lots of pollen!"
	# If not fall: "It's going to snow all day. Make sure you bundle up, folks!" and defaults with: "It's going to be cloudy, with gusts of wind ~~throught~~ the day."		# If not fall: "It's going to snow all day. Make sure you bundle up, folks!" and defaults with: "It's going to be cloudy, with gusts of wind throughout the day."
	# If storm: "Looks like a storm is approaching. Thunder and lightning is expected."		# If storm: "Looks like a storm is approaching. Thunder and lightning is expected."
	# If festival, it attempts to read the festival data. If it fails, it will say "Um... that's odd. My information sheet just says 'null'. This is embarrassing..." If it succeeds, it will read out where it is and when it is.		# If festival, it attempts to read the festival data. If it fails, it will say "Um... that's odd. My information sheet just says 'null'. This is embarrassing..." If it succeeds, it will read out where it is and when it is.