View source for Message Core VisuStella MZ

{{MzPlugin
|preview = <youtube>https://www.youtube.com/watch?v=MmwFhyuxfb0</youtube>
|link1 = {{VisuStella Wave 1}}
|link2 = {{VisuStella All Waves Collection}}

}}

<!-- Preview -->

{| 
| [[File:MessageCoreExpandedChoices.png|400px]]
| [[File:MessageCoreWordWrap.png|400px]]
 
|-

| [[File:MessageCoreAutoColor.png|400px]]
| [[File:MessageCoreAlignment.png|400px]]

|}

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

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

{{ExtensionPluginsMZ}}
* [[Animated Message Text Effects VisuStella MZ]]
* [[Choice Common Events VisuStella MZ]]
* [[Extended Message Functionality VisuStella MZ]]
* [[Message Letter Sounds VisuStella MZ]]
* [[Message Log VisuStella MZ]]
* [[State Tooltips VisuStella MZ]]
* [[Visual Text Window VisuStella MZ]]
* [[Voice Acting Control VisuStella MZ]]

{{Visustella MZ}}

== Introduction ==

The Message Core plugin extends and builds upon the message functionality of
RPG Maker MZ and allows you, the game dev, to customize the workflow for
your game's message system.

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

* Control over general message settings.
* Auto-Color key words and/or database entries.
* Increases the text codes available to perform newer functions/effects.
* Ability for you to implement custom Text Code actions.
* Ability for you to implement custom Text code string replacements.
* Invoke a macro system to speed up the dev process.
* Add a Text Speed option to the Options menu.
* Add the ever so useful Word Wrap to your message system.
* Extend the choice selection process to your liking.
* The ability to enable/disable as well as show/hide certain choices.

== Requirements ==

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

{{MZ Tier 1}}

== Major Changes ==

=== Dim Background Extension ===

Before, when using the Dim Background as a part of a Show Text event, its
size is only the same as the message window's width itself. This looked
really ugly because it had hard edges cutting off while gradients are seen
elsewhere. To make it look better, we extended the dimmed background to span
the width of the screen instead.

=== Extended Messages ===

[[File:MessageCore_ExtendMessages.png]]

If you decide to expand the size of the message window to allow for more
rows to be displayed, you can type in the data for them by chaining together
Show Message events. They will take data from each other and display them in
the same message window as long as there are enough rows.

=== Extended Choice Lists ===

[[File:MessageCore_ExtendChoices.png]]

Choice lists can be extended by just chaining one Choice List event after
the other in succession along the same indentation. They do not extend if
there is any event other than a Choice List option between them on the same
indentation level.



== Text Language Switching Information ==

[[File:MessageCore_LanguageSwitch0.png|600px]]

As of Message Core version 1.46, Text Language Switching has been added.

The "Text Language" feature allows your players to switch between different
languages for your game to allow people from around the globe to enjoy what
story you have to tell.

Disclaimers: This is not an automatic translation tool. Translations made
through the "Text Language" feature of the VisuStella MZ Message Core
will require manual input by the game developer.

---

=== How to Enable Switching ===

[[File:MessageCore_LanguageSwitch1.png]]

Text Language is NOT enabled by default. Here's what you have to do:

# Open up the Message Core's Plugin Parameters
# Plugin Parameters > Text Language Settings > Enable Switching?
# Change the "Enable Switching?" parameter setting to "true".
# Adjust any other settings as needed.
# Save the Plugin Parameter changes.
# Save your game.

[[File:MessageCore_LanguageSwitch2.png]]

Now, it's time to get the CSV file that will contain all of the text used to
translate your game's script.

# Play test your game. Make sure Play test mode is NOT disabled.
# A popup will appear asking to create a language CSV file.
# Click "OK" and let the plugin do its thing.
# The project's /data/ folder will appear with Language.csv made.
# The plugin will then ask you to restart your game.

---

=== How to Edit the Language CSV ===

