Extended Message Functionality VisuStella MZ

From Yanfly.moe Wiki
Jump to navigation Jump to search

Welcome to the wiki! This is where you can find resources from Yanfly.moe, Ækashics.moe,
VisuStella, Caz Wolf, Fallen Angel Olivia, Atelier Irina, and other affiliated content creators.



Download

System

This is a plugin created for RPG Maker MZ.

Click here for help on how to install plugins and an explanation on the Tier Hierarchy System.


UpdatePlugins.png

Click here to learn how to update plugins.


Troubleshooting.jpg

Click here for how to troubleshoot plugins if you get an error.



ExtMsgFunc Animated.gif

Featuring upcoming VTuber Almadeia Ciana

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.


VisuStella MZ

This plugin is a part of the VisuStella MZ Plugin Library.


Support VisuStella

Click here if you want to help support VisuStella on Patreon.


Introduction

ExtMsgFunc Animated.gif

The Extended Message Function plugin adds onto RPG Maker MZ's Message Window and adds in various features you would normally see found in modern RPG's. Things like automatically moving the text forward after a set amount of time or fast forward are available. Saving and loading during a message is also possible as well as going to the Options menu or returning back to the title screen. These options are only available to the Message Window on the map scene and do not work in battle.

Features include all (but not limited to) the following:

  • The Button Console appears on the Message Window let the player activate various commands via touch/click.
  • Extended Fast Forward Mode is an expanded feature upon the Message Core's Fast Forward function to fast forward all events and not just messages. This can be optionally disabled.
  • A Message Cursor will appear where the text has ended for those who want that kind of aesthetic in their game.
  • Auto-Forward will automatically move messages onward after a certain amount of time has passed. Time required will be determined based on the length of the message in question.
  • Saving and Loading can be done from the Message Window akin to how many visual novels work. Requires the Save Core, but you're already using that, right? Right?
  • Also be able to jump straight into the Options scene from the Message Window to change any settings on the fly. Requires the Options Core, but you're using that, too, correct?
  • And for those who want to jump back to the title screen, they can do so by selecting a Game End option, too.

Requirements

This plugin is made for RPG Maker MZ. This will not work in other iterations of RPG Maker.

Required Plugin List

This plugin requires the above listed plugins to be installed inside your game's Plugin Manager list in order to work. You cannot start your game with this plugin enabled without the listed plugins.


Tier 2

This plugin is a Tier 2 plugin. Place it under other plugins of lower tier value on your Plugin Manager list (ie: 0, 1, 2, 3, 4, 5).

This is to ensure that your plugins will have the best compatibility with the rest of the VisuStella MZ Plugin library.


Extra Features

ExtMsgFunc Animated.gif

There are some extra features found if other VisuStella MZ plugins are found present in the Plugin Manager list.

---

Options Core VisuStella MZ

The Options Core is a required plugin in order to make use of the "Options" (aka "Config") button found in the Button Console.

---

Save Core VisuStella MZ

The Options Core is a required plugin in order to make use of the "Save" and "Load" buttons found in the Button Console.

---

Message Log VisuStella MZ

The Message Log plugin enables the "Log" button found in the Button Console to let the player go and review the text that has been displayed in the map scene. This does not include the text found in battle to avoid conflicting logged messages across different situations.

---

Message Visibility VisuStella MZ

The Message Visibility plugin enables the "Hide" button found in the Button Console to make the Message Window visible or invisible.

---

Text Codes

ShowTextWindowMZ.png

Text Codes are used in the Show Text event command. They are used to display things that text normally can't produce on its own, such as colors, get the name of a specific actor, change icons, and more.

RPG Maker MZ already comes with text codes of its own:

\V[n] Will be replaced with the value of the nth variable.
\N[n] Will be replaced with the name of the nth actor.
\P[n] Will be replaced by the name of the nth (arranged order) party member.
\G Will be replaced by the currency unit.
\C[n] Draw the subsequent text in the nth color. Text color conforms to the contents of the [Window.png] system image.
\I[n] Draws the nth icon.
\FS[n] Changes the text font size to 'n'.
\{ Increases the text by 1 step.
\} Decreases the text by 1 step.
\\ Replaced with the backslash character.
\$ Open the gold window.
\. Wait for 1/4 second.
\| Wait for 1 second.
\! Wait for button input.
\> Display remaining text on same line all at once.
\< Cancel the effect that displays text all at once.
\^ Do not wait for input after displaying the next.


