Icon Description - IconDescription.js

Plugin desc : Icon Description Plugin

License : MIT License

Author : Triacontane

Website : https://triacontane.blogspot.com/

Desc page : https://triacontane.blogspot.com/

Download Page : https://raw.githubusercontent.com/munokura/triacontane-MV-plugins/refs/heads/main/IconDescription.js

File name : IconDescription.js

Help of plugin :

@plugindesc Icon Description Plugin
@author Triacontane
@url https://github.com/triacontane/RPGMakerMV/tree/mz_master/IconDescription.js
@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/triacontane-MV-plugins ).
Original plugin by Triacontane.
Please check the latest official version at:
https://triacontane.blogspot.com
-----

You can display a popup with the description text for an icon.
Click or hold down an icon to display the popup.
Any icon displayed by default,
such as a message window or status window, will be eligible for the popup,
but icons displayed by other plugins may not be displayed.

Terms of Use:
You may modify and redistribute this plugin without permission from the
author, and there are no restrictions on its use (commercial, 18+, etc.).
This plugin is now yours.

@param list
@text Icon Description List
@desc A list of icon descriptions.
@default []
@type struct<Description>[]

@param fontSize
@text Font size
@desc Font size for the icon description window. Specify 0 for the default size.
@default 22
@type number

@param padding
@text margin
@desc Margins for the icon description window. Specify 0 for the default margins.
@default 8
@type number

@param backOpacity
@text background opacity
@desc The background opacity of the icon description window. Specify 0 for the default opacity.
@default 0
@type number

@param triggerType
@text Trigger Type
@desc This is a trigger to display the icon explanation window. Mouse over only works in a PC environment.
@default click
@type select
@option click
@value click
@option Keep pressing
@value press
@option Mouseover
@value hover

@param se
@text sound effects
@desc This is the sound effect that plays when the icon description window is displayed.
@type struct<SE>
*/


/*~struct~Description:
@param iconIndex
@text icon
@desc The index of the icon to display the description for.
@default 1
@type icon

@param caption
@text Explanatory text
@desc This is the description of the icon. Control characters can be used.
@type multiline_string
*/

/*~struct~SE:
@param name
@text SE file name
@desc The file name of the SE.
@type file
@require 1
@dir audio/se/

@param volume
@text SE Volume
@desc This is the volume of the SE.
@default 90
@type number
@min 0
@max 100

@param pitch
@text SE Pitch
@desc This is the SE pitch.
@default 100
@type number
@min 50
@max 150

@param pan
@text SE Balance
@desc This is the left and right balance of the SE.
@default 0
@type number
@min -100
@max 100

munokura

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.