Difference between revisions of "Auto Skill Triggers VisuStella MZ"

From Yanfly.moe Wiki
Jump to navigation Jump to search
(Changelog)
(Changelog)
Line 73: Line 73:
  
 
== Changelog ==
 
== Changelog ==
 +
 +
Version 1.10: December 16, 2021
 +
* Compatibility Update!
 +
** Auto Skill Triggers is now disabled with the following battle systems: ETB, FTB, and PTB. This is due to the way their turn structures work, making them highly incompatible with one another.
 +
** We may revisit this in the future, but for now, Auto Skill Triggers are to be disabled by code when any of the battle systems are detected.
 +
* Documentation Update!
 +
** Added "VisuStella MZ Compatibility" section.
 +
 +
  
 
Version 1.09: June 25, 2021
 
Version 1.09: June 25, 2021

Revision as of 14:37, 16 December 2021

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


AutoSkillTrigger SelfDestruct.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.

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

Introduction

Sometimes you want some skills that only occur after a specific condition triggers (ie. death, receiving specific elemental damage, or allies performing skills of a specific type). These skill triggers are now made possible through this plugin.

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

  • Skill triggers that launch at the start of battle or winning a battle.
  • Skills that let actors/enemies do one last hurrah before dying.
  • Skills that function as a reaction to the user performing specific actions ranging from basic attacks, guarding, items, physical attacks, magical attacks, certain hit attacks, skills from specific skill types, or actions that inflict any specific kind of elemental damage.
  • A total of 60 different auto triggers for a variety of situations.

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.


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.

---

Skill Trigger-Related Notetags

AutoSkillTrigger SelfDestruct.gif

---

<No Auto Skill Trigger>

- Used for: Skill, Item State Notetags
- This prevents Auto Skill Triggers from occurring upon using this
  skill or item.

---

<Auto Trigger: condition>

<Auto Trigger x%: condition>

- Used for: Skill Notetags
- Turns this skill into an Auto Trigger Skill, where it will automatically
  be used if the 'condition' has been met.
- If using the x% variant, the Auto Trigger has a x% chance to occur.
  - Replace 'x' with a number value representing the chance to succeed.
- Skill must be usable normally outside of the occasion in order to trigger.
- This marked skill cannot trigger any other Auto Skill Triggers in order to
  prevent an infinite loop.
- Skills can have multiple Auto Triggers and will trigger upon meeting the
  conditions of any of them.
- Replace 'condition' with any of the below keywords:

  *Note1*: Being the target of an action means the potential target must be
    a part of the original scope, regardless of how the targets are changed
    up later by Action Sequences.

