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.
FTKR Popup Sprite Message - FTKR_PopupSpriteMessage.js
Plugin desc : v1.2.5 A plugin that pops up any message on the screen
License : MIT License
Author : Futokoro
Desc page : https://github.com/munokura/futokoro-MV-plugins
Download Page : https://raw.githubusercontent.com/munokura/futokoro-MV-plugins/refs/heads/master/FTKR_PopupSpriteMessage.js
File name : FTKR_PopupSpriteMessage.js
Help of plugin :
@plugindesc v1.2.5 A plugin that pops up any message on the screen
@author Futokoro
@url https://github.com/munokura/futokoro-MV-plugins
@license MIT License
@help
English Help Translator: munokura
This is an unofficial English translation of the plugin help，
created to support global RPG Maker users.
Feedback is welcome to improve translation quality
(see: https://github.com/munokura/futokoro-MV-plugins ).
Original plugin by Futokoro.
Please check the URL below for the latest version of the plugin.
URL https://github.com/futokoro/RPGMaker
-----
-----------------------------------------------------------------------------
Overview
-----------------------------------------------------------------------------
This plugin pops up any text string at any position on the screen.
It can be displayed on both the map screen and the battle screen.
You can also display each character of the text at a different time during the pop-up.
You can perform the following operations on the pop-up text:
1. Move (including moving it from off-screen and off-screen)
2. Change the angle and rotate
3. Change the color and transparency
4. Delete
This plugin is based on Triacontan's BattleEffectPopup.js (v1.7.1).
-----------------------------------------------------------------------------
Setup Instructions
-----------------------------------------------------------------------------
1. Add this plugin to the "Plugin Manager."
-----------------------------------------------------------------------------
How to Use
-----------------------------------------------------------------------------
1. Specify the popup settings in the plugin parameter "Popup Message Status."
2. Display the popup with the following plugin command:
*[] are not used for actual input.
PSM_SHOW_POPUP [popupId] [statusId] [x] [y] [duration] [text] [options]
Popup ID (popupId)
: Specify any number from 1 to the value set in the plugin parameter Max Popup Messages.
You can also specify a variable with ￥v[n].
By changing this value， you can display multiple text strings simultaneously.
Popup Setting ID (statusId)
: Recalls the value set in the plugin parameter Popup Message Status.
Specify the value [List Number - 1] during setup.
You can also specify a variable with ￥v[n].
X Coordinate， Y Coordinate
: Specify the coordinates on the screen where the popup will be displayed.
You can also specify a variable with ￥v[n].
By default， the origin is the upper left corner of the text， but you can change it to the center of the text by adding -c to the options section.
Display Duration (Duration)
: Specifies the duration the popup is displayed.
It will automatically disappear after the time specified here has elapsed.
You can also specify a variable using ￥v[n].
If you specify -1， the popup will not disappear after a certain amount of time.
In this case， you will need to use a separate plugin command to clear it.
Text (Text)
: Specifies the content of the popup.
Half-width spaces are not allowed.
To include a half-width space， enter ￥_ (underscore).
The following control characters are also supported:
￥v[n] ￥N[n] ￥P[n] ￥G
Options (Options)
: You can also add the following strings at the end. (In any order.)
Please leave a half-width space between option strings.
-c: The specified coordinate will be the center of the text.
If not entered， the coordinates will be the upper left corner of the string.
-s: Waits until the display is complete.
This is invalid if the display time is set to -1.
You can also specify parameters directly using the following command without using the popup setting ID.
PSM_SHOW_POPUP_B [popupId] [x] [y] [duration] [text] [fontFace] [fontSize] [color] [italic] [outlineColor] [popupHeight] [offsetWait] [opacity] [options]
The parameters after font (fontFace) have the same meaning as the plugin parameters.
Please note the input format for the following parameters.
Font (fontFace)
: If not specified， enter -1.
Text Color (color)
: Enter red， blue， green， or gray.
Each value must be between 0 and 255. Spaces are prohibited.
Example: 255，0，0，100
Italic (italic)
: Enter true or false.
True for italic display.
Outline Color (outlineColor)
: Enter -1 for no outline.
2. Move the popup using the following plugin command.
*The brackets [] are not used for actual input.
PSM_Move_Popup [popupId] [x] [y] [duration] [options]
Popup ID (popupId)
: Specify the ID of the popup you want to move.
You can also specify variables using ￥v[n].
X Coordinate， Y Coordinate
: Specify the coordinates on the screen to which the popup will be moved.
You can also specify variables using ￥v[n].
Duration
: Specify the duration for the popup to be moved.
You can also specify variables using ￥v[n].
Specifying 0 will move it immediately.
Options
: You can also enter the following strings at the end.
-s: Wait until the movement is complete.
3. Rotate the popup using the following plugin command.
*[] are not used for actual input.
PSM_ROTATE_POPUP [popupId] [angle] [rotate]
Popup ID
: Specify the popup ID you want to rotate.
You can also specify variables using ￥v[n].
Angle (angle)
: Specifies the increment/decrement for rotating the popup. (0 - 359)
You can also specify a variable with ￥v[n].
Positive values rotate the popup clockwise， starting from the top left corner.
Rotate (rotate)
: Specifies whether to rotate the popup.
Setting this to true will continue rotating the popup by the specified angle.
Setting this to false will change the popup to the specified angle.
4. Use the following plugin command to change the popup's color and transparency.
*[] are not used for actual input.
PSM_CHANGECOLOR_POPUP [popupId] [tone] [opacity] [duration] [options]
Popup ID (popupId)
: Specifies the popup ID you want to move.
You can also specify a variable with ￥v[n].
Tone (tone)
: Specifies the popup's color. Enter values in the format red， blue， green， gray.
Each value must be between 0 and 255. Spaces are prohibited.
Example: 255，0，0，100
Entering -1 will leave the color unchanged.
Opacity
: Specifies the transparency of the popup.
You can also specify a variable using ￥v[n].
Entering -1 will leave the transparency unchanged.
Duration
: Specifies the time over which the popup's color and transparency change.
You can also specify a variable using ￥v[n].
Specifying 0 will result in an immediate change.
Options
: You can also enter the following strings at the end.
-s: Waits until the change is complete.
4. Use the following plugin command to clear the popup.
*[] are not used for actual input.
PSM_ERASE_POPUP [popupId] [duration] [options]
Popup ID (popupId)
: Specifies the popup ID you want to erase.
You can also specify a variable with ￥v[n].
Duration (duration)
: Specifies the duration for the popup to be erased.
It will automatically disappear after the specified time has elapsed.
You can also specify a variable with ￥v[n].
If not specified or set to 0， it will disappear immediately.
Options (options)
: You can also enter the following string at the end:
-s : Waits until the erasure is complete.
-----------------------------------------------------------------------------
About Menu Opening and Closing and Popup Display
-----------------------------------------------------------------------------
If you open or close a menu while a popup is displayed， the popup will disappear.
You can have the popup reappear after opening and closing the menu by setting the plugin parameter <Repop Message After Menu> to "Show."
The specifications for redisplaying menus after opening and closing are as follows:
1. Pop-up bouncing and the single-character display function are disabled. (Displays immediately.)
2. If you open or close a menu while a popup is moving， the move is canceled and the popup redisplays in the new location.
3. If you open or close a menu while a popup is rotating， it will re-rotate from its initial position.
If the angle has been changed， that angle will be maintained.
-----------------------------------------------------------------------------
About wait command setting times and popup operation command execution times
----------------------------------------------------------------------------
Pop-up operations (moving， rotating， color change) are processed for a very short time (1 wait time) even if the execution time (duration) of each operation is set to 0.
For this reason， when inserting a wait command after an operation command，
set the wait time to at least 1 plus the execution time.
Note that if the next operation is executed before the execution of a previous operation is completed，
the previous operation will be immediately terminated before the next operation is executed.
Example)
If a command to move a popup text displayed at point A to point B is being executed (partway between points A and B)， and a command to move it to point C is executed，
it will immediately be moved to B， and then from B to C.
-----------------------------------------------------------------------------
License for this Plugin
-----------------------------------------------------------------------------
This plugin is released under the MIT License.
Copyright (c) 2018 Futokoro
http://opensource.org/licenses/mit-license.php
Plugin Publisher
https://github.com/futokoro/RPGMaker/blob/master/README.md
-----------------------------------------------------------------------------
Change History
-----------------------------------------------------------------------------
v1.2.5 - 2018/08/11: Bug Fixes
1. Added a process to prevent errors when running the game from save data before the plugin was applied.
v1.2.4 - 2018/03/10: Bug fixes and Traits additions
1. Fixed an issue where executing a move command to another location while a popup was being moved would cancel the previous move and move it from its initial position.
2. Added a note to the Help regarding popup operation execution time and wait time.
3. Added a function to set the center coordinates of text to the popup display command.
4. Added a function to wait for event processing until the popup operation is complete.
v1.2.3 - 2018/03/03: Bug fixes
1. Fixed an issue where the color and transparency would revert to their original state when opening or closing a menu.
v1.2.2 - 2018/03/03: Bug fixes and Traits additions
1. Fixed an incorrect method for specifying the color of the text border. Changed the default value of the plugin parameter.
2. Added a command to change the color and transparency of the popup.
3. Added a command to directly set popup display parameters.
v1.2.1 - 2018/02/28: Help revisions
1. Fixed an error in the description of the popup setting ID in the popup display plugin command description.
v1.2.0 - 2018/02/25: Traits additions
1. Added a function to redisplay popups after opening and closing a menu.
v1.1.1 - 2018/02/24: Bug fixes
1. Fixed an issue where $gameParty was not initialized correctly.
v1.1.0 - 2018/01/06: Traits additions
1. Added a function to prevent popups from disappearing over time and a command to clear them.
2. Added commands to move and rotate popups.
v1.0.0 - 2018/01/05: Initial version created
-----------------------------------------------------------------------------
@param Max Popup Messages
@desc Number of characters that can be displayed on the screen
@default 10
@param Popup Message Status
@desc Pop-up display settings Multiple patterns can be set and called with a plug-in command
@default ["{￥"fontFace￥":￥"￥"，￥"fontSize￥":￥"28￥"，￥"color￥":￥"[￥￥￥"0￥￥￥"，￥￥￥"0￥￥￥"，￥￥￥"0￥￥￥"，￥￥￥"0￥￥￥"]￥"，￥"italic￥":￥"false￥"，￥"outlineColor￥":￥"15￥"，￥"popupHeight￥":￥"40￥"，￥"duration￥":￥"90￥"}"]
@type struct<popup>[]
@param Repop Message After Menu
@desc Whether to display the popup again after opening and closing the menu
@default false
@type boolean
@on Display
@off Do not display