The Language CSV is structured as a normal CSV file would be, which also
means it can be modified in programs like [https://www.microsoft.com/en-us/microsoft-365/excel Microsoft Excel] or [https://www.google.com/sheets/about/ Google Sheets].
We recommend using either of those programs to modify the text.

We do not recommend modifying the CSV file in programs like notepad directly
due to the way certain things like commas (,) are handled and how easy it is
to be error-prone.

The table will appear something like this at first:

<pre>
    Key        English    Chinese    Japanese     Korean
    Greeting   Hello      你好       こんにちは    안녕하세요
    Farewell   Good-bye   再见       さようなら    안녕히
    Wow        Wow        哇         ワオ          와우
</pre>

The "Key" column refers to the reference key used to determine which lines
will be inserted into the text. The columns with the languages will utilize
the respective phrases for that language.

You can remove columns containing languages that you aren't planning to
translate for your game.

---

=== Things to Keep in Mind ===

When adding text to the CSV file via the spreadsheet editor ([https://www.microsoft.com/en-us/microsoft-365/excel Microsoft Excel] or [https://www.google.com/sheets/about/ Google Sheets]), there's a few things to keep in mind.

---

==== Line Breaks ====

When you want to insert line breaks into the translated phrases, use the
<nowiki><br></nowiki> text code. This is best used for text that is to be transferred into
the message window or help window.

==== Text Codes ====

Text codes like \C[2] can be inserted normally. However, they only work in
windows that support text codes, such as the message window or help window.
Otherwise, the text codes will not transfer over properly.

==== Semicolons ====

Due to the nature of the CSV file, we used the semicolon (;) as the
separator. As such, semicolons should not be used in the text entries.
Though some sentences will work with the semicolon, not all of them will. If
you do want to use a semicolon, use the text code <semicolon> instead.

<pre>
  Example:

  "The pancakes were delicious<semicolon> they were fluffy and sweet."
</pre>

Other variations of the semicolon text code are <semi> and <semi-colon>.
The <semicolon> text code and variants only work with the Language CSV and
are ignored otherwise when typed in a regular message box entry.

---

==== Macros and Language Switches ====

For those using both text macros and text language switches, macros will be
converted to text before language switches as it allows for better text
transitions that way.

---

=== How to Use the Reference Keys ===

Remember the "Key" column and the reference keys? Those are used to
determine which lines will be inserted into the text for the message window
and just about any other window. However, there's a specific way these keys
must be used in order for them to work.

The "text code" format works like this. Use any of the following:

<pre>
  \tl{keyName}
  \translate{keyName}
  \loc{keyName}
  \locale{keyName}
  \localize{keyName}
</pre>

or for those coming from different translation plugins but want to switch
over to the VisuStella MZ Message Core's translation system:

<pre>
  ${keyName}
</pre>

For example, to use one of the default keys made with the Language CSV:

<pre>
  \tl{Greeting}
</pre>

This will yield "Hello" in English, "你好" in Chinese, "こんにちは" in
Japanese, and "안녕하세요" in Korean.

Key names are not case sensitive and any trailing spaces will be removed
from them in order to make sure the CSV table is stable to reference any
translated text from.

You can insert these language "text codes" into item names, skill names,
etc. as well as system entries like for Attack, Defense, etc.

---



{{Text Codes MZ}}

{{VisuMZ Message Core Text Codes}}

{{Plugin Commands MZ}}

{{VisuMZ Message Core Plugin Commands}}

== Plugin Parameters ==

=== General Settings ===

[[File:MessageCoreParams1.png]]

General settings involving the message system. These settings range from
adjust how the Message Window looks to more intricate settings like how
some of the default text codes work.

---

Message Window

  Default Rows:
  - Default number of rows to display for the Message Window.

  Default Width:
  - Default Message Window width in pixels.

  Fast Forward Key:
  - This is the key used for fast forwarding messages.
  - WARNING: If this key is the same as the dash button, this will clear out
    any held down inputs upon triggering an event  to prevent players from
    skipping potentially useful information stored in messages. If you do
    not want the input to be cleared, use a different key.

  Text Delay:
  - How many frames to wait between characters drawn?
  - Use 0 for instant.

  Offset X:
  Offset Y:
  - Offset Message Window horizontally or vertically.
  - Horizontal: Left; Positive: Right
  - Veritcal: Negative: Up; Positive: Down

  Stretch Dimmed BG:
  - Stretch dimmed window background to fit the whole screen.

  Default Outline Width:
  - Changes the default outline width to this many pixels thick.

  Each Message Start:
  Each Message End:
  - This is text that is added at the start/end of each message.
  - You may use text codes.
  - Keep in mind that if a message extends to a different page (due to word
    wrap, excess lines, etc), that does not mean the starting text will
    be added to where the next page begins or the ending text will be added
    where the previous page ends.
  - Can be used for things like adding "<nowiki><center></nowiki>" to the start of each
    message without having to type it every time.

---

Name Box Window

  Default Color:
  - Default color for the Name Box Window's text.

  Offset X:
  - How much to offset the name box window X by
    (as long as it doesn't go offscreen).

  Offset Y:
  - How much to offset the name box window Y by
    (as long as it doesn't go offscreen).

---

Choice List Window

  Line Height:
  - What is the default line height for Show Choices?

  Max Rows:
  - Maximum number of rows to visibly display?

  Max Columns:
  - Maximum number of columns to visibly display?

  Text Alignment:
  - Default alignment for Show Choice window.

---

Default Text Codes

  Relative \PX \PY:
  - Make \PX[x] and \PY[x] adjust relative starting position than
    exact coordinates.

  \{ Maximum:
  - Determine the maximum size that \{ can reach.

  \} Minimum:
  - Determine the minimum size that \} can reach.

  \{ Change \}
  - How much does \{ and \} change font size by?

---

=== Auto-Color Settings ===

[[File:MessageCoreAutoColor.png|600px]]

[[File:MessageCoreParams2.png]]

For certain windows such as the Message Window, Help Window, and Choice
Window, Auto-Color is enabled to automatically highlight and color certain
database entries, keywords, and just about anything you, the game dev, wants
to be automatically colored. This is done to avoid typing out \C[6]Jack\C[0]
every time Jack's name is written out as it will be automatically colored in
those specific windows.

The Plugin Parameters will give you full reign over which database entries
and keywords you want to be automatically colored as long as they follow a
few rules:

-----------------
Auto-Color Rules:
-----------------

; 1. Database names and keywords are case sensitive.
: This means if "Potion" is a marked keyword, typing out "potion" will not prompt the auto-color to highlight "potion". You must add the lowercase version of the word into the keyword list if you want it to count.

; 2. Database names and keywords are exact size (for Roman languages)
: This means if "Potion" is a marked keyword, typing out "potions" will not prompt the auto-color to highlight "potions". You must type out all of the variations of the words you want affected into the keyword list to prompt the auto-color highlight.
: This does not apply to Japanese, Korean, or Chinese languages.

; 3. Possessive cases and other language symbols aren't counted.
: Symbols such as periods, commas, quotes, parentheses, and similar symbols do no count towards Rule 2. This means if "Potion" is a marked keyword, the typing out "(Potion)" will still highlight the "Potion" part of the word according to the auto-color.

; 4. Names with special characters like !, ?, [, ], etc. will be ignored.
: These cause conflicts with how auto-colors are detected.

---

Database Highlighting

  Actors:
  Classes:
  Skills:
  Items:
  Weapons:
  Armors:
  Enemies:
  States:
  - Any usage of a the selected database entry's name is auto-colored with
    the text code number.
  - Use 0 to not auto-color.

---

Word Highlighting

  \C[x]: Color
  - These are lists of all the words that will be automatically colored with
    the x text color.

---

=== Text Code Actions ===

[[File:MessageCoreParams3.png]]

Text codes are used for one of two things: performing actions or replacing
themselves with text data. This Plugin Parameter will focus on the aspect of
performing actions. These actions can be done through each JavaScript or by
a common event (if it is used in the Message Window). Adequate knowledge of
both is recommended before attempting to modify and/or add new Text Code
Actions to the Plugin Parameters.

Each of the Text Code Actions are formatted in such a way:

---

[[File:MessageCoreParams3a.png]]

Text Code Action

  Match:
  - This is what needs to be matched in order for this text code to work.
  - This is the primary text marker after the \ in a text code.
  - In \N[x], this would be the 'N'.

  Type:
  - The type of parameter to obtain (none, number, or string).
  - This is the way the text code determines the condition type.
  - In \N[x], this would be the '[x]'.

  Common Event:
  - Select a common event to run when this text code is used in a message.

  JS: Action:
  - JavaScript code used to perform an action when this text code appears.

---

=== Text Code Replacements ===

[[File:MessageCoreParams4.png]]

Text codes are used for one of two things: performing actions or replacing
themselves with text data. This Plugin Parameter will focus on the aspect of
replacing the text codes with text data. Text data can be replaced with
an exact exchange of text or dynamically through JavaScript. Adding a new
Text Code Replacement is done through the Plugin Parameters.

Each of the Text Code Replacements are formatted in such a way:

---

Text Code Replacement

[[File:MessageCoreParams4a.png]]

  Match:
  - This is what needs to be matched in order for this text code to work.
  - This is the primary text marker after the \ in a text code.
  - In \N[x], this would be the 'N'.

  Type:
  - The type of parameter to obtain (none, number, or string).
  - This is the way the text code determines the condition type.
  - In \N[x], this would be the '[x]'.

  STR: Text:
  - The text that will appear if this match appears.
    If this has a value, ignore the JS: Text version.

  JS: Text:
  - JavaScript code used to determine the text that will appear if this
    match appears.

---

=== Text Macros ===

[[File:MessageCoreParams5.png]]

Text macros are used in similar fashion to text codes replacements to
replace themselves with text data. The primary difference is that macros are
made in a different format with no conditional argument modifiers (ie the
[x] that follows a text code).

To use a text macro, type in the matching keyword between two [brackets] and
it will be replaced by the string data or run the JavaScript code found in
the Plugin Parameter settings.

For example, if you have the text macro "Leader", made to return the party
leader's name, you can type in [Leader] in the Message Window and it will be
replaced with the party leader's name. The output can also output text codes
into the resulting text.

This does NOT work with \MacroName as it did with Yanfly Engine Plugins.
Use the method stated before with the brackets to [MacroName] instead.

Each of the Text Macros are formatted in such a way:

---

[[File:MessageCoreParams5a.png]]

Text Macro

  Match:
  - This is what needs to be matched in order for this macro to work.
  - In [Leader], this would be the 'Leader' text.

  STR: Text:
  - The replacement text that will appear from the macro.
  - If this has a value, ignore the JS: Text version.

  JS: Text:
  - JavaScript code used to determine the text that will appear if this
    macro appears.

---

=== Text Language Settings ===

The "Text Language" feature allows your players to switch between different
languages for your game to allow people from around the globe to enjoy what
story you have to tell.

Disclaimers: This is not an automatic translation tool. Translations made
through the "Text Language" feature of the VisuStella MZ Message Core
will require manual input by the game developer.

See the "Text Language Information" for more information.

---

Main Settings:

  Enable Switching?:
  - Enable language switching settings for this plugin?

  CSV Filename:
  - What is the filename of the CSV file to read from?
  - Located within the project's /data/ folder.

---

Options:

  Add Option?:
  - Add the 'Text Language' option to the Options menu?

  Adjust Window Height:
  - Automatically adjust the options window height?

  Option Name:
  - Command name of the option.

---

Languages:

  Default Language:
  - What is the default language used for this game?

  Supported Languages:
  - What are all the supported languages supported by this game's
    script?
  - Remove any that aren't translated.

---

Language Names:

  Bengali:
  Chinese (Simplified):
  Chinese (Traditional):
  Czech:
  Danish:
  Dutch:
  English:
  Finnish:
  French:
  German:
  Greek:
  Hindi:
  Hungarian:
  Indonesian:
  Italian:
  Japanese:
  Korean:
  Norwegian:
  Polish:
  Portuguese:
  Romanian:
  Russian:
  Slovak:
  Spanish:
  Swedish:
  Tamil:
  Thai:
  Turkish:
  - How does this language appear in the in-game options?

---

=== Text Speed Option Settings ===

[[File:MessageCoreOption.gif]]

[[File:MessageCoreParams6.png]]

Modern RPG's on the market have the option to adjust the message speed rate
for players. These Plugin Parameters allow you to add that option to the
Options Menu as well.

---

Text Speed Option Settings

  Add Option?:
  - Add the 'Text Speed' option to the Options menu?

  Adjust Window Height:
  - Automatically adjust the options window height?

  Option Name:
  - Command name of the option.

  Default Value:
  - 1 - 10, slowest to fastest.
  - 11 is instant value.

  Instant Speed:
  - Text to show "instant" text.

---

=== Word Wrap Settings ===

[[File:MessageCoreWordWrap.png|600px]]

[[File:MessageCoreParams7.png]]

<nowiki>Word wrap is a property that will cause any overflowing text to wrap around
and move into the next line. This property can only be enabled inside text
that accept text codes, such as the Message Window and Help Window. However,
word wrap is disabled for the Choice Window due to the nature of the Choice
Window's base properties.

Word wrap can be enabled or disabled in three ways. One is by using the text
code <WordWrap> to enable it or </WordWrap> to disable it. The second method
is by enabling it with the Plugin Command: 'Message: Properties'. The third
method is by enabling it by default with the Plugin Parameters.

Word Wrap also cannot be used together with <left>, <center>, or <right> and
will disable itself if text alignment text codes are detected.

Word wrap only supports left-to-right alphabetical languages that utilize
spaces.

As of the v1.44 update, some Asian languages such as Chinese and Japanese
are now supported for word wrap. Korean language is only supported if spaces
are used.</nowiki>

---

Enable Word Wrap

  Message Window:
  - Automatically enable Word Wrap for this window?

  Help Window:
  - Automatically enable Word Wrap for this window?

---

Rules

  Link Break -> Space:
  - Convert manually placed (non tagged) line breaks with spaces?
  - Line breaks must be inserted using the <br> text code.

  Tight Wrap:
  - If a face graphic is present in a message, word wrap will be tighter.

  End Padding:
  - Add extra padding to your window to make text wrap further away from the
    end of the window.
  - This will default to 0.

---

{{VisuStella MZ Terms of Use}}

== Credits ==

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

Team VisuStella

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

== Changelog ==

Version 1.47: February 15, 2024
* Documentation Update!
** Help file updated for new features.
* New Features!
** New Plugin Parameters added by Irina:
*** Plugin Parameters > Custom Font Manager
**** Register custom fonts here.
**** Custom fonts that aren't the message or number fonts cannot be used without registration.
**** See help file for more information.



Version 1.46: January 18, 2024
* Bug Fixes!
** Fixed a bug where script calls used to create message choices would not work properly. Fix made by Irina.
* Documentation Update!
** Help file updated for new features.
* New Features!
** Text Language Switching added by Irina:
*** Plugin Parameters > Text Language Settings
**** The "Text Language" feature allows your players to switch between different languages for your game to allow people from around the globe to enjoy what story you have to tell.
**** Disclaimers: This is not an automatic translation tool. Translations made through the "Text Language" feature of the VisuStella MZ Message Core will require manual input by the game developer.
**** Read more about it in detail within the "Text Language Information" section in the help file.
** New Plugin Parameter added by Irina:
*** Choices: Distance
**** Change the distance from choice window to the message window.
** New parameter added to Plugin Command "Choices: Properties" by Irina:
*** Minimum Choice Width
**** What is the minimum width size for each choice?
** New Plugin Parameter for "Message Window" added by Irina:
*** Parameters > Message Window: Choice List Window> Minimum Choice Width
**** What is the minimum width size for each choice?
** New Text Codes for Choice Window added by Irina:
*** <BgImg: filename> and variants
*** <FgImg: filename> and variants
**** These text codes allow adding a background or foreground image to a choice rectangle in stretched/scaled size.



Version 1.45: December 14, 2023
* Bug Fixes!
** Punctuation was, for some reason, excluded when using Wordwrap with Japanese and Chinese languages. This should be fixed now. Fixed by Irina.
* Documentation Update!
** Help file updated for new features.
** Added clarity to the <nowiki><left>, <center>, and <right></nowiki> being unable to be used together with word wrap.
*** Word Wrap also cannot be used together with <nowiki><left>, <center>, or <right></nowiki> and will disable itself if text alignment text codes are detected.
* Feature Update!
** Wordwrap <nowiki><br></nowiki> now works properly with Japanese and Chinese languages.
* New Features!
** New Plugin Parameters added by Irina:
*** Plugin Parameters > General Settings > Each Message Start
*** Plugin Parameters > General Settings > Each Message End
**** This is text that is added at the start/end of each message.
**** Keep in mind that if a message extends to a different page (due to word wrap, excess lines, etc), that does not mean the starting text will be added to where the next page begins or the ending text will be added where the previous page ends.
**** Can be used for things like adding "<nowiki><center></nowiki>" to the start of each message without having to type it every time.



Version 1.44: October 12, 2023
* Documentation Update!
** Help file updated for new features.
** Updated "Plugin Parameters: Word Wrap Settings" section:
*** As of the v1.44 update, some Asian languages such as Chinese and Japanese are now supported for word wrap. Korean language is only supported if spaces are used.
* Feature Update!
** Word Wrap is now supported for Japanese and Chinese languages.
** Feature updated by Irina and sponsored by AndyL.
* New Features!
** New text codes added by Irina for "Show Choices" event command.
*** <Shuffle>
**** Shuffles the order of all choices. Any cancel shortcuts other than "Branch" will be undone.
*** <Shuffle: x>
**** Shuffles the order of all choices and only x number of them appear. Any cancel shortcuts other than "Branch" will be undone. Hidden choices do not count towards x number.



Version 1.43: April 13, 2023
* Compatibility Update!
** Fixed incompatibilities with auto message positioning with the Map Zoom plugin. Update made by Irina.



Version 1.42: March 16, 2023
* Bug Fixes!
** Fixed some text codes that would capture way too much data than intended. Fix made by Irina.
* Documentation Update!
** Help file updated for new features.
* New Features!
** New text code added by Irina for Show Choice Window only:
*** <Help> text </Help>
**** Makes a help window appear and have it show 'text' in its contents.
**** The help window will disappear if no text is displayed.
** New Plugin Commands added by Arisu:
*** Select: Weapon
*** Select: Armor
*** Select: Skill
**** Opens the Event Select Item Window to let the player pick a weapon, armor, or skill to choose from. The selected object will have its ID recorded in a variable. These can be opened while the Message Window is opened just like the event "Select Item".



Version 1.41: December 15, 2022
* Compatibility Update!
** Added compatibility functionality for future plugins.
* Documentation Update!
** Help file updated for new features.
* New Features!
** New text codes added by Irina!
*** For the Choice Window Only text codes:
**** <BgColor: x>
**** <BgColor: x, y>
**** <BgColor: #rrggbb>
**** <BgColor: #rrggbb, #rrggbb>
***** Requires VisuMZ_0_CoreEngine! Sets the background color of this choice to 'x' text color, 'x' to 'y' gradient text color, or using '#rrggbb' hex color values.



Version 1.40: November 3, 2022
* Documentation Update!
** Help file updated for new features.
* New Feature!
** New text code added by Irina:
*** <RNG> text1 | text2 | text3 </RNG>
**** Using the above text code format in a Show Message entry, you can get a random result out of the various inserted texts. Use "|" (without quotes) as a separator between text entries. You can have unlimited entries. The result will have any excess white space trimmed.
**** This text code cannot be inserted into a macro and parsed properly.



Version 1.39: September 22, 2022
* Bug Fixes!
** Macros now support quotes (' and ") in the STR: Text. Fix made by Irina.



Version 1.38: July 21, 2022
* Optimization Update!
** Plugin should run more optimized.



Version 1.37: June 9, 2022
* Documentation Update!
** Help file updated for new features.
* Feature Update!
** Picture texts with \v[x] text codes are now updated automatically.
** This is the only dynamic text code that updates this way for optimization purposes and to prevent overabundant CPU usage.
** Everything else will require the new Plugin Command.
* New Features!
** New Plugin Command added by Irina:
*** Picture: Refresh Text
**** Refreshes the text used for all on-screen pictures.
**** To be used if any dynamic text codes are updated like \n[x].
* New Features!
** New text codes added by Arisu and sponsored by ImGonnaPutMyGameOnXboxAndYouCantStopMe:
*** <Up Button>, <Left Button>, <Right Button>, <Down Button>
*** <Ok Button>, <Cancel Button>, <Shift Button>, <Menu Button>
*** <Page Up Button>, <Page Down Button>
**** Display's VisuMZ_0_CoreEngine's button assist text.



Version 1.36: April 7, 2022
* Feature Update!
** Auto size related text codes should now automatically disable word wrap effects as they should have before. Update made by Irina.



Version 1.35: March 31, 2022
* Bug Fixes!
** Bug fixed where if autosizing is used and it goes from a message that is shorter to longer, an extra key press is needed. This should no longer be the case. Fix made by Irina.



Version 1.34: February 24, 2022
* Documentation Update!
** Help file updated for new features.
* New Features!
** New Choice Window Text Codes made by Irina and sponsored by AndyL:
*** <Choice Width: x>
**** Sets the minimum text area width to x. Applies to whole choice window.
*** <Choice Indent: x>
**** Sets the indent to x value. Applies to current choice selection only.



Version 1.33: February 10, 2022
* Documentation Update!
** Help file updated for new features.
* New Features!
** New Plugin Commands added by Irina:
*** Picture: Change Text
**** This new plugin command allows you to place text on top of pictures (usually in the form of empty pages or cards) to function as stationary or other uses. Text codes are allowed.
**** Text codes are supported.
*** Picture: Erase Text
**** Removes text from target picture(s).



Version 1.32: January 20, 2022
* Bug Fixes!
** Extra Show Choice notetags will now be properly hidden. Fix by Irina.
* Compatibility Update!
** Self Switches are now made compatible with work with Show Choices. Update made by Irina.



Version 1.31: December 9, 2021
* Documentation Update!
** Help file updated for new features.
* New Features!
** New hard-coded message-only text code added by Irina:
*** <Next Page>
**** Ends the current message page at this line. This is used for messages when rows are at 5 or above and the message lines don't match the amount. This is used to prevent grabbing message windows from following message events. Any lines following <Next Page> in the same message event will be ignored.



Version 1.30: November 11, 2021
* Documentation Update!
** Help file updated for new features.
** Help file updated for removed "Center Window X" bit.
* Feature Update!
** Message: Properties now has "Center Window X?" removed
*** Changes will now be automatically centered.
*** This change is made for the new Plugin Command added for offsets which more or less replaces them.
* New Features!
** New Plugin Command added by Irina and sponsored by Puddor:
*** Message: X/Y Offsets
**** Change the X and Y Offsets of the Message Window.
**** The offset value(s) will be saved and stored.
** New Plugin Parameters added by Irina and sponsored by Puddor:
*** Plugin Parameters > General Settings > Message Window > Offset X
*** Plugin Parameters > General Settings > Message Window > Offset Y
**** Allows you to offset the horizontal and/or vertical positions of the message window accordingly.
** New Text Codes added by Irina and sponsored by Puddor:
*** <Offset: +x, +y>
*** <Offset: -x, -y>
*** <Offset: +x, -y>
*** <Offset: -x, +y>
**** Quickly adjust the message window offset values to the x and y amounts. The values will replace the previous offset settings if there were any.



Version 1.29: October 21, 2021
* Feature Update
** Word Wrap flags are now properly adjusted when converting macros and adding bypasses towards regular messages. Update by Irina.



Version 1.28: October 14, 2021
* Compatibility Update
** Added compatibility functionality for future plugins.



Version 1.27: October 7, 2021
* Optimization Update!
** Plugin should run more optimized.



Version 1.26: September 3, 2021
* Bug Fixes!
** Macros should now work properly with any \x<n> based text codes. Fix made by Irina.



Version 1.25: August 27, 2021
* Feature Update!
** Macros should now work with the <WordWrap> text code. Update by Irina.



Version 1.24: August 20, 2021
* Feature Update!
** Macros should now work with window placement and resize options. Update made by Irina.
** Macros should now work with choice-related enable and visibility options. Update made by Irina.



Version 1.23: July 16, 2021
* Documentation Update!
** Help file updated for new features.
* New Features!
** New Plugin Parameter added by Irina:
*** Plugin Parameters > Word Wrap Settings > End Padding
**** Add extra padding to your window to make text wrap further away from the end of the window. This will default to 0.



Version 1.22: July 2, 2021
* Documentation Update!
** Help file updated for new features.
* New Features!
** New Text Codes added by Irina and sponsored by AndyL:
*** <Current Battle Target>
*** <Current Battle User>
**** Replaces the text code with the current target or current user's name in-battle. Otherwise, returns nothing.
**** Not recommended to be used inside of Help Descriptions. They are best used with "Show Text" event commands.
*** <Current Battle Action>
*** <Current Battle Action Name>
**** Replaces the text code with the current battle action's name with the icon or without it respectively. Otherwise, returns nothing.
**** Not recommended to be used inside of Help Descriptions. They are best used with "Show Text" event commands.



Version 1.21: June 4, 2021
* Documentation Update!
** Added extra note to the new <Position: x, y, width, height> text codes that they do not work with Word Wrap.
* Feature Update!
** Added fail safe for preventing Common Events that don't exist from being ran at all by the Message Window. Added by Arisu.



Version 1.20: May 28, 2021
* Documentation Update!
** Help file updated for new features.
** Added additional clarity for \WindowMoveTo<?> and \WindowMoveBy<?> and \WindowReset text codes with "Note 2".
*** Replace '?' with the following format: targetX, targetY, targetWidth, targetHeight, duration, easingType. Only targetX and targetY are required arguments. These will only alter the window dimensions when the text has arrived at that point. They will not alter the window preemptively. This is not used as a window positioner. Use the <Position: x, y, width, height> text code for that.
* New Features!
** New hard-coded text codes added for Message Window Only. Added by Irina.
*** <Position: x, y, width, height>
*** <Coordinates: x, y>
*** <Dimensions: width, height>



Version 1.19: May 14, 2021
* Feature Updates!
** Line breaks can now be used by Show Choices. Make sure that there is enough room to contain the text through Plugin Commands. Update by Irina.



Version 1.18: April 30, 2021
* Bug Fixes!
** Moving windows with 0 duration via text code should now instantly move the windows to the desired location with no delay. Fix made by Olivia.



Version 1.17: April 9, 2021
* Feature Update!
** <Auto> text codes for message windows will round up calculations for the message width to the nearest even number for better calculations.



Version 1.16: April 2, 2021
* Bug Fixes!
** \CommonEvent[x] text code will no longer run upon message window size calculation. Fix made by Arisu.
* Documentation Update!
** Added further clarification for "Text Macros" section.
*** This does NOT work with \MacroName as it did with Yanfly Engine Plugins. Use the method stated before with the brackets to [MacroName] instead.



Version 1.14: February 12, 2021
* Bug Fixes!
** Auto positioned messages in battle will no longer cover the battler in question. Fix made by Irina.



Version 1.13: February 5, 2021
* Bug Fixes!
** Choice List Window with a dimmed background should now have a more consistent sized dim sprite. Fix made by Irina.



Version 1.12: January 22, 2021
* Feature Update!
** Name Box Window Default Color is now disabled by default to 0 because users do not understand why their names are showing up yellow and did not bother reading the documentation. If users want this feature turned on, they will have to do it manually from now on. Update made by Irina.



Version 1.11: January 15, 2021
* Optimization Update!
** Plugin should run more optimized.



Version 1.10: January 8, 2021
* Bug Fixes!
** <Auto Actor: x> and <Auto Party: x> text codes should now work properly. Fix made by Irina.
* Feature Update!
** Auto Color Plugin Parameters now have their default settings set to 0. This is due to an influx of "bug reports" from users who do not understand how this feature works, and the VisuStella team has decided it is better for the feature to default to an inactive state until users decide to search and utilize it themselves. Update made by Irina.



Version 1.09: January 1, 2021
* Feature Update!
** Auto-color no longer applies to database names that are only numbers. Auto-color entries that are only numbers will also be ignored. This is to prevent breaking the text code parsing. Update made by Yanfly.



Version 1.08: November 15, 2020
* Documentation Update!
** Some text codes left for the Name Box Window have been accidentally left out. These text codes allow for the positioning of the Name Box Window. Also, added to this section are the \NormalBG, \DimBG, and \TransparentBG text codes since people have been asking for how to change the name box window's background, but have skimmed over those text codes in different sections of the help file.
* Optimization Update!
** Plugin should run more optimized.



Version 1.07: November 8, 2020
* Bug Fixes!
** When using auto size functions, the message pause symbol will no longer appear semi-transparent the whole time. Fix made by Irina.



Version 1.06: October 25, 2020
* Documentation Update!
** Added a warning message to the Fast Forward Key plugin parameter:
*** WARNING: If this key is the same as the dash button, this will clear out any held down inputs upon triggering an event  to prevent players from skipping potentially useful information stored in messages. If you do not want the input to be cleared, use a different key.
** Updated help file for new features.
* Feature Update!
** The default Fast Forward Key setting has now been changed from "Shift" to "Page Down". Change made by Yanfly
* New Feature!
** New Plugin Parameter added by Irina.
*** Plugin Parameters > General > Default Outline Width
**** Changes the default outline width to this many pixels thick.



Version 1.06: September 27, 2020
* Bug Fixes!
** Setting an actor's autocolor will now disable it from \N[x] and \P[x] text codes. Fix made by Irina.



Version 1.05: September 20, 2020
* Bug Fixes!
** Auto Position text codes not place positions properly if the screen width and height differ from the box width and box height. Fix made by Irina.



Version 1.04: September 13, 2020
* Bug Fixes!
** Word wrap no longer affects specific battle messages. Fix made by Irina.
** Word wrap now updates properly after using the 'Message: Properties' Plugin Command. Fix made by Arisu.



Version 1.03: September 6, 2020
* Bug Fixes!
** Autoplacement of the name box window now takes its offset Y setting into account before sending it to the bottom of the message window. Fix made by Yanfly.
** Added automatic feature setting to turn off word wrap when using the auto-size and auto-position text codes. This is because the auto-size and auto-position effects don't work properly with Word Wrap based on how they both clash when adjusting the window settings. Fix made by Irina.
** New message pages after auto-sizing no longer put out empty messages. Fix made by Irina and Shiro.
* Documentation Update!
** Extended the note for auto-size and auto-position text codes to include that they do not work with Word Wrap. Added by Irina.



Version 1.02: August 30, 2020
* New Features!
** Added new hard-coded text codes for auto-sizing and auto-positioning:
*** <Auto>, <Auto Width>, <Auto Height>
*** <Auto Actor: x>, <Auto Party: x>, <Auto Enemy: x>
*** <Auto Player>, <Auto Actor: x>, <Auto Party: x>, <Auto Event: x>
**** New features added by Irina.



Version 1.01: August 23, 2020
* Bug Fixes!
** </Wordwrap> now works.
** \ActorFace[x] text code now fixed.
*** Users updating from version 1.00 will need to fix this problem by either removing the plugin from the Plugin Manager list and reinstalling it, or going to Plugin Parameters > Text Code Replacements > ActorFace > JS: Text > and changing "$gameActors.actor(1)" to "$gameActors.actor(actorId)"
** Actors with empty names would cause auto hightlight problems. Fixed!
** Auto-colors now ignore names with special characters like !, ?, [, ], and so on.
** Line break spacing fixed.
* New Features!
** Wordwrap now works with left, center and right alignment tags.



Version 1.00: August 20, 2020
* Finished Plugin!

== See Also ==

* [[Inspiration Behind Wave 1]]



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