> For the complete documentation index, see [llms.txt](https://arckytech.gitbook.io/arckys-region-map-guide/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://arckytech.gitbook.io/arckys-region-map-guide/settings-file/ui-settings/map-ui-settings.md).

# Map UI Settings

## Overview

This section offers a few Settings related to changing most common UI elements on the Region Map.

***

Whether you want to expand the Region Map behind the UI (mostly used for UI's that are partly or fully transparant).

```ruby
REGION_MAP_BEHIND_UI = false
```

Possible values:

* `true` = enabled: the Region Map will expand behind the UI (if the Region Map is big enough).
* `false` = disabled.

***

Set for each Region if you want to show the Player Icon on the Region Map.

```ruby
SHOW_PLAYER_ON_REGION = {
  :Essen => true,
  :Tiall => false
}
```

* `:Essen` = Region Name.
  * `true` = Player icon is shown.
* `:Tiall` = Region Name.
  * `false` = Player icon is not shown.

***

Whether you want your Region Map Image to change depending on the current Time in Game.

```ruby
TIME_BASED_REGION_MAP = true 
```

Possible values:

* `true` = enabled: the script will choose the Region Map Image that matches the current Time in Game. (See below for further details on this).
* `false` = disabled: the default Region Map Image will be used.

All you need to do is add either

* Day
* Morning
* Afternoon
* Evening
* Night

at the end of your Region Map Image name. So if your current one is name `Region0.png`, you just got to name it to `Region0Day.png` . The default one should be kept incase you only want a `Region0Night.png` variant. The default one is used in case the variant it was looking for is not found (for ex Day).

***

Whether you want to use the newly added Special Theme.

<pre class="language-ruby"><code class="lang-ruby"><strong>USE_SPECIAL_UI = true
</strong></code></pre>

Possible values:

* `true` = enabled: Uses the Special UI in UI/Special.
* `false` = disabled: Uses the Default UI in UI/Default.

{% hint style="info" %}
I'm not showing any screenshot on how this Special UI looks as it wouldn't be a suprise anymore. Also this Theme can't be used when Lin's PokeGear Themes is used/installed.
{% endhint %}

***

Whether you want to use the Region Map Zoom Feature.

```ruby
USE_REGION_MAP_ZOOM = true
```

Possible values:

* `true` = enabled: The Region Map Zoom Feature can be used.
* `false` = disabled.

***

Set the Zoom Speed when Zooming in/out.

<pre class="language-ruby"><code class="lang-ruby"><strong>ZOOM_SPEED = 100
</strong></code></pre>

Possible value:

* Any number above or below 100.
  * more than 100 is slower speed.
  * less than 100 is faster speed.

***

Choose the button that needs to be pressed to toggle between "Normal Map/Mode" and "Zoom Mode".

```ruby
TOGGLE_ZOOM_BUTTON = Input::CTRL
```

Possible value:

* `Input::CTRL`

{% hint style="info" %}
If you wish to set this to another button, you'll have to make sure this isn't used by any other feature that needs a button to be actived. This is the reason why the Zooming has it's own mode.
{% endhint %}

***

Choose the button that needs to be pressed to Zoom in. (Only used while in Zoom Mode.)

```ruby
ZOOM_IN_BUTTON = Input::JUMPUP
```

Possible values:

* `Input::JUMPUP`
* `Input::JUMPDOWN`
* `Input::SPECIAL`
* `Input::ACTION`

{% hint style="info" %}
Don't set this button to `Input::USE` because the Location Preview (if used) is still Enabled in Zoom Mode. And also don't set this to the same button as Zoom out.
{% endhint %}

***

Choose the button that needs to be pressed to Zoom out. (Only used while in Zoom Mode.)

```ruby
ZOOM_OUT_BUTTON = Input::JUMPDOWN
```

Possible values:

* `Input::JUMUP`
* `Input::JUMPDOWN`
* `Input::SPECIAL`
* `Input::ACTION`

{% hint style="info" %}
Don't set this button to Input::USE because the Location Preview (if used) is still Enabled in Zoom Mode. And also don't set this to the same button as Zoom in.
{% endhint %}