Location Preview

This page will explain you how to set up the Location Preview for each Location on the Region Map.

Overview

The following guide and examples are applyable for both v20.1 and v21.1.

If some parts of examples are confusing to you, try this feature in a new project first and mess around with the settings to see what changes. You can also just ask me either on the Plugin's Discussion page or contact me on Discord.

---

Location Preview

Let's start with a list of all possible parameters the data for each location may contain:

• description: (required) a short description of the location

• icon: (optional) a MiniMap of the location.

• directions (optional) allow you to add to which other locations you can go from this location. They may either be coordinates (like you define a point in the PBS) or text with the name of the location (if you want a different name than from the PBS). Possible directions are:

  • north:

  • northEast:

  • east:

  • southEast:

  • south:

  • southWest:

  • west:

  • northWest:

The parameters will become more clear along with the examples below.

In the 000_Settings_and_Setup folder of this plugin's folder (Arcky's Region Map), you'll find a file called "001_RegionMap_LocationInfo.rb". Open this file with notepad++ or any code editor program.

(Check this page on how to edit the "000_RegionMap_Settings.rb" file.)

This feature is also associated with a lot of Settings which are explained on this page.

---

Example 1

LappetTown = {  
  description: "A fairly old and loud town. It's a big and not so pretty place.",  
  south: [13, 13],  
  north: [13, 11],  
  west: [12, 12],  
  icon: "LappetTown" 
}

Let's break down this piece of data:

