Modding:Game state queries - Revision history

imported>Esca: /* World */ Clarify IS_GREEN_RAIN_DAY behavior

2026-08-11T02:07:41Z

World: Clarify IS_GREEN_RAIN_DAY behavior

← Older revision		Revision as of 02:07, 11 August 2026
Line 176:		Line 176:
	\|-		\|-
	\| <samp>IS_GREEN_RAIN_DAY</samp>		\| <samp>IS_GREEN_RAIN_DAY</samp>
	\| Whether the RNG has determined ~~today~~ to be the Green Rain day for the year.		\| Whether the RNG has determined '''tomorrow''' to be the Green Rain day for the year. Mods should generally use <code>WEATHER Farm GreenRain</code> instead.
	\|-		\|-
	\| <samp>IS_HOST</samp>		\| <samp>IS_HOST</samp>

imported>Bezajel: /* World */ Corrected IS_JOJA_MART_COMPLETE to refer to completion of the Joja bundles, rather than the Joja Warehouse, which occurs earlier.

2026-06-13T02:12:45Z

World: Corrected IS_JOJA_MART_COMPLETE to refer to completion of the Joja bundles, rather than the Joja Warehouse, which occurs earlier.

← Older revision		Revision as of 02:12, 13 June 2026
Line 185:		Line 185:
	\|-		\|-
	\| <samp>IS_JOJA_MART_COMPLETE</samp>		\| <samp>IS_JOJA_MART_COMPLETE</samp>
	\| Whether the [[Joja ~~Warehouse~~\|Joja ~~warehouse~~]] has been ~~built~~.		\| Whether the [[Joja Community Development Form\|Joja community development form]] has been completed.
	\|-		\|-
	\| <samp>IS_MULTIPLAYER</samp>		\| <samp>IS_MULTIPLAYER</samp>

imported>EnderTedi: /* Randomization */ Remove non-existent args from SYNCED_SUMMER_RAIN_RANDOM and remove mention of the non-existent SYNCED_DAY_RANDOM GSQ from it's description.

2026-03-15T22:23:13Z

Randomization: Remove non-existent args from SYNCED_SUMMER_RAIN_RANDOM and remove mention of the non-existent SYNCED_DAY_RANDOM GSQ from it's description.

← Older revision		Revision as of 22:23, 15 March 2026
Line 522:		Line 522:
	If the exact text <samp>@addDailyLuck</samp> is specified, the current player's daily [[luck]] is added to the probability.		If the exact text <samp>@addDailyLuck</samp> is specified, the current player's daily [[luck]] is added to the probability.
	\|-		\|-
	\| <samp>SYNCED_SUMMER_RAIN_RANDOM ~~{{t\|base chance}} {{t\|day multiplier}}~~</samp>		\| <samp>SYNCED_SUMMER_RAIN_RANDOM</samp>
	\| A ~~specialized variant of <samp>SYNCED_DAY_RANDOM</samp>~~ used to calculate the chance of rain in summer, which increases with the day number.		\| A random probability check used to calculate the chance of rain in summer, which increases with the day number.
	\|}		\|}

imported>Sunbeam135: /* Extensibility */

2026-01-02T07:48:56Z

Extensibility

← Older revision		Revision as of 07:48, 2 January 2026
Line 680:		Line 680:
	[[Category:Modding]]		[[Category:Modding]]

	[[ru:Запросы состояния игры]]		[[ru:Модификации:Запросы состояния игры]]
	[[zh:模组:游戏状态查询]]		[[zh:模组:游戏状态查询]]

imported>Sunbeam135: /* Extensibility */

2026-01-02T07:17:17Z

Extensibility

← Older revision		Revision as of 07:17, 2 January 2026
Line 680:		Line 680:
	[[Category:Modding]]		[[Category:Modding]]

			[[ru:Запросы состояния игры]]
	[[zh:模组:游戏状态查询]]		[[zh:模组:游戏状态查询]]

imported>Margotbean: remove underscores

2025-12-01T20:09:54Z

remove underscores

