Modding:Event data - Revision history

imported>Ichortower: /* Event scripts */ Complete list of acceptable types for itemAboveHead. Remove duplicate sentence.

2026-10-08T15:34:24Z

Event scripts: Complete list of acceptable types for itemAboveHead. Remove duplicate sentence.

← Older revision		Revision as of 15:34, 8 October 2026
Line 673:		Line 673:
	\|-		\|-
	\| <samp>itemAboveHead {{o\|type\|item id}} {{o\|show message}}</samp>		\| <samp>itemAboveHead {{o\|type\|item id}} {{o\|show message}}</samp>
	\| Show an item above the player's head and ~~displays~~ a message about it. The {{o\|type}} can be "pan", "hero", "sculpture", "joja", "slimeEgg", "rod", "sword", or "~~ore~~". {{o\|item id}} can be any qualified item id. If no item is specified, ~~then they~~ will hold the furnace blueprint and no message will be displayed~~. <samp>item id</samp> can be any qualified item id~~. This command does not add the item to the player's inventory (except when used with "slimeEgg"). If {{o\|show message}} (true by default) is true, then the 'you received' message will be shown.		\| Show an item above the player's head and display a message about it. The {{o\|type}} can be "pan", "hero", "sculpture", "samBoombox", "joja", "slimeEgg", "rod", "sword", "ore", "pot", or "jukebox". {{o\|item id}} can be any qualified item id. If no item is specified, the player will hold the furnace blueprint and no message will be displayed. This command does not add the item to the player's inventory (except when used with "slimeEgg"). If {{o\|show message}} (true by default) is true, then the 'you received' message will be shown.

	The message box from <samp>itemAboveHead</samp> will cancel dialogue from commands that come after it unless at least 1,200ms has passed, so it is recommended to use a <samp>pause</samp> command after <samp>itemAboveHead</samp>.		The message box from <samp>itemAboveHead</samp> will cancel dialogue from commands that come after it unless at least 1,200ms has passed, so it is recommended to use a <samp>pause</samp> command after <samp>itemAboveHead</samp>.

imported>Margotbean: rm underscore

2026-09-10T15:31:46Z

rm underscore

