Modding:Schedule data - Revision history

imported>Esca: /* Schedule points */ Fix argument order, based on the examples and vanilla data

2025-11-18T07:34:25Z

Schedule points: Fix argument order, based on the examples and vanilla data

← Older revision		Revision as of 07:34, 18 November 2025
Line 193:		Line 193:
	\|-		\|-
	\| <samp>animation</samp>		\| <samp>animation</samp>
	\| ''(optional)'' The animation to play when the NPC reaches the destination. This must be a key that appears in the <samp>Content/Data/animationDescriptions.xnb</samp> file. Each key entry has three required parts: entry frames/repeat frames/leaving frames. The numbers on them refer to the [[Modding:NPC data#Overworld sprites\|overworld sprite frame]]. The entry frames will play after arriving at the schedule point. Then the repeat frames will loop until the end of schedule time. Finally, the leaving frames will play before moving on to the next schedule point. Note that each frame is around 120ms so duplicates of frame is used to get desired looking animation. <br /><br /> The full format is <samp>entry frames/repeat frames/leaving frames/message key/offset X Y~~/laying_down~~</samp>. If a message key is given, the NPC will repeat that message if you talk to them while they are performing the animation. <samp>offset X Y</samp> lets you offset their sprite (in pixels). <samp>laying_down</samp> will hide the shadow. If you want to use offset or laying_down without a message, leave that spot empty. The order of <samp>offset</samp> and <samp>laying_down</samp> do not matter and either can be used without the other.<br />Example offset/laying down without message: <samp>"haley_beach_towel": "20 20 21 21 21 21 21/22/21 21 20//laying_down/offset 0 16"</samp><br />Example offset without message or laying_down: <samp>"haley_beach_towel": "20 20 21 21 21 21 21/22/21 21 20//offset 0 16"</samp> (note there are now only 5 fields, not 6). <br /><br />Additionally, there are a few special animations. <samp>sleep</samp> anywhere in an animation name causes the NPC to go to sleep (which, among other things, prevents players from gifting or talking to the NPC while the animation is active.) The specific animation <samp>NPCName_sleep</samp> (with the NPCName fully lowercased) automatically used by spouses when they turn in for the night, and by NPCs coming home from Ginger Island. <samp>square_X_Y_facing</samp> causes NPCs to make random movements in a rectangle of at most X by Y (it can be less), centered at the schedule point. They will occasionally pause and face the <samp>facing</samp> direction. <samp>change_beach</samp> and <samp>change_normal</samp> cause NPCs to change into and out of their beach outfits, and is used by Ginger Island resort schedules.		\| ''(optional)'' The animation to play when the NPC reaches the destination. This must be a key that appears in the <samp>Content/Data/animationDescriptions.xnb</samp> file. Each key entry has three required parts: entry frames/repeat frames/leaving frames. The numbers on them refer to the [[Modding:NPC data#Overworld sprites\|overworld sprite frame]]. The entry frames will play after arriving at the schedule point. Then the repeat frames will loop until the end of schedule time. Finally, the leaving frames will play before moving on to the next schedule point. Note that each frame is around 120ms so duplicates of frame is used to get desired looking animation. <br /><br /> The full format is <samp>entry frames/repeat frames/leaving frames/message key/laying_down/offset X Y</samp>. If a message key is given, the NPC will repeat that message if you talk to them while they are performing the animation. <samp>offset X Y</samp> lets you offset their sprite (in pixels). <samp>laying_down</samp> will hide the shadow. If you want to use offset or laying_down without a message, leave that spot empty. The order of <samp>offset</samp> and <samp>laying_down</samp> do not matter and either can be used without the other.<br />Example offset/laying down without message: <samp>"haley_beach_towel": "20 20 21 21 21 21 21/22/21 21 20//laying_down/offset 0 16"</samp><br />Example offset without message or laying_down: <samp>"haley_beach_towel": "20 20 21 21 21 21 21/22/21 21 20//offset 0 16"</samp> (note there are now only 5 fields, not 6). <br /><br />Additionally, there are a few special animations. <samp>sleep</samp> anywhere in an animation name causes the NPC to go to sleep (which, among other things, prevents players from gifting or talking to the NPC while the animation is active.) The specific animation <samp>NPCName_sleep</samp> (with the NPCName fully lowercased) automatically used by spouses when they turn in for the night, and by NPCs coming home from Ginger Island. <samp>square_X_Y_facing</samp> causes NPCs to make random movements in a rectangle of at most X by Y (it can be less), centered at the schedule point. They will occasionally pause and face the <samp>facing</samp> direction. <samp>change_beach</samp> and <samp>change_normal</samp> cause NPCs to change into and out of their beach outfits, and is used by Ginger Island resort schedules.
	\|-		\|-
	\| <samp>dialogue</samp>		\| <samp>dialogue</samp>

imported>Pathoschild: /* Potential issues */ rename to 'Limitations', + common limitation: NPCs added to existing save may not follow schedule on first day

2025-07-17T14:33:16Z

Potential issues: rename to 'Limitations', + common limitation: NPCs added to existing save may not follow schedule on first day

← Older revision		Revision as of 14:33, 17 July 2025
Line 204:		Line 204:
	At 13:00 (1pm), Abigail will begin walking to tile (47, 87) in the Town location. When she reaches it, she'll face direction 0 (up) and say "''Hey, @. I like to relax here... it's so peaceful.''"		At 13:00 (1pm), Abigail will begin walking to tile (47, 87) in the Town location. When she reaches it, she'll face direction 0 (up) and say "''Hey, @. I like to relax here... it's so peaceful.''"

	==~~Potential issues~~==		==Limitations==
			* When an NPC is added to an existing save, they generally don't follow their schedule correctly until you've slept once in-game (which triggers their first day update).<!-- This is duplicated on [[Modding:NPC data]], update both places if needed. -->
	* Using a time of 600 (when the day starts) for an event may not work. Try using 610 if you want an event early in the morning and the NPC doesn't move if you use 600.		* Using a time of 600 (when the day starts) for an event may not work. Try using 610 if you want an event early in the morning and the NPC doesn't move if you use 600.

imported>Strawhatwem: Added the missing necessary backslashes to the Schedule string portion of the Abigail schedule example

2025-07-13T18:39:34Z

Added the missing necessary backslashes to the Schedule string portion of the Abigail schedule example

← Older revision		Revision as of 18:39, 13 July 2025
Line 200:		Line 200:

	For example, consider this schedule entry in Abigail's schedule:		For example, consider this schedule entry in Abigail's schedule:
	<pre>1300 Town 47 87 0 "Strings\\schedules\\Abigail:marriage_Mon.001"</pre>		<pre>1300 Town 47 87 0 \"Strings\\schedules\\Abigail:marriage_Mon.001\"</pre>

	At 13:00 (1pm), Abigail will begin walking to tile (47, 87) in the Town location. When she reaches it, she'll face direction 0 (up) and say "''Hey, @. I like to relax here... it's so peaceful.''"		At 13:00 (1pm), Abigail will begin walking to tile (47, 87) in the Town location. When she reaches it, she'll face direction 0 (up) and say "''Hey, @. I like to relax here... it's so peaceful.''"

imported>Abagaianye: Explain that animation fields offset and laying_down have interchangeable order and can be used individually. Also removed note about lower friendship from schedule animation message as it has been confirmed the friendship gain is not lower.

2025-06-08T04:51:26Z

Explain that animation fields offset and laying_down have interchangeable order and can be used individually. Also removed note about lower friendship from schedule animation message as it has been confirmed the friendship gain is not lower.

← Older revision		Revision as of 04:51, 8 June 2025
Line 193:		Line 193:
	\|-		\|-
	\| <samp>animation</samp>		\| <samp>animation</samp>
	\| ''(optional)'' The animation to play when the NPC reaches the destination. This must be a key that appears in the <samp>Content/Data/animationDescriptions.xnb</samp> file. Each key entry has three required parts: entry frames/repeat frames/leaving frames. The numbers on them refer to the [[Modding:NPC data#Overworld sprites\|overworld sprite frame]]. The entry frames will play after arriving at the schedule point. Then the repeat frames will loop until the end of schedule time. Finally, the leaving frames will play before moving on to the next schedule point. Note that each frame is around 120ms so duplicates of frame is used to get desired looking animation. <br /><br /> The full format is <samp>entry frames/repeat frames/leaving frames/message key/offset X Y/laying_down</samp>. If a message key is given, the NPC will repeat that message if you talk to them while they are performing the animation. ~~(TODO: this is likely a "busy chat", which has fewer heart points, crosscheck.)~~ <samp>offset X Y</samp> lets you offset their sprite (in pixels). <samp>laying_down</samp> will hide the shadow. If you want to use offset or laying_down without a message, leave that spot empty. Example: offset/laying down without message: <samp>"haley_beach_towel": "20 20 21 21 21 21 21/22/21 21 20//laying_down/offset 0 16"</samp><br /><br />Additionally, there are a few special animations. <samp>sleep</samp> anywhere in an animation name causes the NPC to go to sleep (which, among other things, prevents players from gifting or talking to the NPC while the animation is active.) The specific animation <samp>NPCName_sleep</samp> (with the NPCName fully lowercased) automatically used by spouses when they turn in for the night, and by NPCs coming home from Ginger Island. <samp>square_X_Y_facing</samp> causes NPCs to make random movements in a rectangle of at most X by Y (it can be less), centered at the schedule point. They will occasionally pause and face the <samp>facing</samp> direction. <samp>change_beach</samp> and <samp>change_normal</samp> cause NPCs to change into and out of their beach outfits, and is used by Ginger Island resort schedules.		\| ''(optional)'' The animation to play when the NPC reaches the destination. This must be a key that appears in the <samp>Content/Data/animationDescriptions.xnb</samp> file. Each key entry has three required parts: entry frames/repeat frames/leaving frames. The numbers on them refer to the [[Modding:NPC data#Overworld sprites\|overworld sprite frame]]. The entry frames will play after arriving at the schedule point. Then the repeat frames will loop until the end of schedule time. Finally, the leaving frames will play before moving on to the next schedule point. Note that each frame is around 120ms so duplicates of frame is used to get desired looking animation. <br /><br /> The full format is <samp>entry frames/repeat frames/leaving frames/message key/offset X Y/laying_down</samp>. If a message key is given, the NPC will repeat that message if you talk to them while they are performing the animation. <samp>offset X Y</samp> lets you offset their sprite (in pixels). <samp>laying_down</samp> will hide the shadow. If you want to use offset or laying_down without a message, leave that spot empty. The order of <samp>offset</samp> and <samp>laying_down</samp> do not matter and either can be used without the other.<br />Example offset/laying down without message: <samp>"haley_beach_towel": "20 20 21 21 21 21 21/22/21 21 20//laying_down/offset 0 16"</samp><br />Example offset without message or laying_down: <samp>"haley_beach_towel": "20 20 21 21 21 21 21/22/21 21 20//offset 0 16"</samp> (note there are now only 5 fields, not 6). <br /><br />Additionally, there are a few special animations. <samp>sleep</samp> anywhere in an animation name causes the NPC to go to sleep (which, among other things, prevents players from gifting or talking to the NPC while the animation is active.) The specific animation <samp>NPCName_sleep</samp> (with the NPCName fully lowercased) automatically used by spouses when they turn in for the night, and by NPCs coming home from Ginger Island. <samp>square_X_Y_facing</samp> causes NPCs to make random movements in a rectangle of at most X by Y (it can be less), centered at the schedule point. They will occasionally pause and face the <samp>facing</samp> direction. <samp>change_beach</samp> and <samp>change_normal</samp> cause NPCs to change into and out of their beach outfits, and is used by Ginger Island resort schedules.
	\|-		\|-
	\| <samp>dialogue</samp>		\| <samp>dialogue</samp>

imported>VulpesLucida: Fix zh link

2024-12-04T00:20:33Z

Fix zh link

← Older revision		Revision as of 00:20, 4 December 2024
Line 211:		Line 211:
	[[es:Modding:Datos de horarios]]		[[es:Modding:Datos de horarios]]
	[[ru:Модификации:Расписание]]		[[ru:Модификации:Расписание]]
	[[zh:模组:~~日程数据~~]]		[[zh:模组:行程数据]]

imported>VulpesLucida: zh link

2024-12-04T00:19:13Z

zh link

← Older revision		Revision as of 00:19, 4 December 2024
Line 211:		Line 211:
	[[es:Modding:Datos de horarios]]		[[es:Modding:Datos de horarios]]
	[[ru:Модификации:Расписание]]		[[ru:Модификации:Расписание]]
			[[zh:模组:日程数据]]

imported>Abagaianye: Fixed formatting from last edit

2024-11-06T17:03:48Z

Fixed formatting from last edit

← Older revision		Revision as of 17:03, 6 November 2024
Line 65:		Line 65:
	\|-		\|-
	\| <samp>marriageJob</samp>		\| <samp>marriageJob</samp>
	\| Used by Harvey on Tuesday/Thursday, Maru on Tuesday/Thursday, Penny on Tuesday/Wednesday/Friday. No other NPC can use marriageJob without C# to change the game code.		\| Used by Harvey on Tuesday/Thursday, Maru on Tuesday/Thursday, Penny on Tuesday/Wednesday/Friday. No other NPC can use <samp>marriageJob</samp> without C# to change the game code.
	\|-		\|-
	\| <samp>marriage_{{t\|day of week}}</samp>		\| <samp>marriage_{{t\|day of week}}</samp>

imported>Abagaianye: Clarified that marriageJob is restricted to just the 3 vanilla NPCs

2024-11-06T17:02:28Z

Clarified that marriageJob is restricted to just the 3 vanilla NPCs

← Older revision		Revision as of 17:02, 6 November 2024
Line 65:		Line 65:
	\|-		\|-
	\| <samp>marriageJob</samp>		\| <samp>marriageJob</samp>
	\| Used by Harvey on Tuesday/Thursday, Maru on Tuesday/Thursday, Penny on Tuesday/Wednesday/Friday.		\| Used by Harvey on Tuesday/Thursday, Maru on Tuesday/Thursday, Penny on Tuesday/Wednesday/Friday. No other NPC can use marriageJob without C# to change the game code.
	\|-		\|-
	\| <samp>marriage_{{t\|day of week}}</samp>		\| <samp>marriage_{{t\|day of week}}</samp>

imported>Pathoschild: /* Schedule script */ + multi-line format in 1.6

2024-09-13T23:01:12Z

Schedule script: + multi-line format in 1.6

@@ Line 126: / Line 126: @@
 ==Schedule script==
-Each schedule entry value has an arbitrary number of slash-delimited schedule commands matching one of the formats below.
+===Format===
 ===Initial commands===

imported>Pathoschild: /* Schedule key */ update for Stardew Valley 1.6

2024-09-13T22:56:23Z

Schedule key: update for Stardew Valley 1.6

← Older revision		Revision as of 22:56, 13 September 2024
Line 35:		Line 35:

	Notes:		Notes:
	* ~~Most text is~~ case-sensitive ~~(''e.g.,'' <samp>Mon</samp> is not the same as <samp>mon</samp>)~~.		* Schedule keys are not case-sensitive.
	* The game's logic for schedule keys is in <samp>NPC::~~getSchedule~~</samp>.		* The game's logic for schedule keys is in <samp>NPC::TryLoadSchedule()</samp>.

			===Special schedules===
			These are checked first, regardless of marriage status.

			{\| class="wikitable"
			\|-
			! syntax
			! summary
			\|-
			\| <samp>GreenRain</samp>
			\| Applies on [[Weather#Green Rain\|green rain]] days in year 1.
			\|}

	===Marriage schedules===		===Marriage schedules===
Line 45:		Line 57:
	! syntax		! syntax
	! summary		! summary
			\|-
			\| <samp>marriage_{{t\|festival ID}}_{{t\|festival day}}</samp><br /><samp>marriage_{{t\|festival ID}}</samp>
			\| Applies when a passive festival like the [[Night Market]] is active. The {{t\|festival ID}} is the key from <samp>Data/PassiveFestivals</samp>, and {{t\|festival day}} is the number of days since the passive festival started (where the first day is 1).
	\|-		\|-
	\| <samp>marriage_{{t\|season}}_{{t\|day of month}}</samp>		\| <samp>marriage_{{t\|season}}_{{t\|day of month}}</samp>
Line 63:		Line 78:
	! syntax		! syntax
	! summary		! summary
			\|-
			\| <samp>{{t\|festival ID}}_{{t\|festival day}}</samp><br /><samp>{{t\|festival ID}}</samp>
			\| Applies when a passive festival like the [[Night Market]] is active. The {{t\|festival ID}} is the key from <samp>Data/PassiveFestivals</samp>, and {{t\|festival day}} is the number of days since the passive festival started (where the first day is 1).
	\|-		\|-
	\| <samp>{{t\|season}}_{{t\|day of month}}</samp>		\| <samp>{{t\|season}}_{{t\|day of month}}</samp>
Line 87:		Line 105:
	\| <samp>{{t\|season}}_{{t\|day of week}}</samp>		\| <samp>{{t\|season}}_{{t\|day of week}}</samp>
	\| Applies in the given season and day of week.<br /><small>Example: <samp>spring_Mon</samp></small>		\| Applies in the given season and day of week.<br /><small>Example: <samp>spring_Mon</samp></small>
			\|-
			\| <samp>{{t\|day of week}}_{{t\|hearts}}</samp>
			\| Applies on the given day of week, if ''any'' player has at least that many [[friendship\|hearts]] with the NPC. If multiple schedules apply, the one with the highest heart number is used.<br /><small>Example: <samp>Mon_6</samp></small>
	\|-		\|-
	\| <samp>{{t\|day of week}}</samp>		\| <samp>{{t\|day of week}}</samp>
Line 98:		Line 119:
	\|-		\|-
	\| <samp>spring</samp>		\| <samp>spring</samp>
	\| Always applies. This schedule is also used as a default in some cases. DO NOT REMOVE THIS ENTRY. THAT WILL BREAK THE GAME.		\| Always applies. This schedule is also used as a default in some cases.<br />DO NOT REMOVE THIS ENTRY. THAT WILL BREAK THE GAME.
	\|-		\|-
	\| <samp>default</samp>		\| <samp>default</samp>