• LappetTown => This is the name of the location you are referring to (it's important that this is the same as the Points name in the townmap.txt PBS file but then withouth spaces).

• description: => Contains a string with a short description for this location.

• south: north: west: => each contain an array with an X and Y position ([X, Y]), this will be converted to the location's name with those coordinates from the townmap.txt PBS file. [13, 13] will be converted to "Route 8", [13, 11] will be converted to "Route 1" and [12, 12] will be converted to "Safari Zone".

• icon: => the name of the image that should be used as a "mini map" on the location preview. The image's name is "mapLappetTown.png" (so "map" is not included again in this parameter) and is located in

  • Graphics > Pictures > RegionMap > UI > Default (or Region folder) > LocationPreview > MiniMaps for v20.1

  • Graphics > UI > Town Map > UI > Default (or Region folder) > LocationPreview > MiniMaps for v21.1

Currently you don't need to worry yet what I mean with Region folder, this is an optional Setting. If an image is not found, it'll tell you in the console log to where it expect it to be located.

Result in game:

Example 1

The "???" for 2 out of the 3 directions are because I have the Setting "NO_UNVISITED_MAP_INFO" is set to true. If this setting is false, then you'll see the actual location name, otherwise it's the text you set in the "UNVISITED_MAP_TEXT" Setting. Check this page to learn what these settings do.

As you also might have noticed, you see an arrow icon before each direction, this is automatically done by the script, these icons are located in:

• Graphics > Icons in both v20.1 and v21.1.

If you're wondering why they are located in that folder, that's because the text drawing method expects them to be there as they are drawn as text icons.

---

Example 2

LappetTown = {
  description: "A fairly old and loud town. \nIt's a big and not so pretty place.",
  south: [13, 13],
  north: [13, 11],
  west: [12, 12],
  icon: "LappetTown" 
}

The only difference with Example 1 is in the description: parameter. As you might have noticed, before the second sentence, there's an "\n" (new line) command. This will put this second sentence on a new line.

Result in Game:

Example 2

Other formatting possibilities are:

• <b> ... </b> => Formats the text in bold.

• <i> ... </i> => Formats the text in italics.

• <u> ... </u> => Underlines the text.

• <s> ... </s> => Draws a strikout line over the text.

• <al> ... </al> => Left-aligns the text. Causes line breaks before and after the text.

• <r> ... </r> => Right-aligns the text until the next line break.

• <ar> ... </ar> => Right-aligns the text. Causes line breaks before and after the text.

• <ac> ... </ac> => Centers the text. Causes line breaks before and after the text.

• <br> or </n> => causes a line break.

• <o=X> => Displays the text in the given opacity (0-255)

• <outln> => Displays the text in outline format.

• <outln2> => Displays the text in outline format (outlines more exaggerated).

• <icon=X> => Displays the icon X (in Graphics/Icons/).

---

Example 3

CedolanCity = {
  # location [13, 10]
  northEast_13_10: [14, 9],
  south_13_10: [13, 11],
  # location [14, 10]
  north_14_10: [14, 9],
  southWest_14_10: [13, 11],
  # used for both locations
  east: [15, 10],
  west: [12, 10],
  description_13_10: "The biggest City in Essen. It has a department store!",
  description_14_10: "The biggest City in Essen. It has a department store and what does it not have?",
  icon: "LappetTown" 
}

Let's break down this piece of data:

• CedolanCity => This is the name of the location you are referring to (it's important that this is the same as the Points name in the townmap.txt PBS file but then withouth spaces).

• northEast_13_10:, south_13_10: => like explained on the break down in Example 1, each contain an array with an X and Y position ([X, Y]). What's different here is that "_13_10" specifies on which point of this location this direction information should be used (Since CedolanCity has 2 points). [14, 9] will be converted to "Route 2" and [13, 11] will be converted to "Route 1".

• north_14_10:, southWest_14_10: => Again, like explained above, the "_14_10" specifies on which point of this location this direction information should be used. [14, 9] will converted to "Route 2" and [13, 11] will be converted to "Route 1".

• east:, west: => Once again, each contain an array with an X and Y position ([X, Y]). [15, 10] will be converted to "Route 7" and [12, 10] will be converted to "Route 6".

• description_13_10: => Contains a string with a short description for this location. Just like with the directions "_13_10" specifies on which point of this location this description should be used.

• description_14_10: => Contains a string with a short description for this location. Here again the "_14_10" specifies on which point of this location this description should be used.

• icon: => the name of the image that should be used as a "mini map" on the location preview. The image's name is "mapLappetTown.png" (I just used the same one as example) (so "map" is not included again in this parameter) and is located in

  • Graphics > Pictures > RegionMap > UI > Default (or Region folder) > LocationPreview > MiniMaps for v20.1

  • Graphics > UI > Town Map > UI > Default (or Region folder) > LocationPreview > MiniMaps for v21.1

Result in Game (point 13, 10)

Example 3

Result in Game (point 14, 10)

Example 3

As you might have noticed from these 2 examples, the description for the left point of Cedolan City is a bit different than the one from the right point. Same we can notice for the small arrow icons before "Route 2" and "Route 1". This is thanks to those coordinates we included in the directions and distriptions for the data we added for Cedolan City.

The "???" for 2 out of the 4 directions are because I have the Setting "NO_UNVISITED_MAP_INFO" turned on. If this setting is false, then you'll see the actual location name, otherwise it's the text you set in the "UNVISITED_MAP_TEXT" Setting. Check this page to learn what these settings do.

---

Example 4

Route3 = {
  west_14_6: [13, 6],
  east_14_6: "Ice Cave",
  west_15_6: [13, 6],
  south_15_6: [15, 8],
  south_15_7: [15, 8],
  north_15_7: "Ice Cave",
  description: "A Route full with Trainers.",
  description_15_6: "An Icy Cold Cave located here... And still a lot of Trainers!" 
}

Let's break down this piece of data one more time:

• Route3 => This is the name of the location you are referring to (it's important that this is the same as the Points name in the townmap.txt PBS file but then without spaces).

• west_14_6: , east_14_6: => Just like explained on Example 3, the "_14_6" specifies on which point of this location this direction information should be used (Since Route 3 has 3 points). [13, 6] will be converted to "Ingido Plateau". east_14_6: has a string defined "Ice Cave" so this will be displayed for this direction.

• west_15_6: , south_15_6: => Same as above, "_15_6" specifies on which point of this location this direction information should be used. [13, 6] will be converted to "Ingido Plateau" and [15, 8] will be converted to "Lerucean Town".

• south_15_7: , north_15_7: => Once again, "_15_7" specifies on which point of this location this direction information should be used. [15, 8] will be converted to "Lerucean Town". north_15_7: has a string defined "Ice Cave" so this will be displayed for this direction.

• description: => Contains a string with a short description for this location. This description will be used for all points of this location except for point [15, 6] since it has a specific description defined. In other words, this is the default one unless a specific one for a point is defined.

• description_15_6: => Contains a string with a short description for this location. One more time, the "_15_6" specifies on which point of this location this description should be used. The other points will use the default one (like explained above).

Result in Game (point 14, 6)

Example 4

Result in Game (point 15, 6)

Example 4

There's no screenshot for point 15, 7 since the description is the same as for point 14, 6. The only difference will be the directions, "Ice Cave" to the north and "Lerucean Town" to the south.

The "???" for 1 out of the 2 directions are because I have the Setting "NO_UNVISITED_MAP_INFO" turned on. If this setting is false, then you'll see the actual location name, otherwise it's the text you set in the "UNVISITED_MAP_TEXT" Setting. Check this page to learn what these settings do.