Break Shields 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.



BreakShields Ani.gif


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

BreakShields Ani.gif

This plugin introduces a new mechanic called Break Shields. Actors and/or enemies can have them. Whenever a battler is struck with an elemental weakness, their Break Shield is reduced by 1 (unless modified by a notetag). Once the battler's Break Shield reaches a score of 0, a state is then applied to the battler (usually a stun state). Once the Break state wears off, the battler will regain their Break Shields again. This can be used to create complex battle depth for your game.

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

  • Control how Break Shields are calculated alongside how many hits are required for each actor and/or enemy to enter the Break Stun state.
  • Display the Break Shields on the screen and relay the information to your players through icons.
  • Play animations when hitting a weakness and reducing Break Shields.

Requirements

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


Tier 4

This plugin is a Tier 4 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.

---

Core Engine VisuStella MZ

Two of the animation Plugin Parameters require the Core Engine to play them. This is due to how the Core Engine allows playing animations without halting the battle system to allow for a seamless flow despite relaying the Break Shield reduction visual feedback.

---

VisuStella MZ Compatibility

While this plugin is compatible with the majority of the VisuStella MZ plugin library, it is not compatible with specific plugins. Here is a list of the ones this plugin is not compatible with.

---

Battle System - STB VisuStella MZ

The Break Shields plugin can be used together with Battle System - STB. However, it cannot be used together with the STB Exploit system. This is because both Break Shields and the Exploit system function under similar mechanics and will conflict. However, if STB's Exploit system is turned off, then you can use all of the Break Shield plugin's features fully.

---

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.

---

Break Shield Calculation-Related Notetags

BreakShields Ani.gif

---

<Break Shields: x>

- Used for: Actor, Class, Enemy Notetags
- Declares the base amount of Break Shields this battler will have.
- This will ignore the default setting from the Plugin Parameters.
- Replace 'x' with a number representing the base amount of Break Shields to
  give this battler.
- If both the Actor and Class database object has this notetag, priority
  will be given to the Class before the Actor.

---

<Break Shields: +x>
<Break Shields: -x>

- Used for: Actor, Class, Weapon, Armor, Enemy, State Notetags
- Allows trait objects to alter the amount of Break Shields battlers have
  whenever their Break Shields are reset.
- Replace 'x' with a number representing the Break Shields to increase or
  decrease the amount by.
- Total Break Shields cannot go under 1 and cannot go whatever the maximum
  is declared inside the Plugin Parameters.

---

Break Shield Alteration-Related Notetags

BreakShields Ani.gif

---

<Break Reduce: x>

- Used for: Skill, Item Notetags
- Reduces the target's Break Shield by x if this action hits a weakness.
- This will ignore the default setting from the Plugin Parameters.
- Replace 'x' with a number to determine how many Break Shields to reduce.
- If Break Shields reach 0, the target will enter a Stun state.

---

<Change Break Shield: x>

- Used for: Skill, Item Notetags
- This will change the target battler's Break Shield value to x if the
  battler isn't currently stunned.
- No effect if you don't use this notetag.
- Replace 'x' with a number value to change the target battler's Break
  Shield value to.

---

<Increase Break Shield: +x>
<Decrease Break Shield: -x>

- Used for: Skill, Item Notetags
- This will either increase the target battler's break shield by x or
  decrease the target battler's break shield by x.
- Happens after the Change Break Shield notetag.
- No effect if you don't use this notetag.
- Replace 'x' with a number value representing the amount to alter the
  target's Break Shields by.

---

Element-Related Notetags

BreakShields ProtectElement.png

---

<Protect Element: id>
<Protect Elements: id, id, id>

<Protect Element: name>
<Protect Elements: name, name, name>

- Used for: Actor, Class, Weapon, Armor, Enemy, State Notetags
- Specified element(s) will be guarded and Break Shields cannot be reduced
  when struck with that element (as long as the requirement is above 100%).
- The element rate for those will cap at 100%, preventing extra damage from
  being dealt despite having weaknesses, although custom JS effects will
  bypass this.
- Replace 'id' with a number value representing the ID(s) of the element(s).
- Replace 'name' with the name(s) of the element(s).

---

Plugin Parameters

Mechanics Settings

BreakShields Ani.gif

BreakShields Params1.png

Customize the mechanical settings for Break Shields.

---

Break Shields

 Affect: Actors?:
 - Do Break Shields affect actors?
 Affect: Enemies?:
 - Do Break Shields affect actors?
 Base Shield Value:
 - The starting amount of shields a battler has.
 - Can be altered through notetags.
 Maximum Shields:
 - The maximum amount of shields a battler can have.
 - This is a hard cap.
 Stun State ID:
 - This is the state to be applied when all Break Shields are reduced to 0.

---

Animation

 Reduce Animation ID:
 - Play this animation when Break Shields are reduced.
 - Requires VisuMZ_0_CoreEngine.
 Stun Animation ID:
 - Play this animation when Break Stun is achieved.
 - Requires VisuMZ_0_CoreEngine.

---

Weaknesses

 Minimum Rate:
 - What is the minimum element rate for an attack to be considered striking
   a weakness?
 Default Reduction:
 - Default reduction amount for Break Shields when striking an elemental
   weakness.

---

UI Settings

BreakShields Ani.gif

BreakShields Params2.png

Customize the UI settings for Break Shields.

---

Icons

 Break Shield Icon:
 - Icon used to represent Break Shields.
 Stun State Icon:
 - Icon used to represent Break Stun if the Break Stun state does NOT have
   an icon assigned to it.
   Show Turns?:
   - Show how many turns are remaining with the Break Stun?
 Protect Icon:
 - Icon used to represent Protected Elements.
 - Used for other plugins.
 Font Size:
 - What is the font size used to display the turns and Break Shields
   remaining?

---

Battlers > Actors/Enemies

 Show Battler Icon?:
 - Show Break Shield icons on the SV_Actor/enemy battlers?
 Position:
 - Where on the battler would you like to place the icon?
 Offset X:
 - How much to offset the icon X position by?
 - Negative goes left. Positive goes right.
 Offset Y:
 - How much to offset the icon Y position by?
 - Negative goes up. Positive goes down.
 Name: Attach Shields (Enemies Only)
 - Attach the Break Shield icon to the enemy name?
 - Overrides direct attachment.
 - Requires VisuMZ_1_BattleCore!
   Attach: Offset X:
   - How much to offset the attached icon's X position by?
   - Negative goes left. Positive goes right.
   Attach: Offset Y:
   - How much to offset the attached icon's Y position by?
   - Negative goes up. Positive goes down.

---

Battle Status

 Show Break Shields?:
 - Show Break Shield icons in the Battle Status?
 Auto-Position?:
 - Automatically position the Break Shield icon?
 - If not, it'll position it to the upper left.
 Offset X:
 - How much to offset the icon X position by?
 - Negative goes left. Positive goes right.
 Offset Y:
 - How much to offset the icon Y position by?
 - Negative goes up. Positive goes down.

---

Menu Status

 Show Break Shields?:
 - Show Break Shield icons in the menu scenes?

---


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 30, 2021

  • Finished Plugin!

End of File