Difference between revisions of "Extended Message Pack 1 (YEP)"
(Created page with "{{MvPlugin |preview=<youtube>https://www.youtube.com/watch?v=q8vE5BNIhek</youtube> |link1=<html><iframe src="https://itch.io/embed/398018" height="167" width="552" frameborder...") |
|||
(6 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
{{MvPlugin | {{MvPlugin | ||
− | |preview=<youtube>https://www.youtube.com/watch?v=q8vE5BNIhek</youtube> | + | |preview = <youtube>https://www.youtube.com/watch?v=q8vE5BNIhek</youtube> |
− | | | + | |link2 = <html><iframe src="https://itch.io/embed/508096" height="167" width="552" frameborder="0"></iframe></html> |
− | | | + | |link3 = <html><iframe src="https://itch.io/embed/398158" height="167" width="552" frameborder="0"></iframe></html> |
}} | }} | ||
[[Category:RPG Maker MV Core Plugins]] | [[Category:RPG Maker MV Core Plugins]] | ||
− | {{ | + | {{RequiredPluginsMV}} |
* [[ Message Core (YEP)|Message Core]] | * [[ Message Core (YEP)|Message Core]] | ||
{{Yanfly Engine Plugins}} | {{Yanfly Engine Plugins}} | ||
− | == | + | == Introduction == |
− | <nowiki> | + | <nowiki>This plugin requires YEP_MessageCore.js to run. |
− | |||
− | |||
− | |||
− | |||
− | This plugin requires YEP_MessageCore.js to run. | ||
Place this plugin under YEP_MessageCore.js in the plugin list. | Place this plugin under YEP_MessageCore.js in the plugin list. | ||
Line 27: | Line 22: | ||
window positioning control. New text codes are also added to further ease | window positioning control. New text codes are also added to further ease | ||
the usage of the message window. | the usage of the message window. | ||
+ | </nowiki> | ||
− | + | {{Text Codes MV}} | |
− | Text Codes | ||
− | |||
− | By using certain text codes in your messages, you can have the game replace | + | <nowiki>By using certain text codes in your messages, you can have the game replace |
them with the following: | them with the following: | ||
Line 178: | Line 172: | ||
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | ||
+ | </nowiki> | ||
− | + | {{Plugin Commands MV}} | |
− | Plugin Commands | ||
− | |||
− | You can use the following plugin commands to adjust a few of the settings | + | <nowiki>You can use the following plugin commands to adjust a few of the settings |
regarding the Message Window. | regarding the Message Window. | ||
Line 286: | Line 279: | ||
positions and not adjusted to its anchor points. The Message Width and the | positions and not adjusted to its anchor points. The Message Width and the | ||
Message Rows. | Message Rows. | ||
+ | </nowiki> | ||
− | + | {{Script Calls MV}} | |
− | |||
− | |||
− | For those who would like to use script calls to alter Choice Settings, you | + | <nowiki>For those who would like to use script calls to alter Choice Settings, you |
can use the following script calls: | can use the following script calls: | ||
Line 314: | Line 306: | ||
$gameSystem.clearChoiceSettings() | $gameSystem.clearChoiceSettings() | ||
- This will clear all hidden and disabled settings. | - This will clear all hidden and disabled settings. | ||
+ | </nowiki> | ||
− | == | + | == Changelog == |
− | Changelog | ||
− | |||
− | Version 1.12: | + | <nowiki>Version 1.12: |
- Updated message choices to properly show the correct number of rows if an | - Updated message choices to properly show the correct number of rows if an | ||
inadequate number of rows are visible. | inadequate number of rows are visible. | ||
Line 374: | Line 365: | ||
Version 1.00: | Version 1.00: | ||
- Finished Plugin! | - Finished Plugin! | ||
+ | |||
</nowiki> | </nowiki> | ||
+ | |||
+ | <!-- This is a comment, remove the arrows surrounding this for the categories you want to show --> | ||
+ | <!-- [[Category:RPG Maker MV Core Plugins]] --> | ||
+ | <!-- [[Category:RPG Maker MV Battle Plugins]] --> | ||
+ | <!-- [[Category:RPG Maker MV Item Plugins]] --> | ||
+ | <!-- [[Category:RPG Maker MV Skill Plugins]] --> | ||
+ | <!-- [[Category:RPG Maker MV Equip Plugins]] --> | ||
+ | <!-- [[Category:RPG Maker MV Status Menu Plugins]] --> | ||
+ | <!-- [[Category:RPG Maker MV Gameplay Plugins]] --> | ||
+ | <!-- [[Category:RPG Maker MV Movement Plugins]] --> | ||
+ | <!-- [[Category:RPG Maker MV Quest Plugins]] --> | ||
+ | <!-- [[Category:RPG Maker MV Options Plugins]] --> | ||
+ | <!-- [[Category:RPG Maker MV Eventing Plugins]] --> | ||
+ | <!-- [[Category:RPG Maker MV Utility Plugins]] --> | ||
+ | <!-- [[Category:RPG Maker MV Mechanical Plugins]] --> | ||
+ | [[Category:RPG Maker MV Visual Plugins]] | ||
+ | <!-- [[Category:RPG Maker MV Menu Plugins]] --> | ||
+ | [[Category:RPG Maker MV Message Plugins]] | ||
+ | [[Category:RPG Maker MV Quality of Life Plugins]] | ||
+ | <!-- [[Category:RPG Maker MV Plugin Tips & Tricks]] --> | ||
+ | <!-- [[Category:Action Sequences (MV)]] --> | ||
+ | <!-- [[Category:Main Menu Manager Integration (MV)]] --> | ||
+ | <!-- [[Category:Notetags (MV)]] --> | ||
+ | <!-- [[Category:Options Core Integration (MV)]] --> | ||
+ | <!-- [[Category:Plugin Commands (MV)]] --> | ||
+ | <!-- [[Category:Script Calls (MV)]] --> | ||
+ | <!-- [[Category:Text Codes (MV)]] --> |
Latest revision as of 10:38, 13 June 2020
VisuStella, Caz Wolf, Fallen Angel Olivia, Atelier Irina, and other affiliated content creators.
Download
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.
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.
Introduction
This plugin requires YEP_MessageCore.js to run. Place this plugin under YEP_MessageCore.js in the plugin list. This plugin extends the amount of things the Message system can do in RPG Maker MV. These features range from text sounds, more name window options, face index control, hex colors, extended choice controls, and more precise window positioning control. New text codes are also added to further ease the usage of the message window.
Text Codes
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.
By using certain text codes in your messages, you can have the game replace them with the following: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - LetterSound Effect: \lson - Turns Letter Sounds on. \lsoff - Turns Letter Sounds off. \lsn<filename> - Changes Letter Sound to play filename. This is case sensitive. Do not include the file extension. \lsv[x] - Sets the volume of the Letter Sound to x. \lspi[x] - Sets the pitch of the Letter Sound to x. \lspiv[x] - Sets the pitch variance of the Letter Sound to x. \lspa[x] - Sets the pan of the Letter Sound to x. \lspav[x] - Sets the pan variance of the Letter Sound to x. \lsi[x] - Sets the interval the Letter Sounds play to x. *Note: Works for message window only. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Enemy Name Effect: \en[x] - Gets the name of the enemy in Database position x. \et[x] - Gets the name of the enemy in Troop position x. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - NameWindow: Effect: \n<x> - Creates a name box with x string. Left side. \nc<x> - Creates a name box with x string. Centered. \nr<x> - Creates a name box with x string. Right side. \nd<x> - Creates a dimmed name box with x string. Left side. \ndc<x> - Creates a dimmed name box with x string. Centered. \ndr<x> - Creates a dimmed name box with x string. Right side. \nt<x> - Creates a transparent name box with x string. Left side. \ntc<x> - Creates a transparent name box with x string. Centered. \ntr<x> - Creates a transparent name box with x string. Right side. *Note: Works for message window only. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - MessagePosition Effect: \msgposx[x] - Sets the X position of the Message Window to x. \msgposx[auto] - Sets the X position of the Message Window to default. \msgposy[x] - Sets the Y position of the Message Window to x. \msgposy[auto] - Sets the Y position of the Message Window to default. \msgevent[x] - Map Field Only! Positions the X and Y position of the Message Window relative to the event x's position. If you use 0, the window will be placed relative to the player's position on the map. \msgactor[x] - Requires Battle Engine Core. Battle Only! Puts the message over actor x's head if actor is in the party. Otherwise, the message will appear in normal location. \msgparty[x] - Requires Battle Engine Core. Battle Only! Puts the message over party member x's head if member is present. Otherwise, the message will appear in normal location. \msgenemy[x] - Requires Battle Engine Core. Battle Only! Puts the message over enemy member x's head if member is present. Otherwise, the message will appear in normal location. \msgwidth[x] - Sets the width of the Message Window to x. \msgwidth[auto] - Sets the width of the Message Window to fit the text. Do not use the auto function with Word Wrap. \msgrows[x] - Sets the rows of the Message Window to x. \msgrows[auto] - Sets the rows of the Message Window to text. Do not use the auto function with Word Wrap. \auto - Sets the width and rows of the Message window to fit the current message window. Do not use this with Word Wrap. \autoevent[x] - Map Field Only! Sets the width and rows of the Message window to fit the current message window and positions it relative to event x. If you use 0, the window will be placed relative to the player's position on the map. Do not use this with Word Wrap. \autoactor[x] - Requires Battle Engine Core. Battle Only! Sets the width and rows of the message window to fit the current message window and puts the message over actor x's head if actor is in the party. Otherwise, the message will appear in normal location. Do not use this with Word Wrap. \autoparty[x] - Requires Battle Engine Core. Battle Only! Sets the width and rows of the message window to fit the current message window and puts the message over party member x's head if member is present. Otherwise, the message will appear in normal location. Do not use this with Word Wrap. \autoenemy[x] - Requires Battle Engine Core. Battle Only! Sets the width and rows of the message window to fit the current message window and puts the message over enemy member x's head if member is present. Otherwise, the message will appear in normal location. Do not use this with Word Wrap. \msgreset - Resets all of the positioning settings to default. * Note: This setting change will remain for just the current message. Going to the next message will reset this setting back to whatever the default setting is in the plugin parameters for the Message Core. If you change the amount of rows past 4, it will not acquire the messages following. You will need to use the 'MessageRows x' plugin command to accomplish that. These notetags work for the message window only. Do not use the [auto] width and row functions with Word Wrap. Word wrap will cause them to behave erratically. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - FaceIndex Effect: \faceindex[x] - Changes the face index of the currently used face graphic to index x at the start of the message. *Note: Works for message window only. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - DigitGroup Effect: \dg[x] - Groups the number value x with commas. 12345 becomes 12,345. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - HexColor Effect: \hc[rrggbb] - Changes the text color to a hex color code using red, green, blue format. For example, pure red is \hc[ff0000]. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - PlayTime Effect: \playtime - Displays the current playtime of the player. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - MapName Effect: \map[x] - Displays the map name of Map ID x. If x is 0, it will display the name of the map the player is currently on. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
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 MV.
Here is a list of Plugin Command(s) that you may use:
You can use the following plugin commands to adjust a few of the settings regarding the Message Window. Plugin Commands --- Letter Sounds --- EnableLetterSound DisableLetterSound - These commands will enable or disable the letter sounds respectively. LetterSoundName Cursor2 - This will replace the current letter sound with the written filename. The filename is case sensitive. Do not use the file extension. LetterSoundVolume 100 - This will change the letter sound volume to 100. LetterSoundPitch 125 - This will change the letter sound pitch to 125. LetterSoundPitchVariance 10 - This will cause the letter sound's pitch to fluctuate between -10 & 10. LetterSoundPan 0 - This will change the letter sound's pan to 0. LetterSoundPanVariance 10 - This will cause the letter sound's pan to fluctuate between -10 and 10. LetterSoundInterval 2 - This will change the interval at which the letter sounds are played to 2 letters. Change it to 0 to play on every letter written out. LetterSoundReset - This will reset the letter sounds to their default settings. --- Choice Settings --- ChoiceRowMax 4 - This will set the maximum amount of visible choices to 4. HideChoice 5 - This will cause choice 5 to be hidden. ShowChoice 6 - This will cause choice 6 to be shown and no longer hidden. ClearHiddenChoices - All choices become visible and are no longer hidden. DisableChoice 1 - This will cause choice 1 to be disabled. EnableChoice 2 - This will cause choice 2 to be enabled. ClearDisabledChoices - All choices become enabled and are no longer disabled. ClearChoiceSettings - All choices are shown and enabled. --- Message Window Positions --- MessageRows 6 - Changes the Message Rows displayed to 6. If you are using continuous Show Text events, this will continue displaying the following lines's texts until it hits the row limit. Anything after that is cut off until the next message starts to avoid accidental overlap. MessageWidth 400 - Changes the Message Window Width to 400 pixels. This will cut off any words that are shown too far to the right so adjust accordingly! MessagePositionX 300 - Sets the Message Window's X Position to 300. This position will be relative to its horizontal anchor point. MessagePositionY 400 - Sets the Message Window's Y Position to 400. This position will be relative to its vertical anchor point. MessagePositionXAuto - Sets the Message Window's X Position to be automatically fitted and not set relative to its horizontal anchor point. MessagePositionYAuto - Sets the Message Window's Y Position to be automatically fitted and not set relative to its vertical anchor point. MessageAnchorX left - Sets the Message Window's x anchor to 'left', 'center', or 'right' if you are using specified coordinates. MessageAnchorY bottom - Sets the Message Window's y anchor to 'top', 'center', or 'bottom' if you are using specified coordinates. MessagePositionReset - Resets both the Message Window's X and Y Positions to its automatic positions and not adjusted to its anchor points. The Message Width and the Message Rows.
Script Calls
Script Calls are event commands that are used to run JavaScript code during an event to call upon unique functions, usually added by the related plugin.
Here is a list of Script Call(s) that you may use:
For those who would like to use script calls to alter Choice Settings, you can use the following script calls: $gameSystem.hideChoice(x) - This will cause choice x to be hidden. $gameSystem.showChoice(x) - This will cause choice x to be shown. $gameSystem.clearHiddenChoices() - This will clear all of the hidden choices and they will be shown. $gameSystem.disableChoice(x) - This will cause choice x to be disabled. $gameSystem.enableChoice(x) - This will cause choice x to be enabled. $gameSystem.clearDisabledChoices() - This will clear all of the disabled choices and they will all be enabled. $gameSystem.clearChoiceSettings() - This will clear all hidden and disabled settings.
Changelog
Version 1.12: - Updated message choices to properly show the correct number of rows if an inadequate number of rows are visible. Version 1.11: - Updated for RPG Maker MV version 1.5.0. Version 1.10a: - Fixed a bug that made auto-messages to not position themselves properly on events that are using tiles for their images. - Documentation update to fix documentation errors. Version 1.09: - Fixed a bug with the pitch and pan variance doubling its value. Version 1.08: - Fixed a bug that caused choices from 20 and onward to be hidden/disabled. Version 1.07: - Plugin commands for hiding, showing, enabling, and disabling choices will now synch with the appropriate switch if there is a switch involved. Version 1.06: - Fixed a width issue with namebox windows used for clear and dimmed nameboxes. Version 1.05: - Added new plugin commands: HideChoice x, ShowChoice x, ClearHiddenChoices, DisableChoice x, EnableChoice x, ClearDisabledChoices, ClearChoiceSettings for those who wish to have more than 20 choices. - Added new script calls. You can find them in the Lunatic Mode section under Lunatic Mode - New JavaScript Functions. These are for people who want to use more than 20 choices. Version 1.04a: - Updated the Autosizing feature to work with \{ and \} text codes. Requires v1.10 of Message Core. - Fixed a bug that caused \msgRows[auto] to crash. Version 1.03: - Fixed a bug that caused \., \|, \w[x] to not stall the \auto notetags. - Fixed a bug involving show/enable switches. Version 1.02: - Added \en[x] and \et[x] text codes to display database enemy names and troop position enemy names respectively. Version 1.01: - Fixed a bug where using an \auto text code with a \! in the same message would cause a pause with an empty message. - When using \|, \., or \w[x], the Letter Sound intervals will reset to 0 to keep the Letter Sound feeling more natural. Version 1.00: - Finished Plugin!