The following are text codes that you may use with this plugin.

Button Console-Related Text Codes

ExtMsgFunc Animated.gif

---

--------------------   -----------------------------------------------------
Text Code              Effect (Message Window Only)
--------------------   -----------------------------------------------------

<Hide Buttons>         Hides the Button Console from this current Message
                       Window's text assuming that nothing else is hiding
                       the Button Console from view.

---

Plugin Commands

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

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

---


The following are Plugin Commands that come with this plugin. They can be accessed through the Plugin Command event command.

---

Fast Forward Plugin Commands

ExtMsgFunc Animated.gif

ExtMsgFunc Commands1.png

---

Fast Forward: Allow/Disallow
- Change whether or not Fast Forward is allowed/disallowed.
- Must be enabled by the Plugin Parameters.

  Allow?:
  - Allow or disallow the Extended Fast Forward feature?
  - Must be enabled by the Plugin Parameters.

---

Message Button Console Plugin Commands

ExtMsgFunc Commands2.png

---

Message Button Console: Show/Hide
- Determine if the Message Button Console is visible or hidden.
- Only appears on the map.
- Does not appear in battle.

  Visible?:
  - Show or hide the Message Button Console feature?
  - Only appears on the map.
  - Does not appear in battle.

---

Message Cursor Plugin Commands

ExtMsgFunc Commands3.png

ExtMsgFunc Commands3a.png

---

Message Cursor: Change Settings
- Change the Message Cursor settings used.

  Change Settings:
  - Change the Message Cursor settings.
  - Settings are the same as the ones found in the Plugin Parameters.

---

Plugin Parameters

Auto-Forward Settings

ExtMsgFunc Params1.png

Auto-Forward settings used for this game. Auto-Forward is a feature that once enabled, the game will automatically move the "Show Text" event commands forward after a certain amount of time. The amount of time will be determined by how many characters are displayed on the screen. There is a lower boundary, where if the wait time does not meet the amount, the timer will be set to the minimum wait value instead.

---

Settings

  Wait per Character:
  - How many frames should the game wait per character?
  - Average: 60 frames per second.

  Minimum Wait:
  - What is the minimum amount of frames to wait?
  - Average: 60 frames per second.

---

Fast Forward (Extended) Settings

ExtMsgFunc Params2.png

Extended Fast Forward settings used for this game. If enabled, this will replace the Message Core's Fast Forward functionality. The Extended Fast Forward feature will not only fast forward through messages but any running events that are not found in a parallel event.

It can also be activated the Message Core's Fast Forward shortcut key.

---

Settings

  Enable?:
  - Enable or disable the Extended Fast Forward feature?

  Speed:
  - What is the speed at which Extended Fast Forward works at?
  - Higher numbers are faster.

---

Message Button Console Settings

ExtMsgFunc Animated.gif

ExtMsgFunc Params3.png

Message Button Console settings used for this game.

It will only appear in the Message Window on the map scene. It will NOT appear in battle. The reason it won't appear in battle is because many of the functions there will clash with how the battle scene behaves.

The Button Console will add extra padding to the Message Window and appear at either the top of bottom of the Message Window (your choice). A row of buttons will appear each with a different functionality.

These Plugin Parameters also allow you to customize the appearance of how the buttons look in-game. Adjust them accordingly.

---

General

  Show by Default?:
  - Show or hide the Message Button Console by default?

  Position:
  - Where do you wish to display the Message Button Console?
    - Top of Message Window
    - Bottom of Message Window

---

Appearance

  Window Skin:
  - What is the window skin used for the buttons?

  Font Name:
  - What font do you wish to use for the Message Button Console?

    Font Size:
    - What font size do you wish to use for the Message Button Console?

  Text Colors:

    Normal Color:
    - Use #rrggbb for custom colors or regular numbers for text colors from
      the Window Skin.

    Toggled Color:
    - Use #rrggbb for custom colors or regular numbers for text colors from
      the Window Skin.

    Disabled Color:
    - Use #rrggbb for custom colors or regular numbers for text colors from
      the Window Skin.

  Visuals:

    Width:
    - What is the width of each button?

    Height:
    - What is the height of each button?

    Buffer:
    - What is the buffer between each button?