← Older revision		Revision as of 15:31, 10 September 2026
Line 99:		Line 99:
	\|- id="Weather"		\|- id="Weather"
	\| <samp>Weather {{t\|weather}}</samp>		\| <samp>Weather {{t\|weather}}</samp>
	\| The weather in the current location's context matches {{t\|weather}}. Valid values: <samp>rainy</samp>, <samp>sunny</samp>, or a specific [[Modding:~~Weather_data~~#Data\|weather ID]].		\| The weather in the current location's context matches {{t\|weather}}. Valid values: <samp>rainy</samp>, <samp>sunny</samp>, or a specific [[Modding:Weather data#Data\|weather ID]].
	\|- id="WorldState"		\|- id="WorldState"
	\| <samp>WorldState {{t\|ID}}</samp>		\| <samp>WorldState {{t\|ID}}</samp>

imported>Abagaianye: /* World/Context */ Edited Weather precondition to add link to the weather data so people can find the more specific weather IDs

2026-09-10T03:24:19Z

World/Context: Edited Weather precondition to add link to the weather data so people can find the more specific weather IDs

← Older revision		Revision as of 03:24, 10 September 2026
Line 99:		Line 99:
	\|- id="Weather"		\|- id="Weather"
	\| <samp>Weather {{t\|weather}}</samp>		\| <samp>Weather {{t\|weather}}</samp>
	\| The weather in the current location's context matches {{t\|weather}}. Valid values: <samp>rainy</samp>, <samp>sunny</samp>, or a specific weather ID.		\| The weather in the current location's context matches {{t\|weather}}. Valid values: <samp>rainy</samp>, <samp>sunny</samp>, or a specific [[Modding:Weather_data#Data\|weather ID]].
	\|- id="WorldState"		\|- id="WorldState"
	\| <samp>WorldState {{t\|ID}}</samp>		\| <samp>WorldState {{t\|ID}}</samp>

imported>EnderTedi: /* Basic format */ Document AddTemporaryActor's '[Character|Animal|Monster]' field being able to change the actor's display name

2026-08-08T10:14:15Z

Basic format: Document AddTemporaryActor's '[Character|Animal|Monster]' field being able to change the actor's display name

← Older revision		Revision as of 10:14, 8 August 2026
Line 466:		Line 466:
	{{o\|breather}} is boolean (default <samp>true</samp>).		{{o\|breather}} is boolean (default <samp>true</samp>).

	{{o\|Character\|Animal\|Monster}} (default <samp>Character</samp>) determines whether the sprite will be loaded from <samp>"Characters/"</samp>, <samp>"Animals/"</samp>, or <samp>"Characters/Monsters/"</samp>.		{{o\|Character\|Animal\|Monster}} (default <samp>Character</samp>) determines whether the sprite will be loaded from <samp>"Characters/"</samp>, <samp>"Animals/"</samp>, or <samp>"Characters/Monsters/"</samp>. Any value other than <samp>Character</samp>, <samp>Animal</samp> or <samp>Monster</samp> will act functionally as <samp>Character</samp> and will change the temporary actor's display name to the value. For example, a value of <samp>Pufferchick</samp> will set the actor's display name to be "Pufferchick".

	{{o\|override name}} can be used to give the temporary actor a different name.		{{o\|override name}} can be used to give the temporary actor a different name.

imported>Pathoschild: /* Basic format */ correct addObject layer depth info

2026-03-14T15:33:58Z

Basic format: correct addObject layer depth info

← Older revision		Revision as of 15:33, 14 March 2026
Line 447:		Line 447:
	\| Adds a glowing temporary sprite at the specified tile from the <samp>Maps\springobjects.png</samp> sprite sheet. A light radius of <samp>0</samp> just places the sprite. Sprites are in 20 columns of 16x16 squares. The index for the default lantern sprite is 735.		\| Adds a glowing temporary sprite at the specified tile from the <samp>Maps\springobjects.png</samp> sprite sheet. A light radius of <samp>0</samp> just places the sprite. Sprites are in 20 columns of 16x16 squares. The index for the default lantern sprite is 735.
	\|-		\|-
	\| <samp>addObject {{t\|x}} {{t\|y}} {{t\|item ID}} {{o\|layer}} </samp>		\| <samp>addObject {{t\|x}} {{t\|y}} {{t\|item ID}} {{o\|layer depth}}</samp>
	\| Adds a temporary sprite at the tile specified by {{t\|x}} and {{t\|y}} using a [[Modding:Common data field types#Item ID\|qualified or unqualified item ID]] from <samp>Data/Objects</samp>. ~~Layer (default <samp>-1</samp>) refers to~~ the depth at which the sprite ~~will be drawn~~ on the screen, ~~with~~ higher numbers ~~meaning~~ it ~~will be drawn on top of other~~ things. ~~Can be negative numbers. Any number above~~ 0 ~~will draw the object on top of NPCs~~.		\| Adds a temporary sprite at the tile specified by {{t\|x}} and {{t\|y}} using a [[Modding:Common data field types#Item ID\|qualified or unqualified item ID]] from <samp>Data/Objects</samp>.

			The optional {{o\|layer depth}} is the depth at which to draw the sprite on the screen. The value starts at 0, and higher numbers draw it over more things. If omitted (or set to a value below 0), defaults to an auto-calculated depth.
	\|-		\|-
	\| <samp>addProp {{t\|prop index}} {{t\|x}} {{t\|y}} {{o\|solid width}} {{o\|solid height}} {{o\|display height}}</samp>		\| <samp>addProp {{t\|prop index}} {{t\|x}} {{t\|y}} {{o\|solid width}} {{o\|solid height}} {{o\|display height}}</samp>

imported>Abagaianye: Changed the changeToTemporaryMap pan argument to be called clamp instead because it doesn't do any panning but is not broken like I previously thought.

2026-02-26T03:27:35Z

Changed the changeToTemporaryMap pan argument to be called clamp instead because it doesn't do any panning but is not broken like I previously thought.

← Older revision		Revision as of 03:27, 26 February 2026
Line 536:		Line 536:
	\| Change the sprite asset for specified NPC's portrait to one matching the form <samp>"Characters/{{t\|actor}}_{{o\|sprite}}"</samp>. For example, <code>changeSprite Shane JojaMart</code> would make Shane use his JojaMart sprite. Repeat the command without the {{o\|sprite}} argument to change the NPC back to their normal sprite.		\| Change the sprite asset for specified NPC's portrait to one matching the form <samp>"Characters/{{t\|actor}}_{{o\|sprite}}"</samp>. For example, <code>changeSprite Shane JojaMart</code> would make Shane use his JojaMart sprite. Repeat the command without the {{o\|sprite}} argument to change the NPC back to their normal sprite.
	\|-		\|-
	\| <samp>changeToTemporaryMap {{t\|map}} {{o\|~~pan~~}}</samp>		\| <samp>changeToTemporaryMap {{t\|map}} {{o\|clamp}}</samp>
	\| Change the location to a temporary one loaded from the map file specified by {{t\|map}}. ~~'''~~The {{o\|~~pan~~}} argument ~~is broken — the screen will not pan regardless of what value it is given.''' By setting this parameter to~~ false, ~~the map will appear at~~ the viewport ~~you specify~~ in ~~the next argument~~.		\| Change the location to a temporary one loaded from the map file specified by {{t\|map}}. The {{o\|clamp}} argument (<samp>true/false</samp>, default <samp>true</samp>) reclamps the viewport to be in-bounds when <samp>true</samp>.
	\|-		\|-
	\| <samp>changeYSourceRectOffset {{t\|npc}} {{t\|offset}}</samp>		\| <samp>changeYSourceRectOffset {{t\|npc}} {{t\|offset}}</samp>

imported>Spiderbuttons: /* Current player */ Remove note about the Tile precondition working even when not warping, as this is just how all preconditions work now.

2026-02-25T23:17:25Z

Current player: Remove note about the Tile precondition working even when not warping, as this is just how all preconditions work now.

← Older revision		Revision as of 23:17, 25 February 2026
Line 172:		Line 172:
	\|- id="Tile"		\|- id="Tile"
	\| <samp>Tile {{t\|x}} {{t\|y}}+</samp>		\| <samp>Tile {{t\|x}} {{t\|y}}+</samp>
	\| Current player is standing on one of the given tile positions (can specify multiple x/y positions)~~. This works even if the player is not currently warping~~.		\| Current player is standing on one of the given tile positions (can specify multiple x/y positions).
	\|}		\|}

imported>Siana12 at 23:56, 19 February 2026

2026-02-19T23:56:37Z

← Older revision		Revision as of 23:56, 19 February 2026
Line 537:		Line 537:
	\|-		\|-
	\| <samp>changeToTemporaryMap {{t\|map}} {{o\|pan}}</samp>		\| <samp>changeToTemporaryMap {{t\|map}} {{o\|pan}}</samp>
	\| Change the location to a temporary one loaded from the map file specified by {{t\|map}}. '''The {{o\|pan}} argument is broken — the screen will not pan regardless of what value it is given.'''		\| Change the location to a temporary one loaded from the map file specified by {{t\|map}}. '''The {{o\|pan}} argument is broken — the screen will not pan regardless of what value it is given.''' By setting this parameter to false, the map will appear at the viewport you specify in the next argument.
	\|-		\|-
	\| <samp>changeYSourceRectOffset {{t\|npc}} {{t\|offset}}</samp>		\| <samp>changeYSourceRectOffset {{t\|npc}} {{t\|offset}}</samp>

imported>Pathoschild: /* Basic format */ expand temporaryAnimatedSprites flag options to make room for upcoming 1.6.16 changes

2026-02-18T00:01:18Z

Basic format: expand temporaryAnimatedSprites flag options to make room for upcoming 1.6.16 changes

@@ Line 868: / Line 868: @@
 | Create a temporary sprite with the given parameters, from the resource <samp>TileSheets/animations</samp>.
 |-
-| <samp>temporaryAnimatedSprite ...</samp>
+| <samp>temporaryAnimatedSprite …</samp>
-| Add a temporary animated sprite to the event, using these space-delimited fields:
+| Add a temporary animated sprite to the event.
 {| class="wikitable"
 |-
@@ Line 930: / Line 932: @@
 | 17
 | <samp>rotation change</samp>
 | Continuously rotates the sprite, causing it to spin. The speed is determined by input value.
 |-
-| 18+
+| <samp>acceleration_change {{t|x}} {{t|y}}</samp>
-| ''flags''
+| '''[TODO: document what this does]'''
 |}
 |-

imported>Abagaianye: Edited GameStateQuery precondition description so the example uses the full name instead of the alias

2026-01-06T08:45:37Z

Edited GameStateQuery precondition description so the example uses the full name instead of the alias

← Older revision		Revision as of 08:45, 6 January 2026
Line 51:		Line 51:
	\|- id="GameStateQuery"		\|- id="GameStateQuery"
	\| <samp>GameStateQuery {{t\|query}}</samp>		\| <samp>GameStateQuery {{t\|query}}</samp>
	\| A [[Modding:Game state queries\|game state query]] matches, like <code>G !WEATHER Here Sun</code> for 'not sunny in this location'.		\| A [[Modding:Game state queries\|game state query]] matches, like <code>GameStateQuery !WEATHER Here Sun</code> for 'not sunny in this location'.
	\|}		\|}

← Older revision		Revision as of 10:14, 8 August 2026
Line 466:		Line 466:
	{{o\|breather}} is boolean (default <samp>true</samp>).		{{o\|breather}} is boolean (default <samp>true</samp>).

	{{o\|Character\|Animal\|Monster}} (default <samp>Character</samp>) determines whether the sprite will be loaded from <samp>"Characters/"</samp>, <samp>"Animals/"</samp>, or <samp>"Characters/Monsters/"</samp>.		{{o\|Character\|Animal\|Monster}} (default <samp>Character</samp>) determines whether the sprite will be loaded from <samp>"Characters/"</samp>, <samp>"Animals/"</samp>, or <samp>"Characters/Monsters/"</samp>. Any value other than <samp>Character</samp>, <samp>Animal</samp> or <samp>Monster</samp> will act functionally as <samp>Character</samp> and will change the temporary actor's display name to the value. For example, a value of <samp>Pufferchick</samp> will set the actor's display name to be "Pufferchick".

	{{o\|override name}} can be used to give the temporary actor a different name.		{{o\|override name}} can be used to give the temporary actor a different name.