Welcome to PGMV! My goal is to make it easy for everyone to find and share great plugins for creating amazing games. As a plugin developer myself, I'm excited to grow this community with all of you.
MPP Message EX - MPP_MessageEX.js
Plugin desc : Extend the text display function and add display effects.
License : MIT License
Author : Mokusei Penguin
Website : http://woodpenguin.blog.fc2.com/
Desc page : https://woodpenguin.web.fc2.com/MV_Plugin/MessageEX.html
File name : MPP_MessageEX.js
Help of plugin :
* @target MV MZ
* @plugindesc Extend the text display function and add display effects.
* @author Mokusei Penguin
* @url
*
* @help [version 4.5.0]
* This plugin is for RPG Maker MV and MZ.
*
* ▼ [Display text] control characters
* ¥SP[n] # Text speed(characters per second / 0:Instant display)
* ¥AT[n] # Change animation type to n(※1)
* ¥SET[n] # Convert to the set string set(※2)
* ¥CO[S] # Display character string S as one character
* ¥RB[S,R] # Display character string S with ruby R(※3)
* ¥MX[n] # Shift the next letter X coordinate by n pixels
* ¥MY[n] # Shift the next letter Y coordinate by n pixels
* ¥PX[n] # Change the X coordinate of the next character to n
* ¥PY[n] # Change the Y coordinate of the next character to n
* ¥SW[n] # Turn on switch n
* ¥SN[n] # Replace with the name of skill ID n
* ¥SIN[n] # Replace with icon and name of skill ID n
* ¥IN[n] # Replace with the name of item ID n
* ¥IIN[n] # Replace with the icon and name of item ID n
* ¥WN[n] # Replace with the name of weapon ID n
* ¥WIN[n] # Replace with icon and name of weapon ID n
* ¥AN[n] # Replace with the name of armor ID n
* ¥AIN[n] # Replace with icon and name of armor ID n
* ¥WE # Wait until the event production is over(※4)
* ¥C[r,g,b] # Specify the font color in RGB
* ¥FS[n] # Change font size to n / Default:MV=28,MZ=26
* ¥FB # Invert font bold flag
* ¥FI # Invert font italic flag
* ¥OP[n] # Character opacity(0~255) / Default:255
* ¥OC[n] # Change the color of the character edge to n / 0:Default
* ¥OC[r,g,b] # Specify the border color of characters in RGB
* ¥OC[r,g,b,a] # Specify the border color of characters with RGBA(※5)
* ¥OW[n] # Change the thickness of the character edge / Default:4
* ¥RC[n] # Changed ruby color to n / 0:Default
* ¥RC[r,g,b] # Specify ruby color in RGB
* ¥RC[r,g,b,a] # Specify ruby color with RGBA(※5)
* ¥DF # Return the text display setting to the default value(※6)
* ¥SV # Memorize the current text display settings(※6)
* ¥LD # Calling the settings memorized by ¥SV(※6)
*
* - The following applies if it is included in the text
* ¥A # Prohibition of skipping with enter key or shift key
* ¥ES # Temporarily enable skipping event production(※7)
* ¥FO[n] # Temporarily change the fade-out type(※8)
*
* - All control characters can be in either case
*
* ▼ Control character details
* ※1: ¥AT[n] (Change animation type to n)
* - The default animation type is as follows.
* 0: Default
* 1: Letters emerge while sliding to the right
* 2: Characters are displayed while spreading horizontally
* 3: Characters are displayed while expanding
* 4: Display characters from the left side(Text speed 6 recommended)
*
* ※2: ¥SET[n] (Convert to the set string set)
* - Converts to the character string specified by the plug-in parameter
* [Text Set].
* - Control characters can also be set.
*
* ※3: ¥RB[S,R] (Display character string S with ruby R)
* - Character strings with ruby characters are displayed together,
* not individually.
*
* ※4: ¥WE (Wait until the event production is over)
* - Wait until the production of the event set in the plug-in parameter
* [Wait Effects] is completed.
* - Even if you skip sentences, weight will be applied.
*
* ※5: ¥OC[r,g,b,a] (Specify the border color of characters with RGBA)
* - Specify the alpha value (a) from 0.0 to 1.0.
*
* ※6: ¥DF, ¥SV, ¥LD (Initialize / save / recall text display settings)
* - The following information is applicable.
* - Text speed
* - Anime type
* - Font color
* - Font size
* - Font bold flag
* - Font italic flag
* - Text opacity
* - Text outline color
* - Text outline width
* - Ruby color
*
*
* ※7: ¥ES (Temporarily enable skipping event production)
* - See the plugin command SetEffectSkip for details.
*
* ※8: ¥FO[n] (Temporarily change the fade-out type)
* - See the plugin command SetMesFadeOut for details.
*
* ▼ Plugin command details
* - In MV, the variable N is referred to by writing v [N] in the item for
* inputting a numerical value.
* - In MZ, in the item to enter a numerical value, select the text and
* write v [N] to refer to the variable N.
*
* 〇 MV / MZ
*
* 〇 SetMesRow row / messageRow
* row : Number of lines in the message window (0:Do not set height)
* - Change the number of lines displayed in the message window.
*
* 〇 SetMesFadeOut type / messageFadeOut
* type : Fade out type
* - Change the fade-out type.
* - The types to specify are as follows.
* 0: Default
* 1: Gradually disappear (fast)
* 2: Gradually disappear (slow)
* 3: Scroll up
* 4: Add text below (Only when Op3 is introduced)
*
* 〇 SetEffectSkip bool / effectSkip
* bool : Enabled with true, disabled with false
* - When you skip a sentence, you can change whether to skip the production.
* - The default setting is invalid.
* - The effect to skip can be set in the plug-in parameter [Skip Effects].
* - The control character ¥ES is temporary, but it is always applied after
* the command is executed.
*
* ================================
* Mail : wood_penguin@yahoo.co.jp (@ is half-width)
* Blog : http://woodpenguin.blog.fc2.com/
* License : MIT license
*
* @command messageRow
* @desc 0:Do not set height
* @arg row
* @desc
* @type number
* @min 0
* @max 99
* @default 4
*
* @command messageFadeOut
* @desc
* @arg type
* @desc
* @type select
* @option 0:Default
* @value 0
* @option 1:Gradually disappear (fast)
* @value 1
* @option 2:Gradually disappear (slow)
* @value 2
* @option 3:Scroll up
* @value 3
* @option 4:Op3| Add text below
* @value 4
* @default 0
*
* @command effectSkip
* @desc
* @arg boolean
* @desc
* @type boolean
* @default true
*
*
* @----------------
*
* @param Text Set
* @desc An array of sets of strings to call with ¥SET
* (From the top, ¥SET[1], ¥SET[2] ...)
* @type string[]
* @default []
*
* @param Wait Effects
* @desc ¥WE Directing to wait for the end when executing
* @type struct<WaitEffects>
* @default {"Scroll Map":"true","Set Movement Route":"true","Show Animation":"true","Show Balloon Icon":"true","Move Picture":"true","Tint Picture":"true","Tint Screen":"true","Flash Screen":"true","Shake Screen":"false","Set Weather Effect":"false","Fadeout BGM":"false","Fadeout BGS":"false","Play ME":"false"}
*
* @param Skip Effects
* @desc A production that skips sentences at the same time when skipping sentences
* @type struct<SkipEffects>
* @default {"Scroll Map":"true","Set Movement Route":"true","Move Picture":"true","Tint Picture":"true","Tint Screen":"false","Flash Screen":"false","Shake Screen":"false","Set Weather Effect":"false"}
*
* @param Skip Effects Timing
* @desc
* @type select
* @option skip
* @option end of text
* @default skip
* @parent Skip Effects
*
* @param Ruby Font Size
* @desc
* @type number
* @min 4
* @max 99
* @default 14
*
* @param Ruby Oy
* @desc
* @type number
* @min -9999
* @max 9999
* @default 0
*
* @param Ruby Outline Width
* @desc
* @type number
* @min 0
* @max 99
* @default 2
*
* @param Always Leave Ruby Height
* @desc
* @type boolean
* @default false
*
* @param Default
* @desc
* @type struct<Default>
* @default {"Anime Type":"1","Message Row":"4","FadeOut Type":"0","Text Speed":"60","Outline Color":"0,0,0,0.5","Outline Width":"4","Ruby Color":"255,255,255"}
*