← Older revision		Revision as of 20:09, 1 December 2025
Line 197:		Line 197:
	\|-		\|-
	\| <samp>LOCATION_CONTEXT {{t\|location}} {{t\|context ID}}+</samp>		\| <samp>LOCATION_CONTEXT {{t\|location}} {{t\|context ID}}+</samp>
	\| Whether the [[#Target location\|given location]] is part of the given [[Modding:~~Location_contexts~~\|location context]].		\| Whether the [[#Target location\|given location]] is part of the given [[Modding:Location contexts\|location context]].
	\|-		\|-
	\| <samp>LOCATION_HAS_CUSTOM_FIELD {{t\|location}} {{t\|key}} {{o\|value}}</samp>		\| <samp>LOCATION_HAS_CUSTOM_FIELD {{t\|location}} {{t\|key}} {{o\|value}}</samp>
Line 372:		Line 372:
	\|-		\|-
	\| <samp>PLAYER_LOCATION_CONTEXT {{t\|player}} {{t\|location context ID}}</samp>		\| <samp>PLAYER_LOCATION_CONTEXT {{t\|player}} {{t\|location context ID}}</samp>
	\| Whether the [[#Target player\|specified player(s)]] are in the given [[Modding:~~Location_contexts~~\|location context]].		\| Whether the [[#Target player\|specified player(s)]] are in the given [[Modding:Location contexts\|location context]].
	\|-		\|-
	\| <samp>PLAYER_LOCATION_NAME {{t\|player}} {{t\|location name}}+</samp><br /><samp>PLAYER_LOCATION_UNIQUE_NAME {{t\|player}} {{t\|location name}}+</samp>		\| <samp>PLAYER_LOCATION_NAME {{t\|player}} {{t\|location name}}+</samp><br /><samp>PLAYER_LOCATION_UNIQUE_NAME {{t\|player}} {{t\|location name}}+</samp>

imported>Esca: Add/fix location context links, clarify query usage

2025-11-30T01:12:36Z

Add/fix location context links, clarify query usage

← Older revision		Revision as of 01:12, 30 November 2025
Line 197:		Line 197:
	\|-		\|-
	\| <samp>LOCATION_CONTEXT {{t\|location}} {{t\|context ID}}+</samp>		\| <samp>LOCATION_CONTEXT {{t\|location}} {{t\|context ID}}+</samp>
	\| ~~The location context ID for~~ the [[#Target location\|given location]].		\| Whether the [[#Target location\|given location]] is part of the given [[Modding:Location_contexts\|location context]].
	\|-		\|-
	\| <samp>LOCATION_HAS_CUSTOM_FIELD {{t\|location}} {{t\|key}} {{o\|value}}</samp>		\| <samp>LOCATION_HAS_CUSTOM_FIELD {{t\|location}} {{t\|key}} {{o\|value}}</samp>
Line 371:		Line 371:
	\| Whether the [[#Target player\|specified player(s)]] have one of the listed [[trinkets]] equipped. Each ID can be a qualified or unqualified item ID.		\| Whether the [[#Target player\|specified player(s)]] have one of the listed [[trinkets]] equipped. Each ID can be a qualified or unqualified item ID.
	\|-		\|-
	\| <samp>PLAYER_LOCATION_CONTEXT {{t\|player}} {{t\|location context}}</samp>		\| <samp>PLAYER_LOCATION_CONTEXT {{t\|player}} {{t\|location context ID}}</samp>
	\| Whether the [[#Target player\|specified player(s)]] are in the given [[Modding:~~Migrate to Stardew Valley 1.6#Custom location contexts~~\|location context]].		\| Whether the [[#Target player\|specified player(s)]] are in the given [[Modding:Location_contexts\|location context]].
	\|-		\|-
	\| <samp>PLAYER_LOCATION_NAME {{t\|player}} {{t\|location name}}+</samp><br /><samp>PLAYER_LOCATION_UNIQUE_NAME {{t\|player}} {{t\|location name}}+</samp>		\| <samp>PLAYER_LOCATION_NAME {{t\|player}} {{t\|location name}}+</samp><br /><samp>PLAYER_LOCATION_UNIQUE_NAME {{t\|player}} {{t\|location name}}+</samp>

imported>OnionNinja: /* World */ Add IS_GREEN_RAIN_DAY (used in LocationContexts.xnb)

2025-11-16T17:41:30Z

World: Add IS_GREEN_RAIN_DAY (used in LocationContexts.xnb)

← Older revision		Revision as of 17:41, 16 November 2025
Line 174:		Line 174:
	\| <samp>IS_CUSTOM_FARM_TYPE</samp>		\| <samp>IS_CUSTOM_FARM_TYPE</samp>
	\| Whether the [[Farm Maps\|farm type]] is a custom one created by a mod. (This returns false for mods which edit/replace a vanilla farm type.)		\| Whether the [[Farm Maps\|farm type]] is a custom one created by a mod. (This returns false for mods which edit/replace a vanilla farm type.)
			\|-
			\| <samp>IS_GREEN_RAIN_DAY</samp>
			\| Whether the RNG has determined today to be the Green Rain day for the year.
	\|-		\|-
	\| <samp>IS_HOST</samp>		\| <samp>IS_HOST</samp>

imported>Mushymato: revise PLAYER_LOCATION_NAME quirk/bug note

2025-11-10T00:18:54Z

revise PLAYER_LOCATION_NAME quirk/bug note

← Older revision		Revision as of 00:18, 10 November 2025
Line 374:		Line 374:
	\| Whether the [[#Target player\|specified player(s)]] are in the given location, using the name or unique instanced name (you can see both names in-game using the {{nexus mod\|679\|Debug Mode}} mod). The {{t\|location name}} value doesn't recognize [[#Target location\|target location keywords]] like <samp>Here</samp>.		\| Whether the [[#Target player\|specified player(s)]] are in the given location, using the name or unique instanced name (you can see both names in-game using the {{nexus mod\|679\|Debug Mode}} mod). The {{t\|location name}} value doesn't recognize [[#Target location\|target location keywords]] like <samp>Here</samp>.

	'''Note:''' ~~When used with a LocationChanged [[Modding:Trigger_actions#Data.2FTriggerActions\|trigger]], it will check the~~ player's ~~previous~~ location ~~rather~~ than the ~~one they are warping to~~. ~~If you need to~~ check the ~~current~~ player's ~~new~~ location, use ~~<samp>~~LOCATION_NAME~~</samp>. If you need~~ to check ~~a [[#Target_player\|specific~~ player~~]] you may need to use workarounds such as using {{nexus mod\|1348\|SpaceCore~~'s~~}} time trigger~~.		'''Note:''' The player's current location is updated slower than the game's current location. This mainly impacts usage in LocationChanged as PLAYER_LOCATION_NAME will check the player's previous (not yet updated) location. Instead, use LOCATION_NAME to check the location they are entering. This GSQ works as expected in other cases where the player isn't in the middle of changing locations, and it's likely that this behavior will be fixed in future game updates.
	\|-		\|-
	\| <samp>PLAYER_MOD_DATA {{t\|player}} {{t\|key}} {{t\|value}}</samp>		\| <samp>PLAYER_MOD_DATA {{t\|player}} {{t\|key}} {{t\|value}}</samp>

imported>Abagaianye: Added warning to PLAYER_LOCATION_NAME that it checks the previous location when warping

2025-10-14T12:34:43Z

Added warning to PLAYER_LOCATION_NAME that it checks the previous location when warping

← Older revision		Revision as of 12:34, 14 October 2025
Line 372:		Line 372:
	\|-		\|-
	\| <samp>PLAYER_LOCATION_NAME {{t\|player}} {{t\|location name}}+</samp><br /><samp>PLAYER_LOCATION_UNIQUE_NAME {{t\|player}} {{t\|location name}}+</samp>		\| <samp>PLAYER_LOCATION_NAME {{t\|player}} {{t\|location name}}+</samp><br /><samp>PLAYER_LOCATION_UNIQUE_NAME {{t\|player}} {{t\|location name}}+</samp>
	\| Whether the [[#Target player\|specified player(s)]] are in the given location, using the name or unique instanced name (you can see both names in-game using the {{nexus mod\|679\|Debug Mode}} mod). The {{t\|location name}} value doesn't recognize [[#Target location\|target location keywords]] like <samp>Here</samp>.		\| Whether the [[#Target player\|specified player(s)]] are in the given location, using the name or unique instanced name (you can see both names in-game using the {{nexus mod\|679\|Debug Mode}} mod). The {{t\|location name}} value doesn't recognize [[#Target location\|target location keywords]] like <samp>Here</samp>.

			'''Note:''' When used with a LocationChanged [[Modding:Trigger_actions#Data.2FTriggerActions\|trigger]], it will check the player's previous location rather than the one they are warping to. If you need to check the current player's new location, use <samp>LOCATION_NAME</samp>. If you need to check a [[#Target_player\|specific player]] you may need to use workarounds such as using {{nexus mod\|1348\|SpaceCore's}} time trigger.
	\|-		\|-
	\| <samp>PLAYER_MOD_DATA {{t\|player}} {{t\|key}} {{t\|value}}</samp>		\| <samp>PLAYER_MOD_DATA {{t\|player}} {{t\|key}} {{t\|value}}</samp>