Location Preview Settings

Overview

This sections offers a lot of Settings related to the Location Preview.

Whether you want to use the Location Preview Feature.

USE_LOCATION_PREVIEW = true

Possible values:

  • true = enabled: This Feature can be used.

  • false = disabled: all Settings below will not be used.

Choose the button that needs to be pressed to show the Location Preview of the current Location.

SHOW_LOCATION_BUTTON = Input::USE

Possible values:

  • Input::JUMPUP

  • Input::JUMPDOWN

  • Input::SPECIAL

  • Input::AUX1

  • Input::AUX2

Be careful with which button you have set for the Changing Mode and Changing Region. You can set this the same button as you set for Quick Fly since this Location Preview Feature can only be used on the Normal Map Mode.

Whether you can trigger the Location Preview if the Location hasn't been visited yet. (This Setting has no effect if NO_UNVISITED_MAP_INFO is set to false). 

CAN_VIEW_INFO_UNVISITED_MAPS = true

Possible values:

  • true = enabled: the Location Preview can be triggered for Unvisited Locations.

  • false = disabled: You can only trigger the Location Preview for Visited Locations.

If the Setting above is set to true, this Setting can be used to set what text to show if the Location hasn't been visited yet.

UNVISITED_MAP_INFO_TEXT = _INTL("No information Available")

Possible value:

  • any "text" you want inside _INTL("").

Set the max lines the Location Description can take.

MAX_DESCRIPTION_LINES = 3

Possible value:

  • any number above 1.

The Location Preview Graphics are numbered by the amount of lines they are meant for, if you change this to a higher number then make sure you have a bigger Graphic.

Add an offset to the X and Y position used for the Location Description Text.

DESCRIPTION_TEXT_OFFSET_X = 0
DESCRIPTION_TEXT_OFFSET_Y = 0

Possible value:

  • Any number (can be negative too).

Keep in mind that the Icon, Dash Line and Direction Text's Y Positions are all calculated on the Y Position of the Location Description Text.

Change the Color used for the Location Description Text.

DESCRIPTION_TEXT_MAIN = Color.new(248, 248, 248)
DESCRIPTION_TEXT_SHADOW = Color.new(0, 0, 0)

Possible value:

  • 3 numbers between 0 and 255

Just like with the Text Color settings, you can use a tool like this to convert the Color you want to the correct RGB values

Whether the Location Description Text should be centered vertically when it's smaller in lines than the Map Icon (if used.

CENTER_DESCRIPTION_TEXT = true

Possible values:

  • true = enabled: the Location Description Text will be centered vertically.

  • false = disabled.

2 lines with a lineheight of 32px each would be smaller than an Icon of 96px height. So the Location Description Text will be adjusted by 16px vertically.

Set the max height of a Location Icon can take.

MAX_ICON_HEIGHT = 96

Possible values:

  • the number equal to PREVIEW_LINE_HEIGHT * MAX_DESCRIPTION_LINES

Add an offset to the X and Y position used for the Location Icon.

ICON_OFFSET_X = 0
ICON_OFFSET_Y = 0

Possible values:

  • any number (can be negative too

Whether the Location Icon should be centered vertically when it's smaller than the Location Description (in lines). (Similar to CENTER_DESCRIPTION_TEXT Setting)

CENTER_ICON = true

Possible values:

  • true = enabled: the Location Icon will be centered vertically.

  • false = disabled.

Set the spacing between the Location Description and the Location Direction Text.

DIRECTION_HEIGHT_SPACING = 16

Possible values:

  • any number above 0

Whether you want to have a Dash Line drawn between the Location Description and the Location Direction Text.

DRAW_DASH_IMAGES = true

Possible values:

  • true = enabled: there will be a Dash Line drawn between the Location Description and the Location Direction Text using the mapLocationPreviewDash.png image.

  • false = disabled.

You can change the Width, Height and Color of this image to your preferences. If the DIRECTION_HEIGHT_SPACING is set to a value lower than the Dash Image Height, the Dash Line will not be drawn to avoid covering the Text above and below.

Add an offset to the X and y position of the Dash Line.

DASH_OFFSET_X = 0
DASH_OFFSET_Y = 0

Possible value:

  • Any number (can be negative too).

Set the max lines the Location Directions can take.

 MAX_DIRECTION_LINES = 2

Possible value:

  • Any number above 0

There's no Setting to turn of the Location Directions but if you don't provide any Direction Information, it'll not adjust the Preview Box Height and the Dash Line will also not be used.

Add an offset to the X and Y position used for the Location Direction Text.

DIRECTION_TEXT_OFFSET_X = 0
DIRECTION_TEXT_OFFSET_Y = 0

Possible value:

  • Any number (can be negative too).

Change the Color used for the Location Direction Text.

DIRECTION_TEXT_MAIN = Color.new(248, 248, 248)
DIRECTION_TEXT_SHADOW = Color.new(0, 0, 0)

Possible value:

  • 3 numbers between 0 and 255

Just like with the Text Color settings, you can use a tool like this to convert the Color you want to the correct RGB values

Set the amount of Spaces between each direction for a Location should be used.

LOCATION_DIRECTION_SPACES = 3

Possible value:

  • any number above 0.

PreviousButton Preview SettingsNextExtended Preview Settings

Last updated