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 Skill Upgrade System Window - FTKR_SkillUpgradeSystem_Window.js
Plugin desc : v1.5.0 Skill Enhancement System Window Related Plugin
License : MIT License
Author : Futokoro
Desc page : https://github.com/munokura/futokoro-MV-plugins/tree/master
Download Page : https://raw.githubusercontent.com/munokura/futokoro-MV-plugins/refs/heads/master/FTKR_SkillUpgradeSystem_Window.js
File name : FTKR_SkillUpgradeSystem_Window.js
Help of plugin :
@plugindesc v1.5.0 Skill Enhancement System Window Related Plugin @author Futokoro @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 is an extension plugin for FTKR_SkillUpgradeSystem.js. By implementing this plugin， you can display a dedicated screen for the skill upgrade system， allowing you to visually upgrade your skills. ----------------------------------------------------------------------------- Setup Instructions ----------------------------------------------------------------------------- 1. Add this plugin to the "Plugin Manager." 2. The following plugins are required to run this plugin: FTKR_SkillExpansion.js (v1.2.x) FTKR_SEP_ShowSkillStatus.js (v1.3.x) FTKR_SkillUpgradeSystem_Window.js (v1.4.x) Add this plugin below those plugins. 4. FTKR_CustomSimpleActorStatus.js is required to display actor status. Add this plugin below FTKR_CustomSimpleActorStatus.js. 5. sFTKR_DisplayCommandFrame.js is required to display skill frames. Add this plugin below FTKR_DisplayCommandFrame.js. ----------------------------------------------------------------------------- Window Configuration ----------------------------------------------------------------------------- The Skill Enhancement System consists of the following windows: [When invoked from the Skills screen or subcommand field in the menu] Displays on the Skills screen when the plugin parameter <Show Skill Command: 2， 3> is set. ┌-----------─-------------------------------------┐ │ <1> │ ├-----------┬-------------------------------------┤ │ │ │ │ <2> │ <4> │ │ │ │ ├-----------┼-------------------------------------┤ │ │ <5> │ │ ├-------------------------------------┤ │ │ <6> │ │ <3> ├-------------------------------------┤ │ │ │ │ │ <6> or <7> │ │ │ (*1) │ └-----------┴-------------------------------------┘ 1. Help Window 2. Command Window 3. Skill List Window 4. Actor Status Window 5. Skill Status Title Window 6. Skill Status Window 7. Enhancement Parameter Window (*1) 8. Enhancement Confirmation Window (*2) (*1) Displayed when the plugin parameter <Always Display Cost> is set to "Display." If not displayed， the skill status window (<6>) will expand. (*2) Window displayed after selecting an enhancement type. (Only when the plugin parameter <Upgrade Disable Confirmation> is set to "Confirm.") [When invoked from the menu screen or plugin command] Displayed in the menu when the plugin parameter <Show Skill Command: 1> is set. Plugin Command <SUS Open> : Calls the Skill Enhancement System screen. : You can change actors using the 'PageUp' and 'PageDown' keys. ┌-----------┬-------------------------------------┐ │ <1> │ <4> │ ├-----------┤ │ │ ├-------------------------------------┤ │ <2> │ │ │ │ │ ├-----------┤ │ │ │ <5> │ │ │ │ │ │ │ │ <3> ├-------------------------------------┤ │ │ │ │ │ <5> or <6> │ │ │ (*1) │ └-----------┴-------------------------------------┘ 1. Actor Status Window 2. Skill Type List Window 3. Skill List Window 4. Skill Status Title Window 5. Skill Status Window 6. Enhancement Parameter Window (*1) 7. Enhancement Confirmation Window (*2) (*1) Plugin Parameter <Always Display> This command will be displayed if you set <Show by Cost> to "Display by Cost". If not， the <6> skill status window will be expanded. (*2) The window displayed after selecting the upgrade type. (Only if the plugin parameter <Upgrade Disable Confirmation> is set to "Confirm") ----------------------------------------------------------------------------- Menu Display ----------------------------------------------------------------------------- You can change the location and display method of skill upgrade commands by setting plugin parameters. <Show Skill Command> : Choose to display in the menu or skill menu. : 1 - Show in menu : 2 - Show in skill menu : Hidden otherwise. <Upgrade Skill Command Name> : Change the display name of the command. <Skill Menu Switch ID> : Use an in-game switch to turn menu display on/off. : Enter the switch ID. : Specify 0 to disable. <Upgrade Disable Confirmation> : Choose whether to display a confirmation screen when upgrading a skill. : If you select "No Confirmation，" the <Always Display Cost> setting will be disabled. : The cost window will always be displayed. <Always Display Cost> : Choose whether to always display the upgrade cost. : If you select "Display，" the upgrade parameter window will no longer be displayed. : If you select "Display，" the upgrade parameter window will no longer be displayed. <How Show Non-Ug Item> : Choose how to display non-upgradable parameters. : : The setting values are as follows. : 0 - Display as is. : 1 - Display dimmed. <Hide Not Upgrade Item> (If not upgradeable) <Hide Cannot Pay Item> (If upgrade cost is insufficient) <Hide Limit Upgrade Item> (If maximum upgrade level has been reached) : Specifies whether to hide the target parameter. : 1 - Hide， 0 - Show [Available Plugin Commands] <SUS Hide Actor x> : Hides the upgrade command for actor ID x. <SUS Show Actor x> : Shows the upgrade command for actor ID x. [Available Notetags] Applies to: Actor， Class <SUS Command Hide> : When this notetag is set， : Skill upgrade commands are hidden by default. : You can change the display to visible using a plugin command. ----------------------------------------------------------------------------- Skill List Window ----------------------------------------------------------------------------- Displays the "skill names" that can be upgraded. Skills that are disabled for upgrade via notetag will not be displayed. This can be changed with the following plugin parameter. <Skill List Width> : Sets the width of the skill list window. : The default is 240， the same as the command list. : Changing this value will automatically change the width of other linked windows. : The window width will also change. ----------------------------------------------------------------------------- Skill Status Title Window (Upgrade Title Window) --------------------------------------------------------------------------- This window displays a freely editable title line and skill Elements and descriptions. This can be changed with the following plugin parameter. The skill Elements displayed are those with a damage ID of 0. However， even if additional Elements other than skills are added， those Elements will not be displayed. <Skill Status Title Format> : Sets the title line's display content as a string. : %1 - Actor Name， %2 - Skill Name <Description Lines> : Sets the number of lines for the skill description. : Changing this also changes the height of the Skill Status window. ----------------------------------------------------------------------------- Skill Status Window ---------------------------------------------------------------------------- Displays the selected skill's status name， current buff level， maximum buff level， and status value. [Status Value Display] 1. If the buff type is "Damage" ⇒ Displays the "skill name set for each damage ID." Note that if '%1' is added to the skill name， that part will become the damage multiplier. Example: If the skill name is "Fire Attack %1%" and the damage multiplier is 100， it will be displayed as "Fire Attack 100%." 2. If the buff type is "Effect" ⇒ Displays the "Effect Name + Buff Amount." Example: If the effect is HP Recover and the buff amount is 10， the value will be "HP Recover 10." However， if the <Display> tag is set， that tag takes priority. 3. Other Cases ⇒ Display as "Buff Amount." This can be changed using the following plugin parameters. 1. Text-Related <Skill Status Text1 Format> <Skill Status Text2 Format> <Skill Status Text3 Format> : Sets the display content of the skill's skill name， level， and status value as strings. : %1 - Buff Type Name， %2 - Current Buff Level， %3 - Maximum Buff Level : %4 - Current Status Value : Depends on the <Skill Status Item Height> setting : The display position of Text1-3 changes. <Skill Status Width Rate> : Sets the ratio of the text width displayed for Text1-3. : For single-line display : Set to 1，1，1 to divide the text into three equal-width segments. : Setting this to 2，1，1 will use half of Text1 and divide the remainder in half. 3. Lines <Skill Status Line Color1> <Skill Status Line Color2> : Specifies the line color. If Color 1 and Color 2 are switched， : the line will be displayed as a gradient. : Setting this to -1 will hide the line. <Skill Status Line Gauge> : You can set whether the line will be used as a gauge showing the skill enhancement status. : The gauge color changes depending on the difference between the current level and the maximum level. 4. Frame For frame display， apply the settings from FTKR_SEP_ShowSkillStatus.js. 5. Setting the Number of Statuses to Display <Skill Status Max Cols> : Specifies the number of statuses to display per line. <Skill Status Item Height> : Specifies the number of lines to display one status. : When using a two-line display， Text1 and Text2 are displayed on the first line. : When using a three-line display， Text1 is displayed on the first line， Text2 on the second line， and Text3 on the third line. [Available Note Tags] Target: Skill <SUS Show Switch x Type: y1，y2，...> : Controls the display of the specified upgrade type with the switch's ON/OFF. : x - Switch ID : y - Upgrade type number Example: <SUS Show Switch 1 Type: 1，2，3> When Switch 1 is ON， upgrade types 1， 2， and 3 are displayed. ----------------------------------------------------------------------------- Upgrade Parameter Window ---------------------------------------------------------------------------- This window displays the upgrade parameters for the selected upgrade type. The Upgrade Parameter Window consists of up to seven lines of text， as shown below. The number of cost lines can be changed by configuring plugin parameters. 1. Title (1 line) : Free text field 2. Upgrade Parameter Title (1 line) : Free text field 3. Upgrade Parameter (1 line) : Displays the upgrade parameter. Free text field 4. Cost Title (1 line) : Free text field 5. Cost (1 or 3 lines) : Displays the set cost name， quantity， and total number of items in your inventory. This can be changed with the following plugin parameters. <Always Display Cost> : Sets whether to always display the upgrade parameter cost title and cost. : If you select "Do not display，" they will be displayed in the center of the screen along with the upgrade confirmation window when you select an upgrade type. : <Upgrade Parameter Title Format> : Enter the title line's display content as a string. : %1 - Skill Name， %2 - Upgrade Type Name <Upgrade Parameter Subtitle Format> : Enter the subtitle line's display content as a string. <Upgrade Param Text Format> : Enter the text to display in the upgrade parameter line. :%1 - Current upgrade level， %2 - Upgrade amount for current upgrade level :%3 - Next upgrade level， %4 - Upgrade amount for next upgrade level <Upgrade Param CostTitle Format> : Enter the text to display in the cost title. <Upgrade Param CostItem Format> : Enter the text to display in the cost item. <Upgrade Param MaxLv Message> : Enter the message to display in the upgrade parameter line when the maximum upgrade level is reached. : Enter the message as a string. : This content replaces the content of the upgrade parameter line. <Upgrade Param Cost Lines> : Specifies the layout of up to three costs. : parallel - Displays one cost per line， arranged in three lines. : series - Arranges three costs per line. : series changes the height of the upgrade parameter window. [Displayed Cost Icon] When displaying a cost name， a cost icon will be added to the beginning of the cost name. If the cost is an item， the icon set for that item will be displayed. If the cost is Gold or a variable， the plugin parameter setting in FTKR_SEP_ShowSkillStatus.js will be used. ----------------------------------------------------------------------------- Upgrade Confirmation Window ----------------------------------------------------------------------------- This window appears when selecting a skill upgrade. You can change this with the following plugin parameters. <Confirmation Title Format> : Sets the text to be displayed upon confirmation. : %1 - Actor name， %2 - Skill name <Confirmation Ok Format> : Sets the display content for the "Execute" confirmation command. <Confirmation Cancel Format> : Sets the display content for the "Cancel" confirmation command. ----------------------------------------------------------------------------- Actor Status Window --------------------------------------------------------------------------- When the skill enhancement screen is invoked from the menu screen or a plugin command， the layout of the Actor Status Window displayed uses the plugin parameter settings in FTKR_SEP_ShowSkillStatus.js. ----------------------------------------------------------------------------- Control Characters Usable in Plugin Parameters ----------------------------------------------------------------------------- This plugin allows you to set the content displayed in the window's text field using plugin parameters. By adding the following control characters to the string， you can further customize the text format. [Usable Plugin Parameters] Parameter names containing the word Format. [Control Characters Available] Note: Control characters are case-sensitive. 1. Change String Width ￥l[x] : Changes the string width to x. : x is the size of a single-byte character. : It is written as 'Enhanced Size￥l[5]'. : : By default， single-byte characters are converted to 1 and double-byte characters to 2. : The optimal width is automatically set. : In the above example， the text will be displayed at half its normal size. ￥lR[x] : Changes the string width to x and aligns it to the right. ￥lC[x] : Changes the string width to x and aligns it to the center. 2. Change Text Color ￥c[x] : Changes the displayed text color to x. : The relationship between the number and color is the same as the standard color number in RPG MV. : The default is white text (x = 0). 3. Change Font Size ￥s[x]: Changes the font size to x% of the default size. : Expressed as 'Level￥s[60]'. : The default font size is 28. ￥sb[x]: Changes the font size to x% of the default size : Aligns it to the bottom of the display line. ￥sp[x]: Changes the font size to x% of the default size : Aligns it to the top of the display line. 4. Change the display position (only effective if no other control characters are used) ￥R: Right-aligns. ￥C: Center-aligns. 5. Formatting Separators ￥n: If you want to use multiple colors or sizes for a single string， : By adding this control character to a sentence， you can separate the strings at the point where you added it and apply different formatting to each string. Example: 'Enhanced￥nType' ⇒ Separating 'Enhanced' and 'Type' [Examples of Control Character Usage] 1. Using a single control character without a separator 'Enhanced Type￥c[16]': In this case， all 'Enhanced Type' characters will be colored 16. 2. Using multiple control characters of the same type without a separator 'Enhanced￥c[16]Type￥c[17]' : In this case， the first ￥c[16] is applied， changing all 'Enhanced Type' characters to color 16. 3. Using a single control character with a separator 'Enhanced￥c[16]￥nType' : In this case， 'Enhanced' and 'Type' are separated， 'Enhanced' characters will be colored 16， and 'Type' will remain the default color. 4. When using multiple control characters of the same type with a separator 'Enhanced￥c[16]￥nType￥c[17]' : In this case， 'Enhanced' and 'Type' are separated， and 'Enhanced' will be colored 16， and 'Type' will be colored 17. 5. When using multiple control characters of different types 'Enhanced Type￥c[17]￥s[60]' : In this case， 'Enhanced Type' will be colored 16 for all occurrences， and the font size will be reduced to 60%. ----------------------------------------------------------------------------- Sound Effects Settings When Executing an Enhancement ----------------------------------------------------------------------------- The sound effects played when an enhancement is executed can be changed in type， volume， pitch， and phase. You can change the format using the following plugin parameters: <Upgrade SE Name>: Changes the type of sound effects used. : Enter the name of the sound effects you want to use. <Upgrade SE Volume>: Changes the sound effects volume. <Upgrade SE Pitch>: Changes the sound effects pitch. <Upgrade SE Pan>: Changes the phase of the SE. ----------------------------------------------------------------------------- Setting the Parameter Display Name ----------------------------------------------------------------------------- Parameter names displayed on the screen， such as "Skill Status Name" and "Damage Type Name，" use the names set in the FTKR_SEP_ShowSkillStatus.js plugin parameters. ----------------------------------------------------------------------------- License for this Plugin ----------------------------------------------------------------------------- This plugin is released under the MIT License. Copyright (c) 2017 Futokoro http://opensource.org/licenses/mit-license.php ----------------------------------------------------------------------------- About the Plugin Help ----------------------------------------------------------------------------- For information on how to set upgrade parameters and use note tags， please refer to the separate file "FTKR_SkillUpgradeSystem_Core.js." ----------------------------------------------------------------------------- Change History ----------------------------------------------------------------------------- v1.5.0 - October 4， 2017: Traits Additions 1. Added bulk enhancement functionality. v1.4.1 - August 5， 2017: Bug Fixes 1. Fixed a bug that prevented enhancement types set for skills from being enhanced from being hidden. 2. Fixed a bug that allowed enhancements to be performed ignoring cost and maximum level when the "No confirmation" setting was enabled. v1.4.0 - March 16， 2017: Processing Review and Added Traits 1. Reviewed processing to match FTKR_SEP_ShowSkillStatus.js v1.3.0. 2. Changed frame display processing to read from FTKR_SEP_ShowSkillStatus.js. 3. Added a function to display the skill enhancement screen via subcommands. 4. Revised help content. v1.3.0 - 2017/02/24: Processing revised 1. Processing revised to match FTKR_SkillExpansion.js v1.1.0. v1.2.1 - 2017/02/20: Bug fixes 1. Fixed a typo in the drawElement function. 2. Revised the Help content. v1.2.0 - 2017/02/19: Implemented FTKR_SkillExpansion.js (94.9kB) 1. Revised the processing to match FTKR_SkillExpansion.js. 2. Revised the Help content. v1.1.0 - 2017/02/15: Bug fixes， Traits changes， and additions (95.9kB) 1. Fixed an issue where the Enhancement Execution Sound Effect would not play correctly. 2. Changed the display settings for non-enhanceable parameters. 3. Added a Traits to control the ON/OFF display of enhancement types with a switch. 4. Added fixes for FTKR_SkillUpgradeSystem_Core v1.5.0. 5. Corrected the version number to match the version notation of FTKR_SkillUpgradeSystem_Core. (v1.02 is considered v1.0.2) v1.02 - 2017/02/13: Added display settings for non-enhanceable parameters (94.0kB) v1.01 - 2017/02/12: Changed the layout of the skill enhancement screen， and made other minor changes (92.5kB) 1. Changed the layout of the skill enhancement screen. 2. Changed the menu screen to display skill enhancement commands. 3. Added a Traits to display a confirmation window when performing a skill enhancement. 4. Corrected the help information. 5. Some function names were revised. 6. Added text width to the Window_Base.drawFormatText argument， adding a function to automatically adjust the text width. 7. Modified the display position control characters so that they can be used in combination with string width control characters. v1.00 - 2017/02/08: First version created (63.3kB) 1. This plugin was created by separating window-related functions from FTKR_SkillUpgradeSystem.js. ----------------------------------------------------------------------------- @param ---Show Command--- @param Show Skill Command @desc Where in the menu bar should the skill enhancement command be added? 1 - Menu bar， 2 - Skill menu bar， 3 - Subcommand bar @default 2 @param Upgrade Skill Command Name @desc Set the command name for the skill enhancement command. @default Upgrade Skill @param Skill Menu Switch ID @desc Specify the switch ID that controls whether the menu column display is on or off. @default 0 @param Upgrade Disable Confirmation @desc When executing a skill enhancement， whether to confirm the execution on the confirmation screen. 1 - Confirm， 0 - Do not confirm (cost is always displayed) @default 1 @param Always Display Cost @desc Always show reinforcement cost. 1 - Show， 0 - Don't show @default 0 @param How Show NonUg Item @desc Specifies whether to dim parameters that cannot be enhanced. 0 - Do not change， 1 - Dim @default 0 @param Hide Not Upgrade Item @desc Specifies whether to hide parameters that cannot be enhanced. 1 - Do not display， 0 - Display @default 0 @param Hide Cannot Pay Item @desc Specifies whether to hide parameters with insufficient reinforcement cost. 1 - Do not display， 0 - Display @default 0 @param Hide Limit Upgrade Item @desc Specifies whether to hide parameters that have reached the maximum enhancement level. 1 - Do not display， 0 - Display @default 0 @param --Skill List Window-- @param Skill List Width @desc Specifies the width of the skill list window. Default is 240 @default 240 @param --Skill Status Title Window-- @param Skill Status Title Format @desc Describe the title display content as a string. %1 - Actor name， %2 - Skill name @default [%2]のスキル情報￥c[16] @param Discription Lines @desc Set the number of lines for the skill description. @default 2 @param --Skill Status Window-- @param Skill Status Text1 Format @desc Describes the display content of Text 1 of the skill status. See the help for details. @default %1 @param Skill Status Text2 Format @desc Describes the display content of Text 2 of the skill status. See the help for details. @default LV￥sb[60]￥l[2]￥n%2￥lR[2]￥n/￥c[17]￥nMAX￥sb[60]￥c[17]￥n%3￥lR[2]￥c[17] @param Skill Status Text3 Format @desc Describes the display content of Text 3 of the skill status. See Help for details. @default %4 @param Skill Status Width Rate @desc The ratio of the text width to Show Text 1 to 3. Separate them with a comma (，) @default 1，1，1 @param Skill Status Line Color1 @desc Specifies the line color 1. If you set it to -1， the line will not be displayed. @default 17 @param Skill Status Line Color2 @desc Specifies the line color 2. If you set it to -1， the line will not be displayed. @default 17 @param Skill Status Line Gauge @desc Whether to use the line as a gauge depending on skill level. 1 - Gauge， 0 - Do not use a gauge @default 0 @param Skill Status Max Cols @desc Specify the number of statuses to display per line (minimum 1， maximum 3). @default 1 @param Skill Status Item Heigth @desc Specify the number of lines to display one status (minimum 1， maximum 3). @default 1 @param --Upgrade Param Window-- @param Upgrade Param Title Format @desc Describe the title display content as a string. %1 - Skill name， %2 - Enhancement type name @default Information about [%2]￥c[16] @param Upgrade Param SubTitle Format @desc Describe the display content of the parameter title as a string. @default Enhancement value:￥c[16] @param Upgrade Param Text Format @desc Describe the display content as a string. See the help for format parameters. @default ￥l[2]￥nLV￥n%1￥lR[2]￥n:￥n%2￥lR[6]￥n⇒￥l[2]￥C￥nLV￥n%3￥lR[2]￥n:￥n%4￥lR[6] @param Upgrade Param CostTitle Format @desc Enter the cost title to be displayed as a string. @default Cost:￥c[16] @param Upgrade Param CostItem Format @desc Describe the cost display content as a string. %1 - Cost name， %2 - Cost quantity， %3 - Cost on hand @default %1￥l[16]￥n%2￥lR[3]￥c[17]￥n%3￥c[17]￥lR[5] @param Upgrade Param MaxLv Message @desc Describes the content to be displayed when the maximum enhancement level is reached. @default ￥l[2]￥nIt cannot be further strengthened @param Upgrade Param Cost Lines @desc Specify how to arrange the three costs: parallel - arrange them in three lines， series - combine them into one line， @default parallel @param --Confirmation Window-- @param Confirmation Title Format @desc Describes the confirmation content when skill enhancement is executed. %1 - Actor name， %2 - Skill name @default Checking skill enhancement @param Confirmation Ok Format @desc Describes what will be displayed when you click "Execute" in the confirmation command. @default Ok @param Confirmation Cancel Format @desc Describes the display content of the confirmation command "Do not execute." @default Cancel @param --Upgrade SE-- @param Upgrade SE Name @desc Specify the name of the sound effect to be played when the enhancement is executed. @default Sound2 @param Upgrade SE Volume @desc Specifies the volume of the sound effect that will be played when the enhancement is performed. @default 90 @param Upgrade SE Pitch @desc Specifies the pitch of the sound effect that will be played when the enhancement is performed. @default 100 @param Upgrade SE Pan @desc Specifies the phase of the sound effect that will be played when the enhancement is executed. @default 0