State Tooltips VisuStella MZ

From Yanfly.moe Wiki
Jump to navigation Jump to search

Welcome to the wiki! This is where you can find resources from Yanfly.moe, Ækashics.moe,
VisuStella, Caz Wolf, Fallen Angel Olivia, Atelier Irina, and other affiliated content creators.



Download

System

This is a plugin created for RPG Maker MZ.

Click here for help on how to install plugins and an explanation on the Tier Hierarchy System.


UpdatePlugins.png

Click here to learn how to update plugins.


Troubleshooting.jpg

Click here for how to troubleshoot plugins if you get an error.



StateTooltip Animated.gif

Required Plugins

The following plugins are required in order to use this plugin.

Place the following plugins above this plugin located in the Plugin Manager.


VisuStella MZ

This plugin is a part of the VisuStella MZ Plugin Library.


Support VisuStella

Click here if you want to help support VisuStella on Patreon.


Introduction

StateTooltip Animated.gif

This plugin adds a tooltip window in battle (and other scenes) whenever the player's mouse cursor is hovered over specific areas of the screen. The tooltip window will display a list of the states, buffs, and debuffs the hovered battler has along with a description of the entities and their remaining duration.

Features include all (but not limited to) the following:

  • Tooltip window displays when hovering over battlers and specific windows to display their states, buffs, and debuffs.
  • Adjust the text format in which information is displayed inside the tooltip window.
  • Modify the descriptions for states, buffs, and debuffs to your liking.

Requirements

This plugin is made for RPG Maker MZ. This will not work in other iterations of RPG Maker.

Required Plugin List

This plugin requires the above listed plugins to be installed inside your game's Plugin Manager list in order to work. You cannot start your game with this plugin enabled without the listed plugins.


Tier 3

This plugin is a Tier 3 plugin. Place it under other plugins of lower tier value on your Plugin Manager list (ie: 0, 1, 2, 3, 4, 5).

This is to ensure that your plugins will have the best compatibility with the rest of the VisuStella MZ Plugin library.


Extra Features

There are some extra features found if other VisuStella MZ plugins are found present in the Plugin Manager list.

---

Party System VisuStella MZ

Class Change System VisuStella MZ

These plugins have scenes that also support tooltips if this plugin is also installed while those are active in your game's project.

---

VisuStella MZ Compatibility

While this plugin is compatible with the majority of the VisuStella MZ plugin library, it is not compatible with specific plugins or specific features. This section will highlight the main plugins/features that will not be compatible with this plugin or put focus on how the make certain features compatible.

---

Dragonbones Union VisuStella MZ

If you are using a Dragonbones Battler and want to apply a state tooltip to it, the access area of the battler will be based on the hitbox size you declare for the Dragonbones Battler with notetags. This is because all Dragonbones battlers do not have innate automatically calculated hitbox sizes as a result of their dynamically animated nature.

Please refer to the notetag section of the Dragonbones Union plugin for Dragonbones Battler hitboxes to learn how to apply hitbox sizes.

---

Notetags

RPG Maker MZ's editor is unable to allow for custom traits/properties that a game dev may wish to associate with a database object, event, map, etc. Notetags are used to work around such limitations by allowing the game dev to tag certain traits/properties using specific Notetags declared by the related plugin.

Here is a list of Notetag(s) that you may use.


The following are notetags that have been added through this plugin. These notetags will not work with your game if this plugin is OFF or not present.

---

Description-Related Notetags

StateTooltip Animated.gif

---

<Help Description>
 text
 text
</Help Description>

- Used for: State Notetags
- Assigns a help description for the state.
- Replace 'text' with text you want displayed for the tooltip window.
- This best works with one line.
- If this notetag is not used, the help description will default to the
  setting found in the plugin's Plugin Parameters.
- Insert %1 into the help description to show any data that would otherwise
  be shown as the state display, such as Absorption Barrier count.

---

<Exclude From Tooltips>

- Used for: State Notetags
- Excludes the state from being displayed in the state tooltips.

---

Plugin Parameters

