Consumable Defensive States 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.

InstallPluginsMz.png

UpdatePlugins.png

Troubleshooting.jpg

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

Click here to learn how to update plugins.

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


Masterarbeit Writer


ConsumDefState Preview.gif

ConsumDefState Charges.png


VisuStella MZ

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

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

Introduction

ConsumDefState Preview.gif

Consumable Defensive States are states that will protect its user once from a specific element(s), skill type(s), or hit type(s) before automatically removing itself. These defensive strategies can range from reflection, evasion, or damage immunity. When utilized, these new state types can add a whole new range of strategy to the battle system.

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

  • Consumable Defensive States will protect its user from specific types of attacks before self-removing, consuming itself in the process.
  • The action, its damage, and its effects can be reflected back at the user of the action as the third defensive reaction measure.
  • Defensive evasion reaction states will allow battlers to dodge even skills with 100% hit rates, as long as the conditions have been met.
  • Damage immunity is another defensive reaction that can be utilized through these new state effects. This is different from nullification as this will proc any damage immunity-based effects.
  • Those using the Skills and States Core will have access to extra features, such as additional charges that can be employed. Consumable Defensive States with additional charges will consume the charges first before consuming itself, allowing for additional usage.

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.

---

Skills and States Core VisuStella MZ

ConsumDefState Charges.png

With the VisuStella MZ Skills and States Core installed, Consumable Defensive States no longer have to be one time uses. Instead, they can have charges. Each time their defensive properties take effect, the charges are reduced by 1. If the number of charges reach zero, the state is automatically removed. Simple and intuitive, right?

---

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.

---

Anti-Damage Barriers

The VisuStella MZ Anti-Damage Barriers notetag effects cannot be used together with the Consumable Defensive States notetag effects. They utilize the same state display. Priority will be given to Anti-Damage Barriers if both of them are detected on the same state.

If you absolutely need for multiple effects from both to occur at the same time, we recommend that you create them as separate states and apply both (or more) states simultaneously.

---

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.

---

Reflection-Related Notetags

ConsumDefState Preview.gif

---

<1 Time Reflect Element: id>
<1 Time Reflect Elements: id, id, id>
<1 Time Reflect Element: name>
<1 Time Reflect Elements: name, name, name>

<x Charges Reflect Element: id>
<x Charges Reflect Elements: id, id, id>
<x Charges Reflect Element: name>
<x Charges Reflect Elements: name, name, name>

- Used for: State Notetags
- Turns the state into a Consumable Defensive State that will reflect the
  specific element until consumed.
  - Reflection will occur before Evasion and Damage Immunity.
- Replace 'id' with a number representing the element ID to be reflected.
- Replace 'name' with the name of the element to be reflected.
  - Remove any \I[x] text codes from it if present.
- If VisuMZ_1_SkillsStatesCore is installed, you may use the 'x' notetags.
  - Replace 'x' with the number of usable charges the state would have
    before being consumed. Usable charges go down by 1 each trigger.
- IMPORTANT: You cannot use other Consumable Defensive State notetags
  together in the same state.

---

<1 Time Reflect SType: id>
<1 Time Reflect STypes: id, id, id>
<1 Time Reflect SType: name>
<1 Time Reflect STypes: name, name, name>

<x Charges Reflect SType: id>
<x Charges Reflect STypes: id, id, id>
<x Charges Reflect SType: name>
<x Charges Reflect STypes: name, name, name>

- Used for: State Notetags
- Turns the state into a Consumable Defensive State that will reflect a
  skill with the specific skill type until consumed.
  - Reflection will occur before Evasion and Damage Immunity.
- Replace 'id' with a number representing the skill type ID to be reflected.
- Replace 'name' with the name of the skill type to be reflected.
  - Remove any \I[x] text codes from it if present.
- If VisuMZ_1_SkillsStatesCore is installed, you may use the 'x' notetags.
  - Replace 'x' with the number of usable charges the state would have
    before being consumed. Usable charges go down by 1 each trigger.
- IMPORTANT: You cannot use other Consumable Defensive State notetags
  together in the same state.

---

<1 Time Reflect Certain Hit Skills>
<1 Time Reflect Physical Hit Skills>
<1 Time Reflect Magical Hit Skills>
<1 Time Reflect All Skills>

