Message Backlog (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

Required Plugins

The following plugins are required in order to use this plugin.

Place the following plugins above this plugin located in the Plugin Manager.

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

This plugin requires the following plugins:
- YEP_MessageCore

* Note: If you have any Extended Message Pack plugins from the YEP library,
place this plugin under those entries in the plugin list.

It's not uncommon for RPG's to have a message backlog, an in-game tool for
the player to review any and all dialogue he/she has encountered previously.
This tool can be helpful in case a player would accidentally skip some
dialogue and/or would like to revisit what kind of messages were made before
making a decision during an important moment.

This plugin creates a message backlog system for your game's message system.
Upon pressing 'Shift' (or any other button you desire) during a message, the
player can open up a Backlog window to review over the last 20 encountered
messages (number of stored messages can be modified within the parameters).
These saved messages can also include any choices from the choice lists they
have selected, any numbers they may have inputted, or items they selected
from special events.

Now, your players can go forward, knowing full well they have little to
worry about in case they've missed any messages.

Disabled Text Codes

Due to the nature of some text codes, some of them are disabled for the
message log. Most of the default RPG Maker MV text codes will work, but some
custom ones added through the Message Core or Extension Packs are disabled
for various reasons. Here is a list of those disabled message codes:

   RPG Maker MV Default:
   \{          Changes to font sizes cause errors in the backlog.
   \}          Changes to font sizes cause errors in the backlog.

   Message Core:
   \AF[x]      Face graphics aren't displayed in the backlog.
   \PF[x]      Face graphics aren't displayed in the backlog.
   \FS[X]      Changes to font sizes cause errors in the backlog.

   \PY[X]      While this works, it is known to cause some problems.

   Extended Message Pack 1:
   \LSON       Letter sounds are disabled for the backlog.
   \LSOFF      Letter sounds are disabled for the backlog.
   \LSR        Letter sounds are disabled for the backlog.
   \FACEINDEX  Face graphics aren't displayed in the backlog.
   \MSGPOSX    Backlog does not change message window size.
   \MSGPOSY    Backlog does not change message window size.
   \MSGEVENT   Backlog does not change message window size.
   \MSGACTOR   Backlog does not change message window size.
   \MSGPARTY   Backlog does not change message window size.
   \MSGENEMY   Backlog does not change message window size.
   \AUTOEVENT  Backlog does not change message window size.
   \AUTOACTOR  Backlog does not change message window size.
   \AUTOPARTY  Backlog does not change message window size.
   \AUTOENEMY  Backlog does not change message window size.
   \MSGROWS    Backlog does not change message window size.
   \MSGWIDTH   Backlog does not change message window size.
   \AUTO       Backlog does not change message window size.
   \MSGRESET   Backlog does not change message window size.

   Extended Message Pack 2:
   - Quantity, Actor, and Enemy text codes will be converted before added.
   This is so the data made will be localized instead of current.

Plugin Commands

PluginCommandsMV.png

Plugin Commands are event commands that are used to call upon functions added by a plugin that aren't inherently a part of RPG Maker MV.

Here is a list of Plugin Command(s) that you may use:

The following plugin commands can be used to alter various settings
regarding the Message Backlog.

Plugin Command:

  EnableMessageBacklog
  DisableMessageBacklog
  - This enables/disables the message backlog from being playeraccessed.

  EnableMessageLogging
  DisableMessageLogging
  - If enabled, new messages will be recorded to the backlog.
  If disabled, they won't be recorded.

  OpenMessageBacklog
  - This will forcefully open the message backlog if done on the map scene.
  (Highly recommended to be used with Button Common Events)

Changelog

Version 1.01:
- Message Backlog now removes more text codes regarding Letter Sounds.

Version 1.00:
- Finished Plugin!