View source for Modding:Maps

← [[Modding:Index|Index]]

This page explains how to edit maps. This is an advanced guide for modders.

==Intro==
===Basic concepts===
<ul>
<li>A '''map''' is the layout of the terrain (like water, cliffs, and land), terrain features (like bushes), buildings, paths, and triggers for a particular area. When you reach the edge of an area or enter a building, and the screen fades to black during the transition, you're moving between maps.</li>

<li>Each map consists of several '''layers''' stacked one in front of the other. Objects in a layer closer to the front will hide objects in layers behind them. From back to front, the standard layers are...

{| class="wikitable"
|-
! layer name
! typical contents
|-
| Back
| Terrain, water, and basic features (like permanent paths).
|-
| Buildings
| Placeholders for buildings (like the farmhouse).
|-
| Paths
| Flooring, paths, grass, and debris (like stones, weeds, and stumps) which can be removed by the player.
|-
| Front
| Objects that are drawn on top of things behind them, like most trees.
|-
| AlwaysFront
| Objects that are always drawn on top of other layers. This is typically used for foreground effects like foliage cover.
|}</li>

<li>Each layer consists of many '''tiles''', which are 16×16 pixel squares placed in a grid to form the visible map. Each tile can have properties (e.g. passable / blocked), special logic (e.g. an action to perform when the player steps on them), and a picture to show. The picture is represented by a sprite index (or tile index), which is its position in an associated spritesheet (see next).</li>

<li>Each map has one or more spritesheets (also known as tilesheets when talking about mods), which contains the available tiles and images that are put together to form the visible map.</li>
</ul>

===Tile coordinates===
Each tile has an (x, y) coordinate which represents its position on the map, where (0, 0) is the top-left tile. The ''x'' value increases towards the right, and ''y'' increases downwards. For example:

[[File:Modding - creating an XNB mod - tile coordinates.png]]

==Getting started==
There are two main ways to edit a map.

===Using SMAPI===
Creating a SMAPI mod requires programming, but it's much more powerful and multiple SMAPI mods can edit the same map. If you want to use this approach:
# [[Modding:Creating a SMAPI mod|Create a SMAPI mod]].
# See instructions below for map changes.

===Using Tiled===
Creating an XNB mod doesn't require programming, but it's less flexible and players can't install two XNB mods that change the same map. You'll need to unpack the game's map file, change it using a map editor, and repack it. If you want to use this approach:

<ol>
<li>Install the [http://www.mapeditor.org/ latest version of Tiled].</li>
<li>Once installed, go to ''Edit > Preferences > Plugins'' and enable the <tt>tbin</tt> plugin.</li>
<li>Set the following settings:
{| class="wikitable"
|-
! setting
! value
! reason
|-
| ''View > Snap to Grid''
| ✓ enabled
| This is required to convert objects back into the game's format.
|-
| ''Highlight Current Layer''
| ✓ enabled
| This makes it more clear which tile you're editing.
|}</li>
<li>See [[Modding:Editing XNB files]] for help unpacking & packing the map files.</li>
<li>See instructions below for map changes.</li>
</ol>

==Map edits==
===Custom map===
You can add a new map and location to the game.

If you're using SMAPI:
:<source lang="C#">
public override void Entry(IModHelper helper)
{
   // the game clears locations when loading the save, so do it after the save loads
   SaveEvents.AfterLoad += AfterSaveLoaded;
}
private void AfterSaveLoaded(object sender, EventArgs args)
{
   // load a map.tbin file from your mod's folder.
   Map map = this.Helper.Content.Load<Map>("map.tbin", ContentSource.ModFolder);

   // create a map asset key 
   string mapAssetKey = this.Helper.Content.GetActualAssetKey("map.xnb", ContentSource.ModFolder);

   // add the new location
   GameLocation location = new GameLocation(mapAssetKey, "YourLocationName") { IsOutdoors = false, IsFarm = false };
   Game1.locations.Add(location);
}
</source>

If you're using Tiled:
: You can create the map in Tiled, but you need SMAPI to add it to the game.

===Custom tilesheet===
You can add custom sprites, tiles, or images to a map. Be sure to prefix custom tilesheet IDs with <code>z</code>, to avoid shifting the vanilla tilesheet indexes and potentially causing graphical corruption.

If you're using SMAPI:
:<source lang="c#">
public void Entry(IModHelper helper)
{
   // This gets the asset key for a tilesheet.png file from your mod's folder. You can also load a game tilesheet like
   // this: helper.Content.GetActualAssetKey("spring_town", ContentSource.GameContent).
   string tilesheetPath = helper.Content.GetActualAssetKey("tilesheet.png", ContentSource.ModFolder);

   // Get an instance of the in-game location you want to patch. For the farm, use Game1.getFarm() instead.
   GameLocation location = Game1.getLocationFromName("Town");

   // Add the tilesheet.
   TileSheet tilesheet = new TileSheet(
      id: "z_your-custom-spritesheet", // a unique ID for the tilesheet
      map: location.map,
      imageSource: tilesheetPath,
      sheetSize: new xTile.Dimensions.Size(32, 62), // the pixel size of your tilesheet image.
      tileSize: new xTile.Dimensions.Size(16, 16) // should always be 16x16 for maps
   );
   location.map.AddTileSheet(tilesheet);
   location.map.LoadTileSheets(Game1.mapDisplayDevice);
}
</source>
: To change tiles using the new tilesheet, see [[#Tiles]] below.

If you're using Tiled:
:# Create your spritesheet. This should be a PNG image with images divided into 16x16 tiles (see [[Modding:Editing XNB files#Intro]] for examples).
:# Open the map in Tiled.
:# Add the custom spritesheet:
:## In the ''Tilesets'' pane, click the [[File:Modding - creating an XNB mod - Tiled 'new tilesheet' button.png]] button.
:## Give it a descriptive name (like 'cute bugs') and choose the image source.
:## Keep the default settings and click ''OK''.
:# Add custom sprites to the map:
:## In the ''Layers'' pane, click the layer you want to edit.
:## In the ''Tilesets'' pane, click the tab for your custom spritesheet.
:## In the ''Tilesets'' pane, click one tile to select it. To choose multiple, click and drag the cursor.
:## Move the cursor to the map, and you'll see an overlay with the tiles you selected.
:## Click the map to place those tiles on the selected layer.

===Map properties===
Each map can have multiple map properties, which define attributes and behaviour associated with the map like lighting, music, warp points, etc. Each property has a name (which defines the type of property) and value (which configures the property). See [[#Known properties]] below.

If you're using SMAPI:
: <source lang="c#">
public void Entry(IModHelper helper)
{
   // get the 'Music' value
   Game1.currentLocation.map.Properties.TryGetValue("Music", out string value);

   // add or set the 'Music' value
   Game1.currentLocation.map.Properties["Music"] = "MarlonsTheme";

   // remove the 'Music' value
   Game1.currentLocation.map.Properties.Remove("Music");
}
</source>

If you're using Tiled:
:# Click ''Map'' on the toolbar and choose ''Map Properties''.
:# View and edit properties using the GUI.

===Tile properties===
Tile properties are set on individual map tiles. They can change game behaviour (like whether the player can cross them), or perform actions when the player steps on or clicks the tile. Each property has a name and value.

If you're using SMAPI:
: <source lang="C#">
public void Entry(IModHelper helper)
{
   // get property
   string value = Game1.currentLocation.doesTileHaveProperty(tileX, tileY, "Diggable", "Back");

   // add or set property
   Game1.currentLocation.setTileProperty(tileX, tileY, "Back", "Diggable", "T");

   // remove tile property
   Layer layer = Game1.currentLocation.map.GetLayer("Back");
   Tile tile = layer.PickTile(new xTile.Dimensions.Location(x, y) * Game1.tileSize, Game1.viewport.Size);
   tile.Properties.Remove("Diggable");
   //tile.TileIndexProperties.Remove("Diggable"); // NOTE: removing a tile index property will affect all tiles of this type
}
</source>

If you're using Tiled:
: In Tiled these are represented by two types: ''object properties'' only apply to the selected tile, while ''tile properties'' apply to every instance of that tile. In general you'll always set ''object properties'', so we'll only cover those.
:# Select the object layer in the ''Layers'' pane.
:# Choose the [[File:Modding - creating an XNB mod - Tiled 'select object' button.png]] ''select object'' tool in the toolbar.
:# Click the object whose properties you want to view. Objects are represented with a gray selection box on the map:<br />[[File:Modding - creating an XNB mod - map object.png]]
:# The object properties will be shown in the ''Properties'' pane.<br />[[File:Modding - creating an XNB mod - Tiled tile properties pane.png]] 

: To edit properties for an existing object:
:* Change a value: click the value field and enter the new value.
:* Change a name: select the property and click the [[File:Modding - creating an XNB mod - Tiled 'edit' button.png]] icon.
:* Add a property: click the [[File:Modding - creating an XNB mod - Tiled 'add' button.png]] icon, enter the property name, make sure the selected type is "string", and click OK.

: To add a new object:
:# Select the object layer in the ''Layers'' pane.<br />''There should be one object layer for each tile layer. If the object layer is missing, create one with the same name as the right tile layer.''
:# Choose the [[File:Modding - creating an XNB mod - Tiled 'insert rectangle' button.png]] ''insert rectangle'' tool from the toolbar.
:# Click and drag the rectangle over the tile you want to edit. Make sure it snaps to the tile grid (see [[#Using Tiled]]), and only one tile is selected.
:## See previous for how to edit its properties.

===Tiles===
You can edit the tiles for an existing map.

If you're using SMAPI:
:<source lang="c#">
public void Entry(IModHelper helper)
{
   // remove tile from layer
   location.removeTile(tileX, tileY, "Back");

   // add tile
   Layer layer = location.map.GetLayer("Back");
   TileSheet tilesheet = location.map.GetTilesheet("tilesheet name");
   layer.Tiles[tileX, tileY] = new StaticTile(layer, tilesheet, BlendMode.Alpha, tileID);

   // toggle water tile behaviour
   location.waterTiles[tileX, tilyY] = false; // true: water, false: not water
}
</source>

If you're using Tiled:
: See [http://doc.mapeditor.org Tiled documentation].

===Animated tiles===
[[File:Modding - creating an XNB mod - example animation.gif|right]]
You can animate tiles to create effects like Gil in his rocking chair (see example at right).

If you're using SMAPI:
: <span style="color:red;">'''TODO'''</span>

If you're using Tiled:
:# Select the tile you want to animate in the ''Tilesets'' pane.
:# Click ''View > Tile Animation Editor'' in the toolbar to show that pane.
:# In the ''Tile Animation Editor'' pane, drag tiles from the tilesheet into the box on the left to create a ''frame'' (one image in the sequence).
:# Double-click the numbers to change how long each frame stays on the screen before the next one (in milliseconds). '''Make sure every frame has the same time; the game can't handle variable frame times.''' For example, here's the animation editor showing one of the tiles of Gil rocking:<br />[[File:Modding - creating an XNB mod - Tiled example animation pane.gif]]
:# When you're done, close the pane.
:# The animated tiles in the ''Tilesets'' pane will now have a little symbol in the bottom-right corner:<br />[[File:Modding - creating an XNB mod - Tiled example animation tileset.png]]<br />The animation is now part of that tile. Every instance of that tile on the map will now have the same animation.

==Known properties==
===Map properties===
Known map properties:¹
{| class="wikitable"
|-
! property
! explanation
|-
| <tt>AmbientLight {{t|byte r}} {{t|byte g}} {{t|byte b}}</tt><br />''(valid in indoor locations and locations that ignore outdoor lighting)''
| Sets the [[wikipedia:RGB color model|RGB colour]] that is subtracted from white (255,255,255) in order to create the ambient light.<br />''Example: <tt>AmbientLight 95 95 95</tt> for a normal indoor daytime lighting.''
|-
| <tt>BrookSounds [{{t|int x}} {{t|int y}} {{t|int type}}]</tt><br />''(valid in outdoor locations)''
| Adds sound sources. The {{t|x}} {{t|y}} fields are the tile coordinates, and {{t|type}} is the ambient sound ID. The {{t|type}} of sound can be one of...
* 0 (babblingBrook);
* 1 (cracklingFire);
* 2 (engine);
* 3 (cricket).
|-
| <tt>DayTiles [{{t|string layerName}} {{t|int x}} {{t|int y}} {{t|int tilesheetIndex}}]+</tt><br />''(valid in any location)''
| Sets tiles to act as daytime windows. Anytime before 7pm, this finds the tile at position ({{t|x}}, {{t|y}}) on the map layer matching {{t|layerName}}, changes its tilesheet index to the specified {{t|tilesheetIndex}}, and adds a glow to simulate daylight. The glow will only be added if the location is indoors and the {{t|tilesheetIndex}} is 256, 288, 405, 469, or 1224. The parameters can be repeated to affect multiple tiles.<br />''Example: <tt>DayTiles Front 3 1 256 Front 3 2 288</tt>.''
|-
| <tt>Doors {{t|int x}} {{t|int y}} {{t|string sheetID}} {{t|int tileID}}</tt><br />''(valid in any location)''
| Adds a door. The {{t|x}} {{t|y}} fields are the tile coordinates, {{t|sheetID}} is the name of the sheet containing the door sprite, and {{t|tileID}} is the tile index in the spritesheet.
|-
| <tt>Fall_Objects T</tt>²<br /><tt>Spring_Objects T</tt>²<br /><tt>Summer_Objects T</tt>²<br /><tt>Winter_Objects T</tt>²
| Whether to spawn seasonal objects on spawnable tiles based on the data in <tt>Data\Locations.xnb</tt>.<br />''Example: <tt>Fall_Objects</tt>.''
|-
| <tt>Light [{{t|int x}} {{t|int y}} {{t|int type}}]+</tt><br />''(valid in any location)''
| Adds light sources. The {{t|type}} field is the kind of light source (e.g. 4 for twin candles), and {{t|x}} {{t|y}} are the tile coordinates.The {{t|type}} of light source can be one of...
* 1 (lantern);
* 2 (window);
* 3 (sconce offset by half a tile to the right);
* 4 (sconce);
* 5 (cauldron);
* 6 (indoor window);
* 9 (large sconce).
Any other value will crash the game.<br />''Example: <tt>Light 3 8 4 6 8 4 11 8 4 3 2 5 10 2 5 6 19 5 5 15 5 5 11 5 11 12 5</tt> (Adventurer's Guild).''
|-
| <tt>Music {{t|string name}}</tt><br />''(valid in any location)''
| Sets the music that plays when the player enters, where {{t|name}} is the cue name in the audio files.<br />''Example: <tt>Music MarlonsTheme</tt>.''
|-
| <tt>Music {{t|int start}} {{t|int end}} {{t|string name}}</tt><br />''(valid in any location)''
| Sets the music that plays when the player enters, where {{t|name}} is the cue name in the audio files, music will only play if the time is between {{t|int start}} (inclusive) and {{t|int end}} (exclusive).<br />''Example: <tt>Music 800 1200 MarlonsTheme</tt>.''
|-
| <tt>NightTiles [{{t|string layerName}} {{t|int x}} {{t|int y}} {{t|int tilesheetIndex}}]+</tt><br />''(valid in any location)''
| ?
|-
| <tt>Outdoors T</tt>²<br />''(valid in any location)''
| Sets whether the location is outdoors.<br />''Example: <tt>Outdoors true</tt>.''
|-
| <tt>TreatAsOutdoors T</tt>²<br />''(valid in any location)''
| The location is treated as outdoors for the purposes of spawning debris and similar mechanics.
|-
| <tt>Trees [{{t|int x}} {{t|int y}} {{t|int type}}]+</tt>
| Adds trees to the map. The {{t|x}} {{t|y}} fields are the tile coordinates, and {{t|type}} is the tree type (1: oak, 2: maple, 3: pine, 6: palm, 7: mushroom tree).<br />''Example: <tt>Trees 17 18 2 20 31 2</tt>.''
|-
| <tt>UniquePortrait [{{t|str name}}]+</tt><br />''(valid in any location)''
| ?
|-
| <tt>UniqueSprite [{{t|str name}}]+</tt><br />''(valid in any location)''
| ?
|-
| <tt>ViewportFollowPlayer T</tt>²<br />''(valid in any location)''
| Forces the viewport to stay centered on the player.<br />''Example: <tt>ViewportFollowPlayer</tt>.''
|-
| <tt>Warp [{{t|int fromX}} {{t|int fromY}} {{t|string toArea}} {{t|int toX}} {{t|int toY}}]+</tt><br />''(valid in any location)''
| Sets the tiles which warp the player to another map (e.g. doors). The {{t|fromX}} {{t|fromY}} fields are the tile coordinates that initiate the warp, and {{t|toArea}} {{t|toX}} {{t|toY}} are the name of the in-game location to warp to and the tile coordinates within it.<br />''Example: 6 20 Mountain 76 9.''
|}

The following properties are used but apparently have no effect: <tt>Arch</tt>, <tt>Debris</tt>, and <tt>Fish</tt>.

<small>¹ Map properties are handled in <tt>GameLocation::resetForPlayerEntry</tt> and <tt>GameLocation::loadObjects</tt>.</small><br />
<small>² The <tt>T</tt> value (short for ''true'') is conventional, but any non-empty value will work too.</small>

===Tile properties===
Known tile properties (excluding specialised properties like <tt>TouchAction WomensLocker</tt>):¹

{| class="wikitable"
|-
! layer
! property
! explanation
|-
| <tt>Back</tt>
| <tt>Diggable T</tt>²
| Marks the tile as diggable with the hoe and enables planting crops.
|-
| <tt>Back</tt>
| <tt>NoFurniture T</tt>²
| Prevents the player from placing furniture on this tile.
|-
| <tt>Back</tt>
| <tt>NoSpawn All</tt><br /><tt>NoSpawn True</tt>
| Combines <tt>NoSpawn Grass</tt> and <tt>NoSpawn Tree</tt>.
|-
| <tt>Back</tt>
| <tt>NoSpawn Grass</tt>
| Prevents debris (e.g. weeds or stones) from spawning on this tile.
|-
| <tt>Back</tt>
| <tt>NoSpawn Tree</tt>
| Prevents trees from spawning on this tile. Prevents the player from planting trees on this tile, except on the farm. If a tree is already on this tile, prevents it from growing.
|-
| <tt>Back</tt>
| <tt>NPCBarrier T</tt>²
| Prevents NPCs from crossing this tile.
|-
| <tt>Back</tt>
| <tt>Type {{t|str type}}</tt>
| Sets the tile type for various game logic (e.g. step sounds or planting crops), where {{t|type}} is one of ''Dirt'', ''Stone'', ''Grass'', or ''Wood''.
|-
| <tt>Back</tt>
| <tt>Water T</tt>²
| Marks the tile as a water tile for various game logic (e.g. items splash into it, can refill watering can from it, can't walk on it, etc).
|-
| <tt>Back</tt>
| <tt>WaterSource T</tt>²
| Lets the player refill the watering can from this tile.
|}

The <tt>TouchAction</tt> property makes something happen when the player steps on the tile:

{| class="wikitable"
|-
! layer
! property
! explanation
|-
| <tt>Back</tt>
| <tt>TouchAction ChangeIntoSwimsuit</tt>
| Changes the player into their swimsuit and disables running.
|-
| <tt>Back</tt>
| <tt>TouchAction ChangeOutOfSwimsuit</tt>
| Changes the player into their regular clothes and enables running.
|-
| <tt>Back</tt>
| <tt>TouchAction Door {{t|string npc}}</tt>
| If the player doesn't have 2+ friendship hearts with the villager named by the {{t|npc}} field: stops the player, marks the tile as impassible, and displays a door-locked message.
|-
| <tt>Back</tt>
| <tt>TouchAction Emote {{t|string npc}} {{t|int emoteID}}</tt>
| Finds the NPC whose name matches the {{t|npc}} field, and causes them to show the given {{t|emoteID}} above their head (4: empty can, 8: question mark, 12: angry, 16: exclamation, 20: heart, 24: sleep, 28: sad, 32: happy, 36: x, 40: pause, 52: videogame, 56: music note, 60: blush).
|-
| <tt>Back</tt>
| <tt>TouchAction FacingDirection {{t|string npc}} {{t|int direction}}</tt>
| Finds the NPC whose name matches the {{t|npc}} field, and make them face the given direction (0: up, 1: right, 2: down, 3: left).
|-
| <tt>Back</tt>
| <tt>TouchAction MagicWarp {{t|string area}} {{t|int x}} {{t|int y}} {{o|string prerequisite}}</tt>
| Warps the player to the {{t|x}} {{t|y}} tile coordinates in the given {{t|area}} with a magic sound and effects. If the {{o|prerequisite}} field is specified, only occurs if that flag is set via <tt>Game1.player.mailReceived</tt>.
|-
| <tt>Back</tt>
| <tt>TouchAction PoolEntrance</tt>
| Switches the player between swimming and walking mode.
|-
| <tt>Back</tt>
| <tt>TouchAction Sleep</tt>
| Ends the day if the player confirms.
|}

The <tt>Action</tt> property makes something happen when the player interacts (e.g. clicks) with the tile:

{| class="wikitable"
|-
! layer
! property
! explanation
|-
| <tt>Buildings</tt>
| <tt>Action AdventureShop</tt>
| Shows the Adventurer's Guild shop screen.
|-
| <tt>Buildings</tt>
| <tt>Action Arcade_Prairie</tt>
| Shows the ''Journey of the Prairie King'' arcade game.
|-
| <tt>Buildings</tt>
| <tt>Action Arcade_Minecart</tt>
| Shows the ''Junimo Kart'' arcade game.
|-
| <tt>Buildings</tt>
| <tt>Action BuyBackpack</tt>
| Shows a menu which lets the player upgrade their backpack if an upgrade is available.
|-
| <tt>Buildings</tt>
| <tt>Action Billboard</tt>
| Shows the calendar menu.
|-
| <tt>Buildings</tt>
| <tt>Action BuyQiCoins</tt>
| Shows a dialogue which lets the player buy 100 Casino club coins.
|-
| <tt>Buildings</tt>
| <tt>Action ColaMachine</tt>
| Offers to let the player buy a Joja cola.
|-
| <tt>Buildings</tt>
| <tt>Action ClubCards</tt><br /><tt>Action Blackjack</tt>
| Shows the casino blackjack minigame.
|-
| <tt>Buildings</tt>
| <tt>Action ClubComputer</tt><br /><tt>Action FarmerFile</tt>
| Shows a dialogue with play stats (steps taken, gifts given, dirt hoed, etc).
|-
| <tt>Buildings</tt>
| <tt>Action ClubSeller</tt>
| Shows a dialogue which lets the player buy a [[Statue of Endless Fortune]] for one million gold.
|-
| <tt>Buildings</tt>
| <tt>Action ClubShop</tt>
| Shows the casino shop menu.
|-
| <tt>Buildings</tt>
| <tt>Action ClubSlots</tt>
| Shows the casino slots minigame.
|-
| <tt>Buildings</tt>
| <tt>Action Dialogue {{t|text}}</tt>
| Shows a generic dialogue box with the given text. See [[Modding:Dialogue|dialogue format]].<br />''Example: Action Dialogue Hi there @!''
|-
| <tt>Buildings</tt>
| <tt>Action DivorceBook</tt>
| Shows divorce options for the player's current marriage status (as if they clicked the [[Marriage#Divorce|divorce book]]).
|-
| <tt>Buildings</tt>
| <tt>Action JojaShop</tt>
| Shows the Joja shopping screen.
|-
| <tt>Buildings</tt>
| <tt>Action Jukebox</tt>
| Shows the jukebox menu to choose the ambient music.
|-
| <tt>Buildings</tt>
| <tt>Action kitchen</tt>
| Shows the cooking menu.
|-
| <tt>Buildings</tt>
| <tt>Action Letter {{t|string text}}</tt>
| Shows the letter menu on-screen with the given text, with the syntax used by <tt>Data\mail.xnb</tt>.<br />''Example: <tt>Action Letter Hey there!^I had some extra wood lying around... I thought maybe you could use it. Take care!  ^   -Robin %item object 388 50 %%</tt>''
|-
| <tt>Buildings</tt>
| <tt>Action LockedDoorWarp [{{t|int toX}} {{t|int toY}} {{t|string toArea}} {{t|int openTime}} {{t|int closeTime}}]</tt>
| Creates an activation warp normally used on doors with a time window for when it can be used. Note that you must use 24-hour times, i.e. 2000 for 8pm. <br />''Example: 6 29 SeedShop 900 2100''
|-
| <tt>Buildings</tt>
| <tt>Action Mailbox</tt>
| Shows the next letter from the player's mailbox (if any).
|-
| <tt>Buildings</tt>
| <tt>Action Material</tt>
| Shows a summary of the player's stockpiled wood and stone.
|-
| <tt>Buildings</tt>
| <tt>Action Message {{t|string messageKey}}</tt>
| Loads a message with the given key from the ''Content\Strings\StringsFromMaps.xnb'' file and displays it in a dialogue box.
|-
| <tt>Buildings</tt>
| <tt>Action MessageOnce {{t|int eventID}} {{t|string message}}</tt>
| If the player hasn't seen the event with ID {{t|eventID}}, marks that event seen and displays the given message text in a dialogue box. This does ''not'' parse [[Modding:Dialogue|dialogue format]].
|-
| <tt>Buildings</tt>
| <tt>Action MineSign {{t|string message}}</tt>
| Shows a mini-dialogue box with the given raw message text. This does ''not'' parse [[Modding:Dialogue|dialogue format]].
|-
| <tt>Buildings</tt>
| <tt>Action MinecartTransport</tt>
| Shows the minecart destination menu (or a message if not unlocked).
|-
| <tt>Buildings</tt>
| <tt>Action MineElevator</tt>
| Shows the mine elevator menu (to warp to a mine level) if the player has reached mine level 5+, else a mine elevator not working message.
|-
| <tt>Buildings</tt>
| <tt>Action NextMineLevel</tt>
| Warps the player to the next mine level (or level 1 if they're not in the mine).
|-
| <tt>Buildings</tt>
| <tt>Action Notes {{t|int noteID}}</tt>
| If the player has found the specified lost book, displays its museum note text and marks it read.<br />''Example: Action Notes 17''
|-
| <tt>Buildings</tt>
| <tt>Action NPCMessage {{t|str name}} "{{t|str dialogueKey}}"</tt>
| If the named NPC is within 14 tiles of the player, reads dialogue with the given key from the string files and displays a dialogue box. See [[Modding:Dialogue|dialogue format]].<br />''Example: Action NPCMessage Abigail "Strings\\StringsFromCSFiles:Event.cs.1022"''
|-
| <tt>Buildings</tt>
| <tt>Action playSound {{t|str cueName}}</tt>
| Play the sound or music with the given name.
|-
| <tt>Buildings</tt>
| <tt>Action QiCoins</tt>
| Shows a dialogue which lets the player buy 10 Casino club coins if they have none, else shows how many they have.
|-
| <tt>Buildings</tt>
| <tt>Action Warp {{t|int x}} {{t|int y}} {{t|str area}}</tt>
| Warps the player to the {{t|x}} {{t|y}} tile coordinate in the {{t|area}} game location.<br />''Example: Action Warp Mountain 76 9''
|-
| <tt>Buildings</tt>
| <tt>Action WarpCommunityCenter</tt>
| Warps the player to the inside of the Community Center if they have access (else show an "it's locked" message).
|-
| <tt>Buildings</tt>
| <tt>Action WarpGreenhouse</tt>
| Warps the player to the inside of their greenhouse if they've unlocked it, else shows a message about the greenhouse ruins.
|-
| <tt>Buildings</tt>
| <tt>Action WizardShrine</tt>
| Shows the character customisation menu normally available from the Wizard's tower.
|}

<small>¹ Tile properties are handled throughout the codebase using <tt>GameLocation::doesTileHaveProperty</tt>. Actions and touch actions are handled by <tt>GameLocation::performAction</tt> and <tt>GameLocation::performTouchAction</tt> respectively. Emote IDs are listed as <tt>Character</tt> constants.</small><br />
<small>² The <tt>T</tt> value (short for ''true'') is conventional, but any non-empty value will work too.</small>

==Potential issues==
The game makes some assumptions about maps which may break for modded maps. These are the known issues:
{| class="wikitable"
|-
! affected maps
! issue
|-
| <tt>Farm</tt>
| The farm's <tt>Paths</tt> layer must have at least one tile with index 22 (grass spawn). This is used to initialise the grass code when the save is loaded, even if no grass is spawned.<ref>The grass sound is set in <tt>Grass::loadSprite</tt>, which is called from <tt>GameLocation::loadObjects</tt> if the <tt>Paths</tt> layer has tile index 22. (The game spawns a grass for each such tile, and later removes them.)</ref>
|}

<small><references /></small>

==Paths Tilesheet Explanation==
[[File:PathsExplanation.png|280px]]

Note: The NPC paths tiles do not appear to be used in-game.

[[Category:Modding]]