<x Charges Reflect Certain Hit Skills>
<x Charges Reflect Physical Hit Skills>
<x Charges Reflect Magical Hit Skills>
<x Charges Reflect All Skills>

- Used for: State Notetags
- Turns the state into a Consumable Defensive State that will reflect a
  skill with the specific hit type until consumed.
  - Reflection will occur before Evasion and Damage Immunity.
- If VisuMZ_1_SkillsStatesCore is installed, you may use the 'x' notetags.
  - Replace 'x' with the number of usable charges the state would have
    before being consumed. Usable charges go down by 1 each trigger.
- IMPORTANT: You cannot use other Consumable Defensive State notetags
  together in the same state.

---

<1 Time Reflect Certain Hit Items>
<1 Time Reflect Physical Hit Items>
<1 Time Reflect Magical Hit Items>
<1 Time Reflect All Items>

<x Charges Reflect Certain Hit Items>
<x Charges Reflect Physical Hit Items>
<x Charges Reflect Magical Hit Items>
<x Charges Reflect All Items>

- Used for: State Notetags
- Turns the state into a Consumable Defensive State that will reflect an
  item with the specific hit type until consumed.
  - Reflection will occur before Evasion and Damage Immunity.
- If VisuMZ_1_SkillsStatesCore is installed, you may use the 'x' notetags.
  - Replace 'x' with the number of usable charges the state would have
    before being consumed. Usable charges go down by 1 each trigger.
- IMPORTANT: You cannot use other Consumable Defensive State notetags
  together in the same state.

---

<1 Time Reflect Certain Hit Actions>
<1 Time Reflect Physical Hit Actions>
<1 Time Reflect Magical Hit Actions>
<1 Time Reflect All Actions>

<x Charges Reflect Certain Hit Actions>
<x Charges Reflect Physical Hit Actions>
<x Charges Reflect Magical Hit Actions>
<x Charges Reflect All Actions>

- Used for: State Notetags
- Turns the state into a Consumable Defensive State that will reflect an
  action (skill and/or item) with the specific hit type until consumed.
  - Reflection will occur before Evasion and Damage Immunity.
- If VisuMZ_1_SkillsStatesCore is installed, you may use the 'x' notetags.
  - Replace 'x' with the number of usable charges the state would have
    before being consumed. Usable charges go down by 1 each trigger.
- IMPORTANT: You cannot use other Consumable Defensive State notetags
  together in the same state.

---

Evasion-Related Notetags

ConsumDefState Charges.png

---

<1 Time Evasion Element: id>
<1 Time Evasion Elements: id, id, id>
<1 Time Evasion Element: name>
<1 Time Evasion Elements: name, name, name>

<x Charges Evasion Element: id>
<x Charges Evasion Elements: id, id, id>
<x Charges Evasion Element: name>
<x Charges Evasion Elements: name, name, name>

- Used for: State Notetags
- Turns the state into a Consumable Defensive State that will evade the
  specific element until consumed.
  - Evasion will occur after Reflection and before Damage Immunity.
- Replace 'id' with a number representing the element ID to be evaded.
- Replace 'name' with the name of the element to be evaded.
  - Remove any \I[x] text codes from it if present.
- If VisuMZ_1_SkillsStatesCore is installed, you may use the 'x' notetags.
  - Replace 'x' with the number of usable charges the state would have
    before being consumed. Usable charges go down by 1 each trigger.
- IMPORTANT: You cannot use other Consumable Defensive State notetags
  together in the same state.

---

<1 Time Evasion SType: id>
<1 Time Evasion STypes: id, id, id>
<1 Time Evasion SType: name>
<1 Time Evasion STypes: name, name, name>

<x Charges Evasion SType: id>
<x Charges Evasion STypes: id, id, id>
<x Charges Evasion SType: name>
<x Charges Evasion STypes: name, name, name>

- Used for: State Notetags
- Turns the state into a Consumable Defensive State that will evade a
  skill with the specific skill type until consumed.
  - Evasion will occur after Reflection and before Damage Immunity.
- Replace 'id' with a number representing the skill type ID to be evaded.
- Replace 'name' with the name of the skill type to be evaded.
  - Remove any \I[x] text codes from it if present.
- If VisuMZ_1_SkillsStatesCore is installed, you may use the 'x' notetags.
  - Replace 'x' with the number of usable charges the state would have
    before being consumed. Usable charges go down by 1 each trigger.
