VCM_StateDescription

Introduction

This plugin shows a Help Window when the mouse is over the Sprite State Icons. Icons aren't changed while you do so. Clicking them will force the icon change. Allows Actors to have them, like enemies do. Help Window and Sprite State Icons are configurable. Buffs/Debuffs are included. This plugin does not affects other State Icons. No longer supported by the author.

Version -> 1.03

This plugin was tested only on RPG Maker MV Version 1.6.2. I cannot guarantee it works on lower versions.

Terms of Use:

• Available for commercial and non-commercial use
• You may freely edit the code
• You are not allowed to redistribute this plugin. Instead, provide a link(https://vcm-plugins.itch.io/vcm-statedescription)
• Do not claim this plugin as your own
• Credit is not required. However, if you want to, credit me as 'VCM Plugins'

Parameters Explanation

State Description List

This parameter defines the text that will be shown in the State Help Window when hovering over states. The order must be exactly the same as the States Database. If you don't want to display a text, simply put '\' to be allowed to edit more States. Any State Id higher than the number of entries in this parameter will have no text. Entries that don't match any State Id will be ignored, as well as States without Icons. If an Icon is used in more than one State, only one entry will be used. Text codes, such as '\C[6]' and '\n' may be used. This includes the ones in VCM_HelpWindow, if the plugin is 'ON' and above this one in the Plugin Manager.

Buff Description List

This parameter defines the text that will be shown in the State Help Window. The order must be exactly the same as the battler's parameters(Max HP, Max MP, Attack, M.Attack, Defense, M.Defense, Agility and Luck). If you don't want to display a text, simply put '\' to be allowed to edit more Buffs/Debuffs. Any Buff/Debuff Parameter Id higher than the number of entries in this parameter will have no text. Entries that don't match any Parameter Id will be ignored, as well as Buffs/Debuffs without Icons. If an Icon is used in more than one Buff or Debuff, only one entry will be used. Text codes, such as '\C[6]' and '\n' may be used. This includes the ones in VCM_HelpWindow, if the plugin is 'ON' and above this one in the Plugin Manager.

State Description Wordwrapping

This parameter enables/disables automatically break line whenever the State Help Window Text Width is higher than the Help Window Width. You can still break lines normally in the State Description List parameter. This will not break line in the middle of words. For example, "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaahhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhh" will not activate the break line and if the Text Width is higher than the
State Help Window Width, the text will be cropped.

Only One Help Window Visible

This parameter defines whether the State Help Window will appear even when the default Help Window is visible. Setting this value to No(false) will not prevent the State Help Window of being overlapped or overlap other windows.

State Help Window Position

This parameter determines the State Help Window x and y positions, as well as its width and height. All values are evals. The higher the x value, the farther it will be in the right. The higher the y value, the lower it will be. If the x or y values are higher than the game screen's width and height, respectively, it will not be visible. If x + Width <= 0 or y + Height <= 0 or Width <= 0 or Height <= 0, it will not appear.

State Help Window Windowskin

This parameter specifies which Windowskin you will use for the State Help Window. The image should be a png file located in the img\system folder. When setting the value textually, don't use the extension. For example, Window or "Window", works fine, while Window.png or "Window.png", don't. If the value is invalid, it may throw errors. Using unsuitable files may have unexpected results. For example, using "Shadow 1" as Windowskin probably will show no Window for being too small.

State Help Window Font

This parameter determines the Font Settings for the State Help Window. The parameter is an objects whose default value is {"Font":"GameFont","Font Size":"28","Italic":"false", "Text Color":"#ffffff","Text Outline Color":"rgba(0, 0, 0, 0.5)", "Text Outline Width":"4"}. Font specifies the Font Name. Even if it works on your machine without, remember to add the Font to your game if you distribute it. Font Size is a number. If its value be 0 or lower it will not appear. Putting values that aren't numbers may throw errors. Italic determines wheter the font will be in Italic(if true) or not(if false). Putting non-boolean values may throw errors. Text Color specifies the color of the text. You may use several ways to show color, such as Hex("#ffffff") or RGBA(rgba("217, 136, 74, 1")). Search about Javascript colors to learn more. Invalid values will make the Text Color be black. Text Outline Color determines the color of the text contour. The same rules of Text Color apply here. Text Outline Width specifies the width of the text contour. It is a number, and if equal to 0, it will not be visible. If lower than 0, it will appear differently. If it is too big, it may block the actual text.

State Help Window Opacity

This parameter defines the opacity of the State Help Window. The value should be a number between 0 and 255. Any value lower than 0 will be converted to 0, and any value higher than 255 will become 255. The higher the value, the more opaque is the window. With an opacity of 0, the window will become transparent, but the text will still be visible. Putting values textually that aren't numbers may throw errors.

Battle Status Window Icons

This parameter determines whether the default Actor State Icons in the Battle Status Window will appear. Draw(true) will draw the icons, else, nothing will be drawn.

Actor Sprite State Icons

This parameter specifies whether Actors will have Sprite State Icons, like enemies do. Yes(true) will create them, No(false) will do nothing.

Actor Sprite State Icons Position

This parameter determines the Actor Sprite State Icons x and y positions, starting from the actor's main sprite position.  Both values are evals. The higher the x value, the farther it will be from the actor to the right. The higher the y value, the lower it will be. Even if not in Sideview Battle, the Actor Sprite State Icons positions will not change.

Enemy Sprite State Icons Position

This parameter determines the Enemy Sprite State Icons x and y positions, starting from the enemy's sprite position.  Both values are evals. The higher the x value, the farther it will be from the enemy to the right. The higher the y value, the lower it will be.

Sprite State Icons Animation Wait

This parameter specifies how much frames it takes for the Sprite State Icons change icons. 60 frames equals to 1 second. Values lower than 1 have the same effect of 1. Non-number values may throw errors.

Compatibility

Plugin Manager line-up for maximum compatibility:
VCM_HelpWindow
VCM_PreviousTurn
VCM_BattleSave
VCM_Quicksave
VCM_MovementSpeeds
VCM_StateDescription
VCM_TermDescription
VCM_BattleMainMenu
VCM_EventHighlighting
VCM_SkillBar
VCM_MirroredSpriteset
VCM_ActionPoints
VCM_ActionOrder
VCM_EnemyGauges
VCM_MultipleGauges
VCM_ElementAffinity
VCM_AutoBattle
VCM_EnemyInfo
VCM_NumberBattlers
VCM_NoBattleLog

Versions

Version -> 1.00

Released Plugin.

Version -> 1.01

Removed console logs. Updated documentation.

Version -> 1.02

Added compatibility with VCM_TermDescription. Updated documentation.

Version -> 1.03

Updated documentation.