Skip to content

TyruswooStudio/Tyruswoo_MapProperties-MZ

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

16 Commits
 
 
 
 
 
 

Repository files navigation

Tyruswoo Map Properties for RPG Maker MZ

Region movement restrictions and allowances for the player and events!

Also, use switches to control the parallax background and/or music of maps!

Plugin commands

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

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.)

Properties of each Parallax Switch:

  • 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 or 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.)

Properties of each Background Music Switch:

  • 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.

Region Restrict All

A list of region IDs that act as walls. No player or event can pass through, unless their "Through" property is on.

Region Restrict Player

A list of region IDs that players cannot pass through. Events may still pass through, if tiles permit.

Region Restrict Events

A list of region IDs that events cannot pass through. Players may pass, if tiles permit.

Region Allow All

A list of region IDs that players and events may freely pass through, even if the contained tiles would not normally be passable.

Region Allow Player

A list of region IDs that players can always pass through. No passability change for events.

Region Allow Events

A list of region IDs that events can freely pass through. Players are still subject to normal tile passability in these regions.

Example Use Cases

  • Make a different parallax appear in the same map, based on whether a certain switch is 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.)
  • Make a hidden path. Add a region number to the Region Allow Player list in the plugin parameters, and then paint that region anywhere that you want to place the hidden paths.
  • Keep NPCs out of the way in a specific area. Find the plugin parameter Region Restrict Events, add a region number to its list, and paint that region wherever you need to block NPCs from passing while allowing the player to pass.

Visit Tyruswoo.com to ask for help, donate, or browse more of our plugins.

Version History:

v1.0 - 10/9/2020

  • Map Properties released for RPG Maker MZ!

v2.0 - 10/22/2021

  • Introduced region-based passability restrictions and allowances.

v2.0.1 - 8/30/2023

  • This plugin is now free and open source under the MIT license.

v2.0.2 8/8/2024

  • Region list plugin parameters now only use positive integers. Zero, negative numbers, and other invalid values are ignored. This fixes the bug where someone might put a 0 in a list by mistake and cause undesired effects in the default empty region.

v2.1.0 8/9/2024

  • Made Tyruswoo Map Properties compatible with Tyruswoo Altimit Movement v0.9.2 and up.
  • Game_Map's isPassable function now checks Region Restrict All and Region Allow All lists. This may make region-based passability apply more consistently in some edge cases.

Remember, only you can build your dreams!

Tyruswoo