---

Button Settings

ExtMsgFunc Animated.gif

ExtMsgFunc Params4.png

Settings for which buttons appear and how they appear. These settings will determine which buttons appear (provided that their required plugins are available), what shortcut keys are applied to them, and what kind of text will be displayed to represent them.

In case you are wondering where the Fast Forward shortcut key is, that setting is found in the Message Core.

---

General

  List:
  - Which buttons appear and in what order?
  - Some commands require certain plugins installed.

---

Shortcut Keys

  Auto-Forward Key:
  - This is the key used for auto-forwarding messages.

  Save Key:
  - This is the key used for quick saving.
  - Requires VisuMZ_1_SaveCore!

  Load Key:
  - This is the key used for quick load.
  - Requires VisuMZ_1_SaveCore!

  Options Key:
  - This is the key used for opening options.
  - Requires VisuMZ_1_OptionsCore!

  Game End Key:
  - This is the key used for ending the game.

---

Vocabulary

  Auto-Forward:
  - How is this option's text displayed in-game?

  Fast Forward:
  - How is this option's text displayed in-game?

  Save Game:
  - How is this option's text displayed in-game?
  - Requires VisuMZ_1_SaveCore!

  Load Game:
  - How is this option's text displayed in-game?
  - Requires VisuMZ_1_SaveCore!

  Options:
  - How is this option's text displayed in-game?
  - Requires VisuMZ_1_OptionsCore!

  Game End:
  - How is this option's text displayed in-game?

---

Message Cursor Settings

ExtMsgFunc Animated.gif

ExtMsgFunc Params5.png

Message Cursor settings used for this game. The cursor, if enabled, will appear where the text is currently displayed at and adds a new type of aesthetic to the game.

---

General

  Enable?:
  - Enable or disable the message cursor?

  Graphic Type:
  - What is the cursor's graphic type?
    - Icon - From img/system/IconSet.png
    - Image - An animated image from img/system/

---

Icon

  Icon Index:
  - This is icon used for the Message Cursor.

  Flip Speed Multiplier:
  - What is the flip speed multiplier for the Message Cursor?
  - Use 0 for no flipping.

---

Image

  Filename:
  - Filename of the image found inside the img/system/ folder.

  Image Rows:
  - How many rows are there for the image?

  Image Columns:
  - How many columns are there for the image?

  Frame Delay:
  - How many frames delayed are there per animated cell?

---

Appearance

  Anchor X:
  Anchor Y:
  - Determine the Message Cursor's X/Y position.
  - Use a number between 0 and 1 for best results.

  Offset X:
  Offset Y:
  - Offset the Message Cursor's X/Y position by how many pixels?

---


Terms of Use

1. These plugins may be used in free or commercial games provided that they have been acquired through legitimate means at VisuStella.com and/or any other official approved VisuStella sources. Exceptions and special circumstances that may prohibit usage will be listed on VisuStella.com.

2. All of the listed coders found in the Credits section of this plugin must be given credit in your games or credited as a collective under the name: "VisuStella".

3. You may edit the source code to suit your needs, so long as you do not claim the source code belongs to you. VisuStella also does not take responsibility for the plugin if any changes have been made to the plugin's code, nor does VisuStella take responsibility for user-provided custom code used for custom control effects including advanced JavaScript notetags and/or plugin parameters that allow custom JavaScript code.

4. You may NOT redistribute these plugins nor take code from this plugin to use as your own. These plugins and their code are only to be downloaded from VisuStella.com and other official/approved VisuStella sources. A list of official/approved sources can also be found on VisuStella.com.

5. VisuStella is not responsible for problems found in your game due to unintended usage, incompatibility problems with plugins outside of the VisuStella MZ library, plugin versions that aren't up to date, nor responsible for the proper working of compatibility patches made by any third parties. VisuStella is not responsible for errors caused by any user-provided custom code used for custom control effects including advanced JavaScript notetags and/or plugin parameters that allow JavaScript code.

6. If a compatibility patch needs to be made through a third party that is unaffiliated with VisuStella that involves using code from the VisuStella MZ library, contact must be made with a member from VisuStella and have it approved. The patch would be placed on VisuStella.com as a free download to the public. Such patches cannot be sold for monetary gain, including commissions, crowdfunding, and/or donations.

