This is an old revision of the document!
This tutorial demonstrates how to link one map to another (for example, linking a dungeon entrance tile in a wilderness map to a separate dungeon map) with the use of a simple script. Generally, a hand-written script is the quickest and most convenient approach for this common type of scenario, however this guide will cover both the quick script method and the alternate approach of creating a visual script in the Script Editor.
You can now also use the “Link with Map” shortcut available from the Map Editor's right-click menu to easily generate quick scripts. To do so, select a tile in one map, then right-click the destination tile in the other map and choose “Link with Map” from the popup menu.
1) Open the destination map that you'd like to link to in the Map Editor and switch into “Edit” mode. In this example, I will be linking to a dungeon map.
2) Locate the the target tile that you want the player to be positioned on after the map has loaded (in this case, the stairs), then right-click on the tile and select “Copy (X,Y,Z) Coordinate” from the popup menu. This will copy the coordinate of the selected tile onto your system's clipboard to be used in a later step.
3) At this point, we are going to create the script that will link the wilderness map to the dungeon map. I'd recommend learning how to write small scripts like this by hand, but you can skip ahead to step 9 if you'd prefer to only see the visual script approach. Otherwise, continue to the next step.
4) Open the map you will be linking from (the wilderness map) in the Map Editor and locate the tile that should trigger the destination map to be loaded when the player steps onto it. Using our example, this would be the dungeon entrance tile. Right-click on this tile and select “Properties” from the popup menu.
5) Select “Quick Script” from the Script dropdown box, then click the pencil icon to start editing the script in the Quick Script Builder.
6) In the palette list on the left, double-click the Load Map function to add it to the script. You will want to change the function parameters (map name, XYZ coordinate, and player direction) to the desired values. For the coordinate, you can highlight the default value of “coord[0, 0, 0]” and press Ctrl+V to paste in the target coordinate that you copied earlier.
7) Click OK to close the Quick Script Builder, then close the Properties dialog. If markers are enabled in the Map Editor, you'll see a marker icon () appear over the selected tile indicating that there is now a quick script attached to the tile.
8) I will also demonstrate how to visually create the same script using the Script Editor. If you've already completed the quick script approach, you can still follow along to learn, or skip ahead to step 12 if you'd prefer.
9) Click the “New Resource” button () on the Game Explorer toolbar. Select “Script” for the type, then enter a name for the script (for example, “load_dungeon”) and click OK.
10) Find the Load Map item in the function list on the left and double-click it to add it to your visual script. Then click and drag from the output connector of the “Start” node to the input connector on the left side of the newly added Load Map node. Select the destination map from the dropdown box then click the “Paste Coordinate” button () to paste in the target coordinate that you copied earlier. You can optionally choose a direction for the player to be facing once the map is loaded. Save the script once you are finished.
11) Open the map you will be linking from (the wilderness map) in the Map Editor and locate the tile that should trigger the destination map to be loaded when the player steps onto it. Using our example, this would be the dungeon entrance tile. Right-click on this tile and select “Properties” from the popup menu, then select the script that you just created from the “Script” dropdown box and close the dialog.
If markers are enabled in the Map Editor, you'll see a marker icon () appear over the selected tile indicating that there is now a script attached to the tile.
12) Save the map, then follow the same procedure to make the reverse connection (for example, linking from the stairs in the dungeon back to the entrance in the wilderness map). The player will now be able to traverse back and forth between the two maps!