- IMPORTANT: You cannot use other Consumable Defensive State notetags
  together in the same state.

---

<1 Time Evasion Certain Hit Skills>
<1 Time Evasion Physical Hit Skills>
<1 Time Evasion Magical Hit Skills>
<1 Time Evasion All Skills>

<x Charges Evasion Certain Hit Skills>
<x Charges Evasion Physical Hit Skills>
<x Charges Evasion Magical Hit Skills>
<x Charges Evasion All Skills>

- Used for: State Notetags
- Turns the state into a Consumable Defensive State that will evade a
  skill with the specific hit type until consumed.
  - Evasion will occur after Reflection and before Damage Immunity.
- If VisuMZ_1_SkillsStatesCore is installed, you may use the 'x' notetags.
  - Replace 'x' with the number of usable charges the state would have
    before being consumed. Usable charges go down by 1 each trigger.
- IMPORTANT: You cannot use other Consumable Defensive State notetags
  together in the same state.

---

<1 Time Evasion Certain Hit Items>
<1 Time Evasion Physical Hit Items>
<1 Time Evasion Magical Hit Items>
<1 Time Evasion All Items>

<x Charges Evasion Certain Hit Items>
<x Charges Evasion Physical Hit Items>
<x Charges Evasion Magical Hit Items>
<x Charges Evasion All Items>

- Used for: State Notetags
- Turns the state into a Consumable Defensive State that will evade an
  item with the specific hit type until consumed.
  - Evasion will occur after Reflection and before Damage Immunity.
- If VisuMZ_1_SkillsStatesCore is installed, you may use the 'x' notetags.
  - Replace 'x' with the number of usable charges the state would have
    before being consumed. Usable charges go down by 1 each trigger.
- IMPORTANT: You cannot use other Consumable Defensive State notetags
  together in the same state.

---

<1 Time Evasion Certain Hit Actions>
<1 Time Evasion Physical Hit Actions>
<1 Time Evasion Magical Hit Actions>
<1 Time Evasion All Actions>

<x Charges Evasion Certain Hit Actions>
<x Charges Evasion Physical Hit Actions>
<x Charges Evasion Magical Hit Actions>
<x Charges Evasion All Actions>

- Used for: State Notetags
- Turns the state into a Consumable Defensive State that will evade an
  action (skill and/or item) with the specific hit type until consumed.
  - Evasion will occur after Reflection and before Damage Immunity.
- If VisuMZ_1_SkillsStatesCore is installed, you may use the 'x' notetags.
  - Replace 'x' with the number of usable charges the state would have
    before being consumed. Usable charges go down by 1 each trigger.
- IMPORTANT: You cannot use other Consumable Defensive State notetags
  together in the same state.

---

Immunity-Related Notetags

ConsumDefState Charges.png

---

<1 Time Immunity Element: id>
<1 Time Immunity Elements: id, id, id>
<1 Time Immunity Element: name>
<1 Time Immunity Elements: name, name, name>

<x Charges Immunity Element: id>
<x Charges Immunity Elements: id, id, id>
<x Charges Immunity Element: name>
<x Charges Immunity Elements: name, name, name>

- Used for: State Notetags
- Turns the state into a Consumable Defensive State that will nullify damage
  from the specific element until consumed. Other effects may still occur.
  - Immunity will occur after Reflection and Evasion.
- Replace 'id' with a number representing the element ID to nullify.
- Replace 'name' with the name of the element to nullify.
  - Remove any \I[x] text codes from it if present.
- If VisuMZ_1_SkillsStatesCore is installed, you may use the 'x' notetags.
  - Replace 'x' with the number of usable charges the state would have
    before being consumed. Usable charges go down by 1 each trigger.
- IMPORTANT: You cannot use other Consumable Defensive State notetags
  together in the same state.

---

<1 Time Immunity SType: id>
<1 Time Immunity STypes: id, id, id>
<1 Time Immunity SType: name>
<1 Time Immunity STypes: name, name, name>

<x Charges Immunity SType: id>
<x Charges Immunity STypes: id, id, id>
<x Charges Immunity SType: name>
<x Charges Immunity STypes: name, name, name>

