Map UI Settings

Map UI Settings on the Region Map.

Table of Contents

Function of the Setting

The Map UI Settings Category includes various Settings related to the UI behavior of the Region Map.
It allows you to:

  • Expand the Region Map behind the UI.
  • Show or Hide the Player by Region.
  • Add Time based Region Maps.
  • Use a Special Designed UI.

RegionMapBehindUI

Use this Setting to enable or disable the expanding of the Region Map behind the UI.

Possible Values

  • true = The Region Map will be expanded behind the UI.
  • false = The Region Map will not be expanded behind the UI.
Hint

2 things to keep in mind:

  • Your Region Map needs to be at least 512x384 instead of 480x320 in size.
  • Make sure there are no locations closer than 2 tiles (or 3 when CursorMapOffset is enabled) to the edge of the Region Map as it'll be unreachable by the cursor.

ShowPlayerOnRegion

Use this Setting to specify if the Player Icon should be shown on the Region Map.

Possible Values

  • Essen: true = The Player Icon will be shown for the Essen Region.
  • Tial: false = The Player Icon will not be shown for the Tial Region.
Hint

You only need to add your Region to this Setting you want to hide the Player for a specific Region.

TimeBaseRegionMap

Use this Setting if you want the Region Map to change depending on the in Game Time.

Possible Values

  • true = A Time Specific Region Map Graphic will be used.
  • false = Default Region Map Graphic will be used.

These are the supported naming:

  • mapRegion(ID)Morning
  • mapRegion(ID)Day
  • mapRegion(ID)Afternoon
  • mapRegion(ID)Evening
  • mapRegion(ID)Night
Hint

The script will fallback to mapRegion(ID)Day if no speficer one is found. And to mapRegion(ID) (default one) if none at all is found. You'll be notified in that case with a message in the console.

UseSpecialUI

Use this Setting to enable or disable the usage of the UI Graphics in the ui/special folder.

Possible Values

  • true = The Special UI will be used.
  • false = The Default UI will be used.
Hint

This Special UI also has some unique elements in the Extended Location Preview. If you want to have these unique elements for you own designed UI, place your Graphics in the Special folder instead of the Default folder.