Map Properties Plugin v1.0.1 for MZ

Hello RPG Makers!

I’m excited to present to you a new plugin by Tyruswoo! The Map Properties plugin allows more flexibility in using parallax backgrounds and in background music. This plugin will help you:

• Change what parallax background is used on maps based on what switches are.
• Change what background music plays on maps based on what switches are on.
• Keep the same parallax scrolling position even when transferring between different maps! This allows for smoother transitions in maps that use the same scrolling parallax background.

1. Download the file, and unzip it.
2. Make sure the unzipped file is named Tyruswoo_MapProperties.js and is saved as a .js file.
3. Open the file folder of your project. Place the file in your project’s “js” folder, within the “plugins” folder.
4. Open your project in RPG Maker MZ, then go to the Tools menu and select Plugin Manager. Use the Plugin Manager to add and activate the plugin.
5. I recommend you place this plugin toward the bottom of your plugin list, so it has high priority.

This is useful for transferring between maps that (1) use the same parallax background and (2) have the parallax background scroll.

Without this plugin, when the player goes to the next map, the parallax background will jump back to the default position. By saving a loading parallax positions, the parallax background will be in the same position on the new map that it was right before the player left the old map. This makes for smoother transitions between similar maps.

The heroes prepare to ascend the Stairway to the Cosmos!

Both the Witch’s House and the Cosmos maps have the same Parallax Background properties. Both use the Space image, loop both horizontally & vertically, and scroll both horizontally & vertically.

An example of how to use the Save Parallax Position and Load Parallax Position plugin commands. With this setup the moving stars in the space background will be in the same position when the heroes leave the Witch’s House map and enter into the Cosmos map.

RPG Maker allows changing the Parallax Background with Change Parallax. This is immediate and temporary. When the player leaves and re-enters the map, the background parallax will return to the default set on the Map Properties window. 

The Map Properties plugin allows for changing the Parallax Background based on switches and will remain in effect until the switch is turned off (or permanently if the switch is never turned off). This takes place when the player loads the maps. 

Change Parallax and Map Properties plugin can be used together to instantly change the background and to make sure the change sticks. This is shown in the example below.

The beautiful Land of the Sky.

Oh no! Here comes the Storm King!

To change the Parallax Backgrounds with the Map Properties plugin, we need to remember two things from the Map Properties window. First, the map ID (10). Second, the image used in the Parallax Background (Clouds).

Next, we need to set up the parameters in the Plugin Settings. Default Parallax should be set to match the Map Properties of affected maps (Clouds). Switch is whatever switch you want to change the background (2). Alternate Parallax is whatever you want the background to change to (DarkClouds). Affected Maps can be set to affect whatever maps you want (7, 10, 11).

Simple event that puts the Parallax Background changes into effect! Control Switches : #0002 Storm = ON will cause the Alternative Parallax named in the plugin parameters (DarkClouds) to load on all the affected maps (7, 10, 11) instead of the default parallax (Clouds) every time the player enters one of those maps.

Just turning the switch on will not affect the current map until the player reloads it. Since I wanted the current map (10) to be immediately changed, I used Change Parallax: DarkClouds. This is shown in the blue box of the previous picture. Change Parallax is only temporary. Without the Map Properties plugin, the background would revert back to normal if the player reloaded the map.

Other maps specified in the Plugin Parameters (7, 10, & 11) were also affected by parallax background change. The new parallax backgrounds will stay in effect forever on the player’s game unless the switch is turned off. Perhaps if the villainous Storm King was stopped the Land of the Sky would return to normal…

Map Properties Plugin v1.0
For RPG Maker MZ
By Tyruswoo
==========
Plugin commands, their arguments, and short explanations:
Save Parallax Position
- Save the current location of scrolling of the parallax. (Parallax background must exist, and map must be using the Loop Horizontally and/or Loop Vertically feature with a scroll value other than 0, in order for this plugin command to do anything.) This is not included in player save files.
Load Parallax Position
- Load the location of scrolling of the parallax, from the most recently saved parallax location.
==========
Plugin parameters, their arguments, and short explanations:
Parallax Switch
- A list of alternative parallaxes to be used when certain switches are on. (Later in list takes precedence if the same default parallax is used multiple times.)
Default Parallax
- The name of the parallax image, as listed in the map's Parallax Background image selection. (Do not include file extension.)
Switch
- Switch ID number for the switch that must be On for the alternative parallax to be used instead of the default parallax.
Alternative Parallax
- The name of the alternative parallax image to use when the switch is On. (Do not include file extension.)
Affected Maps
- Select which maps will be affected by this parallax alternative. By default, all maps are affected. Other options include affecting all maps except certain selected maps, or affecting only the selected maps.
Selected Maps
- Choose which maps will have special rules applied for this parallax alternative.
Background Music Switch
- A list of alternative background musics to be used when certain switches are on. (Later in list takes precedence if the same default music is used multiple times.)
Default Music
- The name of the map's default background music (Autoplay BGM) as found in the map properties.
Switch
- Switch ID number for the switch that must be On for the alternative background music to be used instead of the default background music.
Alternative Music
- The name of the alternative background music to use when the switch is On. (Do not include file extension.)
Affected Maps
- Select which maps will be affected by this background music alternative. By default, all maps are affected. Other options include affecting all maps except certain selected maps, or affecting only the selected maps.
Selected Maps
-Choose which maps will have special rules applied for this background music alternative.
==========
Example features:
- Make a different parallax appear in the same map, based on whether a certain switch in On. This can be done by changing the Parallax Alternative plugin parameter.
- Keep the same parallax scrolling position even when transferring between maps! Use the Save Parallax Position plugin command just prior to player transfer and the Load Parallax Position plugin command immediately after player transfer; this allows the new map's parallax background to be at the same point of scrolling as the previous map's parallax background. (This is useful if the maps both have a parallax image and both use Loop Horizontally and/or Loop Vertically with a scroll value greater than or less than 0.)
==========
For more help using the Map Properties plugin, see Tyruswoo.com.
==========
Version History:
v1.0 10/9/2020
- Map Properties released for RPG Maker MZ!
==========
Remember, only you can build your dreams!
-Tyruswoo

Big thanks to Tyruswoo for making another great plugin!

Lawenia