- Used for: State Notetags
- Turns the state into a Consumable Defensive State that will nullify damage
  from a skill with the specific skill type until consumed. Other effects
  may still occur.
  - Immunity will occur after Reflection and Evasion.
- Replace 'id' with a number representing the skill type ID to nullify.
- Replace 'name' with the name of the skill type to nullify.
  - Remove any \I[x] text codes from it if present.
- If VisuMZ_1_SkillsStatesCore is installed, you may use the 'x' notetags.
  - Replace 'x' with the number of usable charges the state would have
    before being consumed. Usable charges go down by 1 each trigger.
- IMPORTANT: You cannot use other Consumable Defensive State notetags
  together in the same state.

---

<1 Time Immunity Certain Hit Skills>
<1 Time Immunity Physical Hit Skills>
<1 Time Immunity Magical Hit Skills>
<1 Time Immunity All Skills>

<x Charges Immunity Certain Hit Skills>
<x Charges Immunity Physical Hit Skills>
<x Charges Immunity Magical Hit Skills>
<x Charges Immunity All Skills>

- Used for: State Notetags
- Turns the state into a Consumable Defensive State that will nullify damage
  from a skill with the specific hit type until consumed. Other effects may
  still occur.
  - Immunity will occur after Reflection and Evasion.
- If VisuMZ_1_SkillsStatesCore is installed, you may use the 'x' notetags.
  - Replace 'x' with the number of usable charges the state would have
    before being consumed. Usable charges go down by 1 each trigger.
- IMPORTANT: You cannot use other Consumable Defensive State notetags
  together in the same state.

---

<1 Time Immunity Certain Hit Items>
<1 Time Immunity Physical Hit Items>
<1 Time Immunity Magical Hit Items>
<1 Time Immunity All Items>

<x Charges Immunity Certain Hit Items>
<x Charges Immunity Physical Hit Items>
<x Charges Immunity Magical Hit Items>
<x Charges Immunity All Items>

- Used for: State Notetags
- Turns the state into a Consumable Defensive State that will nullify damage
  from an item with the specific hit type until consumed. Other effects may
  still occur.
  - Immunity will occur after Reflection and Evasion.
- If VisuMZ_1_SkillsStatesCore is installed, you may use the 'x' notetags.
  - Replace 'x' with the number of usable charges the state would have
    before being consumed. Usable charges go down by 1 each trigger.
- IMPORTANT: You cannot use other Consumable Defensive State notetags
  together in the same state.

---

<1 Time Immunity Certain Hit Actions>
<1 Time Immunity Physical Hit Actions>
<1 Time Immunity Magical Hit Actions>
<1 Time Immunity All Actions>

<x Charges Immunity Certain Hit Actions>
<x Charges Immunity Physical Hit Actions>
<x Charges Immunity Magical Hit Actions>
<x Charges Immunity All Actions>

- Used for: State Notetags
- Turns the state into a Consumable Defensive State that will nullify damage
  from an action (skill and/or item) with the specific hit type until
  consumed. Other effects may still occur.
  - Immunity will occur after Reflection and Evasion.
- If VisuMZ_1_SkillsStatesCore is installed, you may use the 'x' notetags.
  - Replace 'x' with the number of usable charges the state would have
    before being consumed. Usable charges go down by 1 each trigger.
- IMPORTANT: You cannot use other Consumable Defensive State notetags
  together in the same state.

---

Stackable Charges-Related Notetags

ConsumDefState Charges.png

---

<Max Stackable Charges: x>

- State Notetags
- Requires VisuMZ_1_SkillsStatesCore!
- Allows the max stackable charges for the state to become 'x'.
- Replace 'x' with a number representing the maximum charges the state can
  potentially have. If 'x' is lower than the default charge amount, 'x' will
  become the default charge amount.
- This is not a Consumable Defensive State notetag and can therefore be used
  together with the above notetags.
- If this notetag is not present, whenever a Consumable Defensive State is
  reapplied, the charge number resets. With this notetag, the charges become
  stackable up to a maximum of 'x'.

---



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.01: October 28, 2021

  • Bug Fixes!
    • Fixed documentation error that listed the incorrect way to parse notetags for the various Evasion, Reflect, and Immune effects. Fix made by Olivia.
  • Documentation Update!
    • Help file updated for the correct notetag parsings.


Version 1.00 Official Release Date: November 5, 2021

  • Finished Plugin!


See Also


End of File