Keywords:

  ---

  Battle Start
  - Triggers skill when the battle starts.

  Battle Win
  - Triggers skill when the battle is won.

  Death
  - Triggers skill moments before the user's death.
  - If the user recovers enough HP from the skill trigger, then the
    user won't die. However, any other Death triggered effects will
    still continue to prompt.

  ---

  Attack User
  - Triggers skill when the user uses a basic attack.

  Guard User
  - Triggers skill when the user guards.

  Item User
  - Triggers skill when the user uses any item.

  Physical User
  - Triggers skill when the user performs any physical action.

  Magical User
  - Triggers skill when the user performs any magical action.

  Certain Hit User
  - Triggers skill when the user performs a certain hit action.

  Skill Type name User
  - Triggers skill when the user performs a skill of the named
    Skill Type.

  Element name User
  - Triggers skill when the user performs an action with the named
    element type.

  ---

  Attack Target
  - Triggers skill when user is the target of a basic attack.
  - See Note1 Above.

  Guard Target
  - Triggers skill when user is the target of a guard action.
  - See Note1 Above.

  Item Target
  - Triggers skill when user is the target of an item action.
  - See Note1 Above.

  Physical Target
  - Triggers skill when user is the target of a physical action.
  - See Note1 Above.

  Magical Target
  - Triggers skill when user is the target of a magical action.
  - See Note1 Above.

  Certain Hit Target
  - Triggers skill when user is the target of a certain hit action.
  - See Note1 Above.

  Skill Type name Target
  - Triggers skill when user is the target of a skill by named
    Skill Type.
  - See Note1 Above.

  Element name Target
  - Triggers skill when user is the target of of an action with the named
    element type.
  - See Note1 Above.

  ---

  Attack Ally
  - Triggers skill when user is the target of a basic attack
    and is an ally of the currently active battler.
  - See Note1 Above.

  Guard Ally
  - Triggers skill when user is the target of a guard action
    and is an ally of the currently active battler.
  - See Note1 Above.

  Item Ally
  - Triggers skill when user is the target of an item action
    and is an ally of the currently active battler.
  - See Note1 Above.

  Physical Ally
  - Triggers skill when user is the target of a physical action
    and is an ally of the currently active battler.
  - See Note1 Above.

  Magical Ally
  - Triggers skill when user is the target of a magical action
    and is an ally of the currently active battler.
  - See Note1 Above.

  Certain Hit Ally
  - Triggers skill when user is the target of a certain hit action
    and is an ally of the currently active battler.
  - See Note1 Above.

  Skill Type name Ally
  - Triggers skill when user is the target of a skill by named
    Skill Type and is an ally of the currently active battler.
  - See Note1 Above.

  Element name Ally
  - Triggers skill when user is the target of of an action with the named
    element type and is an ally of the currently active battler.
  - See Note1 Above.

  ---

  Attack Enemy
  - Triggers skill when user is the target of a basic attack
    and is an enemy of the currently active battler.
  - See Note1 Above.

  Guard Enemy
  - Triggers skill when user is the target of a guard action
    and is an enemy of the currently active battler.
  - See Note1 Above.

  Item Enemy
  - Triggers skill when user is the target of an item action
    and is an enemy of the currently active battler.
  - See Note1 Above.

  Physical Enemy
  - Triggers skill when user is the target of a physical action
    and is an enemy of the currently active battler.
  - See Note1 Above.

  Magical Enemy
  - Triggers skill when user is the target of a magical action
    and is an enemy of the currently active battler.
  - See Note1 Above.

  Certain Hit Enemy
  - Triggers skill when user is the target of a certain hit action
    and is an enemy of the currently active battler.
  - See Note1 Above.

  Skill Type name Enemy
  - Triggers skill when user is the target of a skill by named
    Skill Type and is an enemy of the currently active battler.
  - See Note1 Above.

  Element name Enemy
  - Triggers skill when user is the target of of an action with the named
    element type and is an enemy of the currently active battler.
  - See Note1 Above.

  ---

  Attack Friends
  - Triggers skill when a basic attack occurs and the active battler
    is in the user's allied team.

  Guard Friends
  - Triggers skill when a guard action occurs and the active battler
    is in the user's allied team.

  Item Friends
  - Triggers skill when an item action occurs and the active battler
    is in the user's allied team.

  Physical Friends
  - Triggers skill when a physical action occurs and the active battler
    is in the user's allied team.

  Magical Friends
  - Triggers skill when a physical action occurs and the active battler
    is in the user's allied team.

  Certain Hit Friends
  - Triggers skill when a certain hit action occurs and the active battler
    is in the user's allied team.

  Skill Type name Friends
  - Triggers skill when a skill by the named Skill Type action occurs and
    the active battler is in the user's allied team.

  Element name Friends
  - Triggers skill when an action with the named element type occurs and
    the active battler is in the user's allied team.

  ---

  Attack Friends Only
  - Triggers skill when a basic attack occurs and the active battler
    is in the user's allied team, but the active battler cannot be the user.

  Guard Friends Only
  - Triggers skill when a guard action occurs and the active battler
    is in the user's allied team, but the active battler cannot be the user.

  Item Friends Only
  - Triggers skill when an item action occurs and the active battler
    is in the user's allied team, but the active battler cannot be the user.

  Physical Friends Only
  - Triggers skill when a physical action occurs and the active battler
    is in the user's allied team, but the active battler cannot be the user.

  Magical Friends Only
  - Triggers skill when a physical action occurs and the active battler
    is in the user's allied team, but the active battler cannot be the user.

  Certain Hit Friends Only
  - Triggers skill when a certain hit action occurs and the active battler
    is in the user's allied team, but the active battler cannot be the user.

  Skill Type name Friends Only
  - Triggers skill when a skill by the named Skill Type action occurs and
    the active battler is in the user's allied team, but the active battler
    cannot be the user.

  Element name Friends Only
  - Triggers skill when an action with the named element type occurs and
    the active battler is in the user's allied team, but the active battler
    cannot be the user.

  ---

  Attack Opponents
  - Triggers skill when a basic attack occurs and the active battler
    is in the user's opposing team.

  Guard Opponents
  - Triggers skill when a guard action occurs and the active battler
    is in the user's opposing team.

  Item Opponents
  - Triggers skill when an item action occurs and the active battler
    is in the user's opposing team.

  Physical Opponents
  - Triggers skill when a physical action occurs and the active battler
    is in the user's opposing team.

  Magical Opponents
  - Triggers skill when a physical action occurs and the active battler
    is in the user's opposing team.

  Certain Hit Opponents
  - Triggers skill when a certain hit action occurs and the active battler
    is in the user's opposing team.

  Skill Type name Opponents
  - Triggers skill when a skill by the named Skill Type action occurs and
    the active battler is in the user's opposing team.

  Element name Opponents
  - Triggers skill when an action with the named element type occurs and
    the active battler is in the user's opposing team.

  ---