Tooltip Settings

StateTooltip Animated.gif

StateTooltips Param1.png

General settings for the State Tooltips Window.

---

Appearance

 Scale:
 - What scale size do you want for the tooltip?
 - Use 1.0 for normal size.
 Skin Filename:
 - What window skin do you want to use for the tooltip?
 Skin Opacity:
 - What opacity setting is used for the tooltip?
 - Use a number between 0 and 255.

---

Offset

 Offset X:
 - Offset the tooltip X position from the mouse?
 - Negative: left. Positive: right.
 Offset Y:
 - Offset the tooltip Y position from the mouse?
 - Negative: up. Positive: down.

---

Vocabulary Settings

StateTooltip Animated.gif

StateTooltips Param2.png

Vocabulary settings for the State Tooltips Window.

---

General

 Default Description:
 - This is the default description that appears for a state without a
   declared description. %1 - State's Name
 - Can use text codes.

---

Entries

 State Format:
 - Can use text codes.
 - %1 - Icon, %2 - Name, %3 - Description, %4 - Duration, %5 - State Color
 Buff Format:
 - Can use text codes.
 - %1 - Icon, %2 - Name, %3 - Percentage, %4 - Duration, %5 - Buff Color
 Debuff Format:
 - Can use text codes.
 - %1 - Icon, %2 - Name, %3 - Percentage, %4 - Duration, %5 - Debuff Color
 Replace Whites?:
 - If state, buff, debuff names are white, replace them?
   Replacement Color:
   - Use #rrggbb for custom colors or regular numbers for text colors from
     the Window Skin.

---

Turns Remaining

 Action End Format:
 - Can use text codes.
 - %1 - Remaining, %2 - State/Buff/Debuff Color
 Turn End Format:
 - Can use text codes.
 - %1 - Remaining, %2 - State/Buff/Debuff Color
 Passive Text:
 - Can use text codes.

---

Window Settings

StateTooltip Animated.gif

StateTooltips Param3.png

Choose which windows to enable tooltip support for.

---

Settings

 Window_BattleStatus:
 Window_ClassStatus:
 Window_EquipStatus:
 Window_MenuActor:
 Window_MenuStatus:
 Window_PartyStatus:
 Window_SkillStatus:
 Window_Status:
 - Enable State Tooltips for this window?

---


Terms of Use

1. These plugins may be used in free or commercial games provided that they have been acquired through legitimate means at VisuStella.com and/or any other official approved VisuStella sources. Exceptions and special circumstances that may prohibit usage will be listed on VisuStella.com.

2. All of the listed coders found in the Credits section of this plugin must be given credit in your games or credited as a collective under the name: "VisuStella".

3. You may edit the source code to suit your needs, so long as you do not claim the source code belongs to you. VisuStella also does not take responsibility for the plugin if any changes have been made to the plugin's code, nor does VisuStella take responsibility for user-provided custom code used for custom control effects including advanced JavaScript notetags and/or plugin parameters that allow custom JavaScript code.

4. You may NOT redistribute these plugins nor take code from this plugin to use as your own. These plugins and their code are only to be downloaded from VisuStella.com and other official/approved VisuStella sources. A list of official/approved sources can also be found on VisuStella.com.

5. VisuStella is not responsible for problems found in your game due to unintended usage, incompatibility problems with plugins outside of the VisuStella MZ library, plugin versions that aren't up to date, nor responsible for the proper working of compatibility patches made by any third parties. VisuStella is not responsible for errors caused by any user-provided custom code used for custom control effects including advanced JavaScript notetags and/or plugin parameters that allow JavaScript code.

6. If a compatibility patch needs to be made through a third party that is unaffiliated with VisuStella that involves using code from the VisuStella MZ library, contact must be made with a member from VisuStella and have it approved. The patch would be placed on VisuStella.com as a free download to the public. Such patches cannot be sold for monetary gain, including commissions, crowdfunding, and/or donations.

