Weapon Swap System 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.



WeaponSwapSys Ani.gif

WeaponSwapSys Menu.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

WeaponSwapSys Ani.gif

This plugin adds in a Weapon Swap System. Actors can equip a different weapon for each weapon type available for use. These weapons can be swapped to and from during the middle of a battle. Swapping weapons can let the player's team adapt to certain situations better or giving them the ability to hit certain weapon weaknesses in battle.

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

  • Actors can equip multiple weapons, one for each weapon type.
  • These weapons can be switched during the middle of battle.
  • Choose to display only equippable weapon types in the Equip Menu or all of the possible weapon types.
  • Have certain skills switch over to different equipped weapons when performing them.
  • Shortcut keys to allow switching between weapon types easily when selecting commands.

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 2

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


Major Changes

This plugin adds some new hard-coded features to RPG Maker MZ's functions. The following is a list of them.

---

Dual Wielding

Dual Wielding properties have been disabled to allow for the Weapon Swap System. There are too many conflicts between it and the Weapon Swap System. There is simply no way around it.

---

Required Weapons

RPG Maker MZ's skills allowed for Required Weapons and needed the actor to have any of the said weapon type(s) equipped upon usage. This function has now been changed. Now, as long as the actor has any of the weapon types available and a weapon attached to it, the actor will be able to use the skill without needing to switch to that weapon first.

When using the skill, the actor will switch to the first available weapon type if needed as long as it is a requirement.

---

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.

---

Items and Equips Core VisuStella MZ

The custom equip slots feature from the VisuStella MZ Items and Equips Core allowed you to add in extra weapon slots. This is now curated up to a max of one weapon slot per character. This needs to be done to make the Weapon Swap System viable.

---

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 Usage-Related Notetags

WeaponSwapSys Ani.gif

---

<Require Any Weapon>

- Used for: Skill Notetags
- Requires the actor to have any weapon equipped in order to use the skill,
  regardless of the weapon's type.
- This does not affect enemies.

---

<Switch to Weapon Type: id>
<Switch to Weapon Type: name>

- Used for: Skill Notetags
- When using the skill, the actor will switch to the equipped weapon of the
  matching type.
- Replace 'id' with a number representing the weapon type's ID.
- Replace 'name' with the name of the weapon type.
- Weapon types are not the same as weapons. Weapon types are found in the
  Database > Types tab.
- This does not affect enemies.

---

Plugin Parameters

Mechanics Settings

WeaponSwapSys Ani.gif

WeaponSwapSys Param1.png

There's not too many mechanics that can be modified through the Plugin Parameters, but the setting here will at least let you ease up on testing battles from the database.

---

Battle Test

 Equip All Weapons?:
 - Do you want to equip one of each weapon type during battle tests for
   all actors?

---

UI Settings

WeaponSwapSys Ani.gif

WeaponSwapSys Param2.png

The following Plugin Parameters are dedicated towards modifying the UI elements added through this plugin.

---

Attack Command

 Change Attack Icon?:
 - Change the Attack command to show the weapon?
 - Or have it represent the Attack skill?
 Swap Shortcut?:
 - Allow shortcut to switch weapons while selecting the Attack command?
   Show Arrows?:
   - Show arrows to the left and right of the Attack command for an easy
     reminder of the shortcut?

---

Swap Command

 Show Command?:
 - Show the Swap weapon command in the Actor Command Window?
 - The Swap weapon command will be listed by default after the Attack
   command.
   - If you do not have the Attack command, it will not be shown unless you
     add "Weapon Swap" to the battle command list.
 Swap Icon:
 - What icon do you wish to use to represent the Swap command for the
   Actor Command Window?
 Swap Name:
 - What text do you want to use to represent the Swap command for the
   Actor Command Window?

---

WeaponSwapSys Menu.png

Equip Scene

 Show Unequippable?:
 - Show all weapon types in the equip scene?
 - Or only just the equippable ones?

---


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.08: July 9, 2021

  • Bug Fixes!
    • Removed a potential equipment duplication exploit with changing classes. Fix made by Olivia.


Version 1.07: July 2, 2021

  • Optimization Update!
    • Plugin should run more optimized.


Version 1.06: June 25, 2021

  • Bug Fixes!
    • Have the "Shortcut" plugin parameter off will no longer cause crashes. Fix made by Olivia.


Version 1.05: June 4, 2021

  • Bug Fixes!
    • Fixed weapon swap notetags to have them occur naturally. Fix by Arisu.


Version 1.04: May 28, 2021

  • Bug Fixes!
    • Cache clear will now occur when using automatic switching to update any cached stats for actors. Fix made by Olivia.


Version 1.03: May 21, 2021

  • Bug Fixes!
    • Weapon type requirements for skills will the weapon type to be equipped as one of the available slots.


Version 1.02: April 16, 2021

  • Bug Fixes!
    • Shortcut arrows should no longer be visible when an actor has only one weapon to swap to and from. Fix made by Olivia.
  • Compatibility Update!
    • Weapon Swap System should now be compatible with the Item and Equip Core's non-removable types setting. Update made by Irina.


Version 1.01: April 9, 2021

  • Bug Fixes!
    • Shortcut arrow now accounts for changes in the actor command window size when updated post-initialization. Fix made by Olivia.
  • Documentation Update!
    • Help file updated for new features.
    • Documentation updated for the "UI Settings Plugin Parameters":
      • The Swap weapon command will be listed by default after the Attack command.
        • If you do not have the Attack command, it will not be shown unless you add "Weapon Swap" to the battle command list.
  • New Features!
    • New Plugin Parameters added by Olivia!
      • Plugin Parameters > UI Settings > Help: Swap
        • Help text for Swap command.


Version 1.00 Official Release Date: May 3, 2021

  • Finished Plugin!

End of File