7. If this VisuStella MZ plugin is a paid product, all project team members must purchase their own individual copies of the paid product if they are to use it. Usage includes working on related game mechanics, managing related code, and/or using related Plugin Commands and features. Redistribution of the plugin and/or its code to other members of the team is NOT allowed unless they own the plugin itself as that conflicts with Article 4.

8. Any extensions and/or addendums made to this plugin's Terms of Use can be found on VisuStella.com and must be followed.

Terms of Use: Japanese


『VisuStella MZ』利用規約

1. これらのプラグインは、VisuStella.comおよび/または公式に承認されたVisuStellaのソースから合法的な手段で入手したものである限り、フリーゲームや商用ゲームに使用することができます。例外的に使用が禁止される場合については、VisuStella.comの記載をご確認ください。

2. 本プラグインの「クレジット」部分に記載されているすべてのコーダーの名前は、ゲーム内にクレジット表記を行うか、もしくは「VisuStella」という名前の下にまとめて表記する必要があります。

3. ソースコードを自分のものだと主張しない限りは、必要に応じて編集することが可能です。ただしプラグインのコードに変更が加えられた場合、VisuStellaはそのプラグインに対して一切の責任を負いません。高度なJavaScriptのノートタグやJavaScriptコードを許可するプラグインのパラメータを含む、カスタムコントロールエフェクトに使用される、ユーザー提供のカスタムコードについても、VisuStellaは一切の責任を負いません。

4. これらのプラグインやプラグイン内のコードを、「自分のもの」として再配布したり使用したりすることはできません。これらのプラグインとそのコードは、VisuStella.comおよび、その他の公式/承認済みVisuStellaソースからのみダウンロードすることができます。公式/承認済みのソースのリストは、VisuStella.comでご確認いただけます。

5. VisuStellaは、意図しない使用方法による問題、VisuStella MZライブラリ以外のプラグインとの非互換性の問題、プラグインのバージョンが最新でないことによる問題、第三者による互換性パッチが適切に動作していないことなどが原因でゲーム内で発生した問題については、一切の責任を負いません。VisuStellaは、高度なJavaScriptのノートタグやJavaScriptコードを許可するプラグインのパラメータを含む、カスタムコントロールエフェクトに使用される、ユーザー提供のカスタムコードに起因するエラーについても、一切の責任を負いません。

6. VisuStella MZライブラリのコードを使用した互換性パッチをVisuStellaとは関係のない第三者を通じて作成する必要がある場合は、まずVisuStellaのメンバーと連絡を取り、承認を得る必要があります。パッチはVisuStella.comに公開され、誰でも無料でダウンロードすることができるようになります。このようなパッチを、制作発注やクラウドファンディングの対象にしたり、寄付などの金銭的な利益を得るために販売することはできません。

7. このVisuStella MZプラグインが商用製品である場合、プロジェクトチームのすべてのメンバーは、それを使用するため、それぞれ製品を購入しなければなりません。使用方法には、関連するゲームメカニクスの作業、関連するコードの管理、および/または関連するプラグインコマンドや機能の使用、が含まれます。プラグインそのものやそのコードをチームの他のメンバーに再配布することは第4項に抵触するため、そのメンバーがプラグインそのものを所有していない限りは許可されません。

8. このプラグインの利用規約の追加項目や補足については、VisuStella.comに掲載されていますので、それを参照し従ってください。

Credits

If you are using this plugin, credit the following people in your game:

Team VisuStella

Changelog

Version 1.04: October 14, 2021

  • Feature Update!
    • Added an alert requirement for those who are using very old versions of the Message Core that cannot sustain the requirements of this plugin. Added by Irina.


Version 1.03: September 3, 2021

  • Bug Fixes!
    • Pause sprite, for the Message Window, will no longer show multiple copies if the message cursor sprite is disabled. Fix made by Irina.


Version 1.02: August 6, 2021

  • Documentation Update!
    • Plugin URL now updated to most recent one.


Version 1.01: July 30, 2021

  • Feature Update!
    • Added graphic pre-loading for save/load menu preparation. Added by Irina.


Version 1.00 Official Release Date: August 2, 2021

  • Finished Plugin!

End of File