EST - RegionMapLoader

estriole · November 27, 2015

â– Information      â•’â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•›
EST - RegionMapLoader
Version: 1.0
By Estriole
File name: EST_RegionMapLoader.js

â– Introduction     â•’â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•›
    Replace map data you mark with region with other map data.
usefull if you want to transform part of the map...

â– Extra Credit     â•’â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•›
person other than me (Estriole) that you should credit in your project
if you use this plugin

- Formar => for part of the idea from his REGIONMAPLOADER from ACE.
              (i only reference some of the idea from his script. not all Idea is from his script)

â– Features         â•’â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•›
- mark your map with region then swap the data on it from other map

â– Changelog       â•’â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•›
   v1.0 2015.11.16           Initial Release

â– Plugin Download â•’â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•›
Download
Demo Use same demo with build and decor series

â– Screen Shotâ•’â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•›

â– How to use â•’â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•›

open spoiler... if after reading it you still confused... see the demo .

or post here and ask question. i will answer as soon as i can.

(i can guarantee fast enough though... currently power line in my town got damaged by storm. and we got

[24h blackout 6h electricity] cycle... it will be like this for 3 weeks >.<).

1) create your base map... (map you want to swap the data to)
2) create your reference maps... it's better if it have the same size / layout with your first map.
    the map MUST have the coordinate you want to reference. ex: if you make base map coordinate [10,10]
    replaced with reference map. the reference map MUST have [10,10] coordinate!!!!
3) mark your first map (base map) with regions... example: region 21, 22, and 23.
    which you want the part to change to reference map.
4) create your event which will change the region map data.
using this:
Plugin command:

update_region_map regionId refMapId

ex: update_region_map 21 7

will replace region 21 data with map 7 data.
ex: update_region_map 21 null

will revert region 21 to default map data

or Script Call:

this.updateRegionMap(regionId,refMapId)

ex: this.updateRegionMap(21,7)

will replace region 21 data with map 7 data.
ex: this.updateRegionMap(21,null)

will revert region 21 to default map data

5) AFTER you plugin command or script call from no. 4.
you must call this to UPDATE your map (or else it won't be updated)
Plugin command:

process_update_region_map fadetype

ex:

process_update_region_map 2

will update the region data and using transfer transition 2
ex: process_update_region_map

if you don't set parameter for fadetype. it will use what you set default on plugin parameter

or Script Call:

this.updatingRegionMap(fadetype)

ex: this.updatingRegionMap(2)

will update the region data and using transfer transition 2
ex: this.updatingRegionMap()

if you don't set parameter for fadetype. it will use what you set default on plugin parameter
fadetype -> 0 = Black, 1 = White, 2 = No Fade.

this updating is actually teleporting to same map with same coordinate.
(so it 'might' not compatible with plugins which call common event on transfer
since it might call that common event when calling this update method...)
i might change this method later to actually erase tilemap and recreate tilemap.
but for now this is sufficient.

â– Dependencies â•’â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•›
None Known So Far...

â– Compatibility â•’â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•›
I'm new in JS... and MV is new engine... so i cannot say for sure.
but it should be compatible with most things.

FOR NOW... NOT COMPATIBLE WITH BROWSER ONLINE GAME.

until i manage to patch it later >.<

â– Parameters       â•’â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•›
> DefaultUpdatingRegionMapTransition
default: 0
desc: when updating region map. use this transitions.
        0 -> black, 1->white, 2->none

â– License          â•’â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•›
Free to use in all project (except the one containing pornography)
as long as i credited (ESTRIOLE).

â– Support          â•’â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•›
While I'm flattered and I'm glad that people have been sharing and
asking support for scripts in other RPG Maker communities, I would
like to ask that you please avoid posting my scripts outside of where
I frequent because it would make finding support and fixing bugs
difficult for both of you and me.

If you're ever looking for support, I can be reached at the following:
[ www.rpgmakervxace.net ]
pm me : estriole

â– Author's Notes   â•’â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•â•›
Originally i want to Convert Formar Region Map Loader
from ACE to MV. but i need to rewrite most of it because
the difference between ACE and MV. so just credit him for
part of the idea.

This also part of EST - Decor And Build Series