User Tools

Site Tools


regions

Use Regions as a way to configure some tiles.

What are Regions

Regions are a numbered value set on a map's tile.
Each tile can have a different value from 0 to 255, the default value being 0.

Many plugins make use of regions, not only mv3d.

To change their values, on the map editor, on Map Mode (F5), click on the R tab on the tile selection window.
The tiles selection window will turn into different colored squares with numbers save for the first, 0, which will remain transparent and uncolored.
The map editor itself will become lighter and lose contrast, to make it clear this is not the common mapping mode.
Clicking in any tile it will be colored as the selected region and have its number visible.

 Regions tab on Map Editor

Regions are invisible when on any other tile tab, Event Mode (F6) or during gameplay itself.


Configuring a Tile with a Region

 Example of Region changing heightWhen you put a Region on a tile, any setting of the tiles that can be affected by it are overwritten by the region's settings.

Regions are the top priority of tile settings. Meaning that any other method that changes the same setting would be overwritten.
For example, by default regions 1-8 are set to have heights of 1 to 8, putting that on the ground will make it rise that elevation. A wall, who by default has a height of 3, will on the other hand become lower to reach the height of 1.


What Tiles can a Region affect?

RPG Maker MV

Layers on default Outside tileset

Only A# tiles. But not all of them.

MV has four layers for tiles, but which to use is not chosen by the game developer.
Two, the lower ones, are used by the A# tiles, and the other two by the B-E ones.

Regions only affect the lower layer of the A# tiles.

The A# tiles also have two layers, but there is no way to switch between them.

  • All tiles on A3, A4 and A5 are on the lower layer.
  • Only the left half of the A2 tiles are on the lower layers.
    * Only the right half are set in the upper layer, being set on top of the ones on the lower layer.
  • And A1… only 3 of its tiles are set on the upper layer: the second, third and fourth tiles on the tiles list. Or, in most tilesets, the deep water and the two water decorations.
    They have the vry first tile, normal water tile, automatically set on map under them as on the lower layer, and show it like that on the tiles list, making it is hard to notice this by yourself.
    In other words, regions will affect the tile under them, but not the tiles themselves.

As for B-E, they are not affected by regions.
But to set them in the layers you just set the tiles on the same map tile. The first set will be put on the upper layer, then moved to the lower layer when a second is added in the same position. A third one will remove it, for there is no third layer for them.

RPG Maker MZ

Just like in MV, MV3D (or in this case MZ3D) only affects the first, lowest layer.
The main difference is that you can select what layer a tile will be set to.

The only layer Regions affect, the lowest layer, is Layer 1. Same as in MV. But any tile can be set for Layer 1, not limited anymore to the way it was done in MV.

You need to activelly select the layer you wish to set the tile to.
If you use the default option for mapping layers, “Automatic”, the tiles will be set the same way as in MV.

When you set MZ to map using a specific layer, the other layers will become semi-transparent, allowing you to see what tiles are in the other layers.

With this you can use tiles in a different layer than they would automatically, such as:

  • using the right-side tiles of A2 on Layer 1,
  • B-E tiles on layers 1 or 2,
  • the three A1 tiles that usually go on Leyer 2, and are set to use the first A1 tile on Layer 1, could have a different one under them or even go to A1 themselves,

Basically, any tile could be set to any of the four layers.


Configuring the Regions

There are two ways to set the configurations for a region: through plugin parameters and a special block on the map notetags.

Setting through the plugin parameters will affect every map.
Setting though the map's notes will only afect that map.
If a setting through the map configurations conflicts with a setting through the Plugin Parameters, the map setting will take priority.

Configuring through Plugin Parameters

The Regions' configurations on the plugin parameters are nested inside the Tile Config parameters.

 Plugin Parameter

Clicking on them, you will open a new window, with the tabs Structure List and Text.

 Structure List The Text tab we can ignore. It is for setting the value of the whole parameter by putting a text there, but that is a very advanced way to change the values.
Structure List means this is a List, meaning you can add as many as you need, and the elements on the list are a Structure, meaning each one has more parameters to set inside.
The default list has fifteen(15) elements already set, but you can:

  • remove any you do not want,
  • edit them by double-clicking on one of the values there, or
  • add a new value by clicking in the empty space under the last value (notice how the select area on the screenshot, despite being empty, still has a number on the left side).
    However it is important to remember that, while you can add many values there, the editor itself only sets them on the range of 0-255.

Opening one of the values, be it to edit or create a new one, opens a new window, this time with the tab Structure instead of Structure List. Regionss' Structure These are, basically, parameters, similar to Plugin Parameters but limited to that element of the list. The Regions' structure has two Values to set:

  • Region Id: the number of the Region the setting is for. As mentioned before, they can go from 0 to 255, 0 being the default.
  • Configuration Functions: the actual settings you are configuring for that Region.
    Set them the same way as configuring the tiles in the Database's Tileset tab, but keep in mind it will be applied to all tiles regions work on, regardless of tileset.

Configuring through Map Notetags

To set a region's configuration to affect only that specific map in that way, you will need to use a notetag block.
It is a similar notetag block to the one mv3d uses for map configurations, but it is a <mv3d-regions></mv3d-regions> block instead.
Or a <mz3d-regions></mz3d-regions> block, if using MZ3D.

Inside the block, in each line use:

(id of region to affect): (configuration for the region)
<mv3d-regions>
  id: configuration
  id: configuration
</mv3d-regions>

<mz3d-regions>
  id: configuration
  id: configuration
</mz3d-regions>

You can use it and the usual <mv3d>/<mz3d> block on the same mapwith no problems, but do not forget to keep them separate.

Example:

<mv3d>
ceiling(A1,0,0,3)
</mv3d>

<mv3d-regions>
12: ceiling(B,1,1,2,2|1)
13: ceiling(+1,+1),top(B,+1,+1)
</mv3d-regions>
regions.txt · Last modified: 2021/04/13 22:17 (external edit)