Location Preview Settings

Settings for the Location Preview Feature on the Region Map.

Table of Contents

Function of the Setting

The Location Preview Settings Section includes various Settings to change the behavior and layout of the Location Preview for a Location on the Region Map.
It allows you to:

  • Set the toggle Button.
  • Modify Layout elements.
  • Add an Offset to the Text elements.
  • Change the Text Colors of elements.

UseLocationPreview

Use this Setting to enable or disable the Location Preview Feature on the Region Map. This does require aditional setup in the 001_RegionMap_LocationInfo.rb. See Location Preview Setup for more information about the Setup.

Possible Values

  • true = The Location Preview can be used.
  • false = The Location Preview cannot be used.

ShowLocationButton

Use this Setting to set which button needs to be pressed to show the Location Preview for a Location on the Region Map.

Possible Values

  • Input::USE = The Game Button.
Hint

Be careful with which button you set this to as it can conflict with another button feature trigger.

CanViewInfoUnvisitedMaps

Use this Setting whether or not you want the Location Preview to be available for Locations that have not been visited yet.

Possible Values

  • true = Location Info of unvisited maps can be viewed.
  • false = Location info of unvisited maps cannot be viewed.

UnvisitedMapInfoText

Use this Setting to set the default Text to display in the Location Preview for Unvisited Locations on the Region Map. This Setting has only effect when CanViewInfoUnvisitedMaps is enabled.

Possible Values

  • Any Default Text for Unvisited Locations.

MaxDescriptionLines

Use this Setting to set the Max Lines of Text the Description in the Location Preview can take up. Adjust the Location Preview Graphics accordingly.

Possible Values

  • Any number above 1.

DescriptionTextOffset

Use these Setting to add a small offset to the X and/or Y Position of the Location Preview Description Text on the Region Map.

Possible Values

The offset value may as well be negative as positive depending on your needs. Only round numbers are allowed.

DescriptionTextColor

Use these Settings to change the main and shadow color of the Location Preview Description Text on the Region Map.

Possible Values

The 3 arguments passed to Color.new() must have a value between 0 and 255 and represent Red, Green and Blue respectivly.

CenterDescriptionText

Use this Setting to whether or not center the Location Preview Description Text on the Region Map. This is mostly the case in combination with an Location Preview Icon.

Possible Values

  • true = The Description Text will be centered vertically when the total line height is smaller than the Icon's height.
  • false = The Description Text will not be centered vertically.

MaxIconHeight

Use this Setting to change the max height a location Icon can take on the Location Preview.

Possible Values

IconOffset

Use these Settings to add a small offset to the X and/or Y Position of the Icon on the Location Preview.

Possible Values

The offset value may as well be negative as positive depending on your needs. Only round numbers are allowed.

CenterIcon

Use this Setting to whether or not center the Location Preview Icon on the Region Map. This is mostly the case in combination with the Location Preview Description Text. This Setting is similar to the CenterDescriptionText Setting.

Possible Values

  • true = The Icon will be centered vertically when the Icon height is less than the total line height of the Description's Text.
  • false = The Icon will not be centered vertically.

DirectionHeightSpacing

Use this Setting to change the vertical space between the Location Preview Description and the Location Preview Direction Text.

Possible Values

  • Any value above 0.
Hint

Just keep in mind that changing this value to a higher value might require the Location Preview Box Graphics to be adjusted so everything still fits in.

DrawDashImages

Use this Setting to whether or not draw a dash line below the Location Preview Description. This is meant as a separator line between the Description and Location Text.

Possible Values

  • true = A Dash line will be drawn.
  • false = A Dash line will not be drawn
Hint

If the DirectionHeightSpacing is lower than the Dash Graphic height, the Dash will not be drawn to prevent covering Text elements.

DashOffset

Use these Settings to add a small ofset to the X and/or Y Position of the Dash Line on the Location Preview.

Possible Values

The offset value may as well be negative as positvie depending on your needs. Only round numbers are allowed.

MaxDirectionLines

Use this Setting to set the Max Lines of Text the Location Direction Text can take up. Adjust the Location Preview Graphics accordingly.

Possible Values

  • Any number above 1.
Hint

The Direction Text is not used if you don't provide this information for a Location.

DirectionTextOffset

Use these Settings to add a small ofset to the X and/or Y Position of the Location Preview Direction Text on the Region Map.

Possible Values

The offset value may as well be negative as positive depending on your needs. Only round numbers are allowed.

DirectionTextColor

Use these Settings to change the main and shadow color of the Location Preview Direction Text on the Region Map.

Possible Values

The arguments passed to Color.new() must have a value between 0 and 255 and represent Red, Green and Blue respectivly.

LocationDirectionSpaces

Use this Setting to adjust the space between each individual item in the Direction Item on the Location Preview.

Possible Values

  • 3 = 3 spaces will be added between each Direction Item in the Location Direction Text.