Examples:

  <Auto Trigger: Battle Start>
  <Auto Trigger: Death>
  <Auto Trigger: Attack User>
  <Auto Trigger: Guard User>
  <Auto Trigger: Physical Target>
  <Auto Trigger: Magical Target>
  <Auto Trigger: Certain Hit Ally>
  <Auto Trigger: Item Enemy>
  <Auto Trigger: Skill Type Magic Ally>
  <Auto Trigger: Skill Type Special Enemy>
  <Auto Trigger: Element Fire Friends>
  <Auto Trigger: Element Ice Opponents>

---


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.10: December 16, 2021

  • Compatibility Update!
    • Auto Skill Triggers is now disabled with the following battle systems: ETB, FTB, and PTB. This is due to the way their turn structures work, making them highly incompatible with one another.
    • We may revisit this in the future, but for now, Auto Skill Triggers are to be disabled by code when any of the battle systems are detected.
  • Documentation Update!
    • Added "VisuStella MZ Compatibility" section.


Version 1.09: June 25, 2021

  • Feature Update!
    • Added failsafe for those using illegal syntax charactes inside of their database type names which conflict with notetag creation. Fix by Irina.


Version 1.08: March 19, 2021

  • Bug Fixes!
    • Death Triggers that cannot be used will no longer cause the battler to become immortal. Fix made by Irina.


Version 1.07: March 12, 2021

  • Optimization Update!
    • Skills that cannot be used will no longer be checked for auto triggers. Update made by Olivia.


Version 1.06: February 12, 2021

  • Optimization Update!
    • Skills that cannot be used will no longer be checked for auto triggers. Update made by Olivia.


Version 1.05: January 22, 2021

  • Bug Fixes!
    • Triggers involving the user should now work properly. Fix made by Olivia.
  • Documentation Update!
    • Help file updated for new features.
  • New Features!
    • New Notetag added by Arisu:
      • <Auto Trigger x%: condition>
        • If using the x% variant, the Auto Trigger has a x% chance to occur.
        • Replace 'x' with a number value representing the chance to succeed.


Version 1.04: December 25, 2020

  • Compatibility Update
    • Added compatibility functionality for Battle System - STB.


Version 1.03: November 22, 2020

  • Bug Fixes!
    • Auto Skill Triggers no long clear battler speed in TPB. Fixed by Yanfly.


Version 1.02: November 1, 2020

  • Bug Fixes!
    • Stunned enemies will have their auto triggers bypassed. Fix made by Olivia.


Version 1.01: October 18, 2020

  • Bug Fixes!
    • Skills and Items used outside of battle should no longer crash the game. Fix made by Yanfly.
    • Specific trigger types should no longer crash the game. Fix made by Yanfly.


Version 1.00: October 28, 2020

  • Finished Plugin!

End of File