Weakness Display 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.



WeaknessDisplay Preview.png

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

WeaknessDisplay Preview.png

This plugin creates a display in battle to show enemy elemental weaknesses. These weaknesses will start off hidden and will be slowly revealed whenever the respective enemies receive elemental damage of the correct type. This way, your players no longer have to jot down mental notes on what enemies are weak to which elements, and instead, have access to their pool of discovered knowledge right at the screen.

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

  • The Weakness Display is a new UI element added below each enemy.
  • The display will reveal each of the elemental weaknesses an enemy has.
  • The elements will be hidden at first but will be slowly revealed as the player hits the enemies with the correct element type.
  • Players can use Analyze Weakness effects to reveal weaknesses without needing to hit them directly.
  • Adjust the positions, icons, and elements for the Weakness Display to fit your game.

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.

---

Boost Action VisuStella MZ

The VisuStella MZ Boost Action plugin contains a notetag that allows the Weakness Display's Analyze effect to trigger multiple times. This notetag is <Boost Analyze> and its potency is dependent on the Plugin Parameter settings found in the Boost Action plugin.

---

Break Shields VisuStella MZ

The VisuStella MZ Break Shields plugin has a game mechanic to protect one's elemental weaknesses. The protected elements will show up in the Weakness Display and have a special icon on top of them.

---

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.

---

Analyze-Related Notetags

WeaknessDisplay Preview.png

---

<Analyze Weakness: x>
<Analyze Weaknesses: x>

- Used for: Skill, Item Notetags
- Reveals 'x' amount of elemental weaknesses the target enemy may have
  without needing to hit the enemy with the said elemental weakness first.
- Replace 'x' with a number representing the number of weaknesses to reveal
  through this action.
- This has no effect on actors.

---

Plugin Parameters

General Settings

WeaknessDisplay Preview.png

WeaknessDisplay Params1.png

These are the general settings regarding the Weakness Display plugin. They allow you to adjust which elements appear and which icons to assign to them. They also let you control which icons to use for the various display parts.

---

Elements

 Shown Elements:
 - This is a list of the Element ID's you wish to display.
 - If this is empty, this will show all database elements.
 Element Icons:
 - Icon ID's used for each Element ID in order.
 - Priority will be given to elements with \I[x] in their names.
   Auto-Assign Icons:
   - Automatically assign icons if they do not show up in the
     Plugin Parameter settings based on their English names?
   - Icons will be automatically assigned based on the default icon sheet
     for the following elements if their names are detected:
     - Air, Aqua, Axe, Blade, Bow, Claw, Crossbow, Cure, Dagger, Dark,
       Earth, Energy, Evil, Fire, Flame, Frost, Glove, Ground, Gun, Heal,
       Holy, Ice, Knife, Light, Lightning, Mace, Magic, Mana, Melee,
       Polearm, Power, Physical, Sacred, Spear, Staff, Sword, Thunder,
       Wand, Water, Whip, Wind
     - Unlisted element names will default to icon index 160.

---

Icons

 Background Icon:
 - Which icon index do you wish to use to assign as the background for the
   Weakness Display icons?
 Unknown Icon:
 - Which icon index do you wish to use to assign as the unknown marker for
   the Weakness Display icons?
 Smooth Icons?:
 - Do you wish to smooth out the icons or pixelate them?

---

Display Settings

WeaknessDisplay Preview.png

WeaknessDisplay Params2.png

These are the settings regarding how the Weakness Display UI elements behave in-game. Adjust them to make them fit the visuals for your battle system.

---

Display UI

 Icon Scale:
 - Scale up or down the display UI.
 - Use a number between 0 and 1 for the best results.
 Always Visible?:
 - Do you wish to make the Weakness Display always visible?
 Temporary Duration:
 - If not always visible, how many frames will the Weakness Display be
   temporarily visible?
 - 60 frames = 1 second.

---

Positioning

 Offset X/Y:
 - How much to offset the Weakness Display X/Y position by?
 - For X: Negative goes left. Positive goes right.
 - For Y: Negative goes up. Positive goes down.

---


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.00 Official Release Date: April 28, 2021

  • Finished Plugin!

End of File