View source for Extended Message Functionality VisuStella MZ

{{MzPlugin
|preview = <youtube>link</youtube>
|link1 = <html><iframe frameborder="0" src="https://itch.io/embed/1128397" width="552" height="167"><a href="https://visustellamz.itch.io/extended-message-functionality">Extended Message Functionality plugin for RPG Maker MZ by VisuStellaMZ</a></iframe></html>
|link2 = {{VisuStella Visual Novel Vol 1}}

}}

<!-- Preview -->

[[File:ExtMsgFunc_Animated.gif]]

[https://twitter.com/almadeia Featuring upcoming VTuber Almadeia Ciana]

{| style="width: 800px;" cellspacing="0" cellpadding="0"
| style="width: 100%; vertical-align: top;" |


{{RequiredPluginsMZ}}
* [[Message Core VisuStella MZ]]

<!--
{{ExtensionPluginsMZ}}
* [[Extension Plugin 1|Name1]]
* [[Extension Plugin 2|Name2]]
* [[Extension Plugin 3|Name3]]
-->

{{Visustella MZ}}

== Introduction ==

[[File: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 ===

* [[Message Core VisuStella MZ]]

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.

{{MZ Tier 2}}

== Extra Features ==

[[File: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 MZ}}

{{VisuMZ Extended Message Functionality Text Codes}}

{{Plugin Commands MZ}}

{{VisuMZ Extended Message Functionality Plugin Commands}}

== Plugin Parameters ==

=== Auto-Forward Settings ===

[[File: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.

---

<pre>
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.
</pre>

---

=== Fast Forward (Extended) Settings ===

[[File: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.

---

<pre>
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.
</pre>

---

=== Message Button Console Settings ===

[[File:ExtMsgFunc_Animated.gif]]

[[File: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.

---

<pre>
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
</pre>

---

<pre>
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?
</pre>

---

=== Button Settings ===

[[File:ExtMsgFunc_Animated.gif]]

[[File: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.

---

<pre>
General

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

---

<pre>
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.
</pre>

---

<pre>
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?
</pre>

---

=== Message Cursor Settings ===

[[File:ExtMsgFunc_Animated.gif]]

[[File: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.

---

<pre>
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/
</pre>

---

<pre>
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.
</pre>

---

<pre>
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?
</pre>

---

<pre>
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?
</pre>

---

{{VisuStella MZ Terms of Use}}

== Credits ==

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

Team VisuStella

* [[Irina]]
* [[Arisu]]
* [[Olivia]]
* [[Yanfly]]

== Changelog ==

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 ==

|}

<!-- This is a comment, remove the arrows surrounding this for the categories you want to show -->
<!-- [[Category: RPG Maker MZ Core Plugins]] -->
<!-- [[Category: RPG Maker MZ Battle Plugins]] -->
<!-- [[Category: RPG Maker MZ Item Plugins]] -->
<!-- [[Category: RPG Maker MZ Skill Plugins]] -->
<!-- [[Category: RPG Maker MZ Equip Plugins]] -->
<!-- [[Category: RPG Maker MZ Status Menu Plugins]] -->
<!-- [[Category: RPG Maker MZ Gameplay Plugins]] -->
<!-- [[Category: RPG Maker MZ Movement Plugins]] -->
<!-- [[Category: RPG Maker MZ Quest Plugins]] -->
<!-- [[Category: RPG Maker MZ Options Plugins]] -->
[[Category: RPG Maker MZ Eventing Plugins]]
[[Category: RPG Maker MZ Utility Plugins]]
<!-- [[Category: RPG Maker MZ Mechanical Plugins]] -->
[[Category: RPG Maker MZ Visual Plugins]]
<!-- [[Category: RPG Maker MZ Menu Plugins]] -->
[[Category: RPG Maker MZ Message Plugins]]
[[Category: RPG Maker MZ Quality of Life Plugins]]
<!-- [[Category: Action Sequences (MZ)]] -->
<!-- [[Category: Comment Tags (MZ)]] -->
<!-- [[Category: Main Menu Manager Integration (MZ)]] -->
<!-- [[Category: Notetags (MZ)]] -->
<!-- [[Category: Options Core Integration (MZ)]] -->
<!-- [[Category: Plugin Commands (MZ)]] -->
<!-- [[Category: Script Calls (MZ)]] -->
<!-- [[Category: Text Codes (MZ)]] -->