Merge Common Events (YEP)

From Yanfly.moe Wiki
Jump to navigation Jump to search


System

This is a plugin created for RPG Maker MV.

For help on how to install plugins, click here.

For help on how to update plugins, click here.

Got errors with your RPG Maker MV plugin? Click here.

Download

Yanfly Engine Plugins

This plugin is a part of the Yanfly Engine Plugins library.

Click here if you want to help support Team Yanfly on Patreon.

Introduction

For those using complex eventing systems utilizing Labels and Common Events,
you may have noticed that labels in one Common event won't jump to any
labels located in the parent Common Event. This plugin makes it so that
Common Events with the <Merge> tag in their database name will import all
child Common Events ran from it and merge it into the current list as if the
Common Events have consolidated into one. By doing such a thing, Labels
become connected through the parent Common Event and can interact with each
other instead of just of just the Common Event instance itself before.

Name Tags

<Merge>

- Just insert this into any Common Event's name in the database that you
want to merge all child Common Events into. Let's take a look at how this
will make things behave:

---------------
Common Event 1:
---------------
◆Label:Top
◆Common Event: 2
◆Common Event: 3
◆Label:Middle
◆Common Event: 4
◆Jump to Label:Top
◆Label:End

---------------
Common Event 2:
---------------
◆Text:None, Window, Bottom
:    :Merge 1
◆Jump to Label:Middle

---------------
Common Event 3:
---------------
◆Text:None, Window, Bottom
:    :Merge 2
◆Jump to Label:Top

---------------
Common Event 4:
---------------
◆Text:None, Window, Bottom
:    :Merge 3
◆Jump to Label:End

Without <Merge> in the name, the Common Event will go through and display
messages Merge 1 through 3. The Jump to Label events in the child Common
Events are ignored because there's no Labels inside their own Common Event
lists. After that, the event will loop forever over and over.

As a result of adding <Merge> to Common Event 1's name, this is what the
event will run like.

---------------
Common Event 1:
---------------
◆Label:Top
◆Text:None, Window, Bottom
:    :Merge 1
◆Jump to Label:Middle
◆Text:None, Window, Bottom
:    :Merge 2
◆Jump to Label:Top
◆Label:Middle
◆Text:None, Window, Bottom
:    :Merge 3
◆Jump to Label:End
◆Jump to Label:Top
◆Label:End

The event will display the 'Merge 1' message, jump to the 'Middle' label,
display the 'Merge 3', and then jump the 'End' label to close out the event.

WARNING: When using <Merge> be wary of common events that lead back to any
common events that were used earlier, for this may cause an infinite loop
and lock out your game.

Changelog

  • Version 1.00
    • Plugin released!