7. If this VisuStella MZ plugin is a paid product, all project team members must purchase their own individual copies of the paid product if they are to use it. Usage includes working on related game mechanics, managing related code, and/or using related Plugin Commands and features. Redistribution of the plugin and/or its code to other members of the team is NOT allowed unless they own the plugin itself as that conflicts with Article 4.

8. Any extensions and/or addendums made to this plugin's Terms of Use can be found on VisuStella.com and must be followed.

Terms of Use: Japanese


『VisuStella MZ』利用規約

1. これらのプラグインは、VisuStella.comおよび/または公式に承認されたVisuStellaのソースから合法的な手段で入手したものである限り、フリーゲームや商用ゲームに使用することができます。例外的に使用が禁止される場合については、VisuStella.comの記載をご確認ください。

2. 本プラグインの「クレジット」部分に記載されているすべてのコーダーの名前は、ゲーム内にクレジット表記を行うか、もしくは「VisuStella」という名前の下にまとめて表記する必要があります。

3. ソースコードを自分のものだと主張しない限りは、必要に応じて編集することが可能です。ただしプラグインのコードに変更が加えられた場合、VisuStellaはそのプラグインに対して一切の責任を負いません。高度なJavaScriptのノートタグやJavaScriptコードを許可するプラグインのパラメータを含む、カスタムコントロールエフェクトに使用される、ユーザー提供のカスタムコードについても、VisuStellaは一切の責任を負いません。

4. これらのプラグインやプラグイン内のコードを、「自分のもの」として再配布したり使用したりすることはできません。これらのプラグインとそのコードは、VisuStella.comおよび、その他の公式/承認済みVisuStellaソースからのみダウンロードすることができます。公式/承認済みのソースのリストは、VisuStella.comでご確認いただけます。

5. VisuStellaは、意図しない使用方法による問題、VisuStella MZライブラリ以外のプラグインとの非互換性の問題、プラグインのバージョンが最新でないことによる問題、第三者による互換性パッチが適切に動作していないことなどが原因でゲーム内で発生した問題については、一切の責任を負いません。VisuStellaは、高度なJavaScriptのノートタグやJavaScriptコードを許可するプラグインのパラメータを含む、カスタムコントロールエフェクトに使用される、ユーザー提供のカスタムコードに起因するエラーについても、一切の責任を負いません。

6. VisuStella MZライブラリのコードを使用した互換性パッチをVisuStellaとは関係のない第三者を通じて作成する必要がある場合は、まずVisuStellaのメンバーと連絡を取り、承認を得る必要があります。パッチはVisuStella.comに公開され、誰でも無料でダウンロードすることができるようになります。このようなパッチを、制作発注やクラウドファンディングの対象にしたり、寄付などの金銭的な利益を得るために販売することはできません。

7. このVisuStella MZプラグインが商用製品である場合、プロジェクトチームのすべてのメンバーは、それを使用するため、それぞれ製品を購入しなければなりません。使用方法には、関連するゲームメカニクスの作業、関連するコードの管理、および/または関連するプラグインコマンドや機能の使用、が含まれます。プラグインそのものやそのコードをチームの他のメンバーに再配布することは第4項に抵触するため、そのメンバーがプラグインそのものを所有していない限りは許可されません。

8. このプラグインの利用規約の追加項目や補足については、VisuStella.comに掲載されていますので、それを参照し従ってください。

Credits

If you are using this plugin, credit the following people in your game:

Team VisuStella

Changelog

Version 1.03: October 7, 2021

  • Compatibility Update
    • Added compatibility functionality for future plugins.


Version 1.02: May 21, 2021

  • Documentation Update!
    • Help file updated for new features.
  • New Features!
    • New notetag added by Irina.
      • <Exclude From Tooltips>
        • Excludes the state from being displayed in the state tooltips.


Version 1.01: April 2, 2021

  • Documentation Update!
    • Added "VisuStella MZ Compatibility" section for detailed compatibility explanations with the VisuMZ_2_DragonbonesUnion plugin.


Version 1.00 Official Release Date: February 24, 2021

  • Finished Plugin!

End of File