Equipment Set Bonuses 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.



EquipSetBonuses Preview1.png

EquipSetBonuses Preview2.png

EquipSetBonuses Preview3.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

EquipSetBonuses Preview1.png

This is a RPG Maker MZ plugin that allows you to set equipment to be a part of various sets. When multiple pieces of the set are equipped, (for example: Warrior Shield, Warrior Helm, Warrior Armor), then bonuses are applied. Bonuses can be applied at different stages, too, depending on how many set pieces are being currently equipped. The art (faces, map sprites, battler, and various portraits for other plugins) for an actor can also change based on the number of equipment sets worn.

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

  • Create an unlimited amount of Equipment Sets to apply to actors when wearing matching sets of weapons and/or armor.
  • Each equipment set can apply bonuses at various stages depending on the number of set pieces equipped up to a total of 20 per Equipment Set.
  • A tooltip window to show extra data to show the player what bonuses are applied when different numbers of set pieces are equipped.
  • Apply different appearances to actor graphics (face, map sprites, battler, and portraits) depending on the number of equipment pieces equipped for certain sets.

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.

---

Equipment Set Graphics

EquipSetBonuses Preview1.png

If an actor has equipment set graphics defined, they will overwrite the face graphic, map character sprite graphic, battler graphic, and any portraits that have been added through the VisuStella MZ plugins. The equipment set graphics will take priority over the default graphics.

If an actor has multiple equipment sets on at the same time, each with their own set graphics, the set with the highest number of pieces that has defined graphics will be given priority.

---

Change Actor Images Event Command

EquipSetBonuses GfxChange.png

When changing an actor's graphics through the "Change Actor Images" event command, these changes will take priority over the Equipment Set Graphics. If you want to remove these priority graphics, set the "Change Actor Images" images to "(None)".

Keep in mind that this means you cannot make an "invisible" graphic through the "(None)" selection anymore. Instead, you need to make a work around by making a custom graphic image that is fully transparent.

---

Extra Features

There are some extra features found if other VisuStella MZ plugins are found present in the Plugin Manager list.

---

Battle Core VisuStella MZ

Main Menu Core VisuStella MZ

If the Battle Core and/or the Main Menu Core is installed, the Equipment Set Graphics also gives access to notetags that alter their battle portraits and/or menu portraits based on whatever Equipment Sets are equipped.

---

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.

---

Equipment Set Declaration-Related Notetags

EquipSetBonuses Preview1.png

---

<Equip Set: name>

- Used for: Weapon, Armor Notetags
- This assigns this item to an equipment set.
- Replace 'name' with the set name you're going to associate this equip
  with. Names must equal the Equipment Set names declared in the Plugin
  Parameters or else they will not have any effect.
- If you want to make a piece of equipment be a part of two different
  equipment sets, use multiple copies of this notetag.

---

Equipment Set Graphics-Related Notetags

EquipSetBonuses Preview2.png

---

<name Set, x Pieces Face: filename, index>
<name Set, x+ Pieces Face: filename, index>
<name Set, x to y Pieces Face: filename, index>

- Used for: Actor Notetags
- Gives this actor an Equipment Set face graphic.
- Replace 'name' with the Equipment Set name to apply to. Use the set names
  that are declared in the Plugin Parameters or there will be no effect.
- Replace 'x' with the exact number of pieces to apply this graphic to.
  This does NOT apply to larger number numbers, only exactly that amount.
- The 'x+' variant will apply the graphic from 'x' to higher numbers.
- The 'x to y' variant will apply the graphic for a range of pieces to be
  equipped in order to apply the graphic.
- Replace 'filename' with the filename of the graphic found inside the
  img/faces/ folder. Do not include the file extension.
- Replace 'index' with the index of the graphic. Index values start at 0.
-

---

<name Set, x Pieces Character: filename, index>
<name Set, x+ Pieces Character: filename, index>
<name Set, x to y Pieces Character: filename, index>

- Used for: Actor Notetags
- Gives this actor an Equipment Set face graphic.
- Replace 'name' with the Equipment Set name to apply to. Use the set names
  that are declared in the Plugin Parameters or there will be no effect.
- Replace 'x' with the exact number of pieces to apply this graphic to.
  This does NOT apply to larger number numbers, only exactly that amount.
- The 'x+' variant will apply the graphic from 'x' to higher numbers.
- The 'x to y' variant will apply the graphic for a range of pieces to be
  equipped in order to apply the graphic.
- Replace 'filename' with the filename of the graphic found inside the
  img/characters/ folder. Do not include the file extension.
- Replace 'index' with the index of the graphic. Index values start at 0.
-

---

<name Set, x Pieces Battler: filename>
<name Set, x+ Pieces Battler: filename>
<name Set, x to y Pieces Battler: filename>

- Used for: Actor Notetags
- Gives this actor an Equipment Set face graphic.
- Replace 'name' with the Equipment Set name to apply to. Use the set names
  that are declared in the Plugin Parameters or there will be no effect.
- Replace 'x' with the exact number of pieces to apply this graphic to.
  This does NOT apply to larger number numbers, only exactly that amount.
- The 'x+' variant will apply the graphic from 'x' to higher numbers.
- The 'x to y' variant will apply the graphic for a range of pieces to be
  equipped in order to apply the graphic.
- Replace 'filename' with the filename of the graphic found inside the
  img/sv_actors/ folder. Do not include the file extension.
-

---

<name Set, x Pieces Menu Portrait: filename>
<name Set, x+ Pieces Menu Portrait: filename>
<name Set, x to y Pieces Menu Portrait: filename>

- Used for: Actor Notetags
- Requires VisuMZ_1_MainMenuCore!
- Gives this actor an Equipment Set face graphic.
- Replace 'name' with the Equipment Set name to apply to. Use the set names
  that are declared in the Plugin Parameters or there will be no effect.
- Replace 'x' with the exact number of pieces to apply this graphic to.
  This does NOT apply to larger number numbers, only exactly that amount.
- The 'x+' variant will apply the graphic from 'x' to higher numbers.
- The 'x to y' variant will apply the graphic for a range of pieces to be
  equipped in order to apply the graphic.
- Replace 'filename' with the filename of the graphic found inside the
  img/pictures/ folder. Do not include the file extension.
-

---

<name Set, x Pieces Battle Portrait: filename>
<name Set, x+ Pieces Battle Portrait: filename>
<name Set, x to y Pieces Battle Portrait: filename>

- Used for: Actor Notetags
- Requires VisuMZ_1_BattleCore!
- Gives this actor an Equipment Set face graphic.
- Replace 'name' with the Equipment Set name to apply to. Use the set names
  that are declared in the Plugin Parameters or there will be no effect.
- Replace 'x' with the exact number of pieces to apply this graphic to.
  This does NOT apply to larger number numbers, only exactly that amount.
- The 'x+' variant will apply the graphic from 'x' to higher numbers.
- The 'x to y' variant will apply the graphic for a range of pieces to be
  equipped in order to apply the graphic.
- Replace 'filename' with the filename of the graphic found inside the
  img/pictures/ folder. Do not include the file extension.
-

---

Plugin Parameters

Equipment Sets Settings

EquipSetBonuses Preview1.png

EquipSetBonuses Param1.png

This is where you put all your equipment sets used in the game. Adjust their settings here.

---

EquipSetBonuses Param1a.png

Equipment Set

 Equipment Set Name:
 - This set's name used for databasing and in-game.
 - Register equips to sets using <Equip Set: x> notetag.
 Icon:
 - This is the icon used to repesent the set name.
 - Use 0 to not show an icon.

Bonuses:

 1 Piece Bonus:
 2 Pieces Bonus:
 3 Pieces Bonus:
 4 Pieces Bonus:
 5 Pieces Bonus:
 6 Pieces Bonus:
 7 Pieces Bonus:
 8 Pieces Bonus:
 9 Pieces Bonus:
 10 Pieces Bonus:
 11 Pieces Bonus:
 12 Pieces Bonus:
 13 Pieces Bonus:
 14 Pieces Bonus:
 15 Pieces Bonus:
 16 Pieces Bonus:
 17 Pieces Bonus:
 18 Pieces Bonus:
 19 Pieces Bonus:
 20 Pieces Bonus:
 - Bonuses applied for having this number of pieces equipped.
 - These settings stack with later bonuses in the same set.

---

EquipSetBonuses Param1b.png

1-20 Piece(s) Bonus

 Text:
 - Text that appears next to each piece in the tooltip window.
 - Use 'auto' if you want this to be done automatically.
   Show in Tooltip?:
   - Show this in the tooltip?

Bonuses:

   Passive States:
   - States that will be given out as passives when the required piece
     count is equipped.
   Basic Parameters:
   - Bonuses applied to the Basic Parameters when the required piece count
     is equipped.
   X Parameters:
   - Bonuses applied to the X Parameters when the required piece count is
     equipped.
   S Parameters:
   - Bonuses applied to the S Parameters when the required piece count is
     equipped.

---

EquipSetBonuses Param1c.png

Basic Parameters

 MaxHP:
 MaxMP:
 ATK:
 DEF:
 MAT:
 MDF:
 AGI:
 LUK:
 Rate:
 - Multiplicative bonus for this param when the required piece count is
   equipped.
 - 1.0 is 100%.
 Add:
 - Additive bonus for this param when the required piece count is equipped.
 - 0 is +0.

---

EquipSetBonuses Param1d.png

X Parameters

 HIT:
 EVA:
 CRI:
 CEV:
 MEV:
 MRF:
 CNT:
 HRG:
 MRG:
 TRG:
 Rate:
 - Multiplicative bonus for this param when the required piece count is
   equipped.
 - 1.0 is 100%.
 Add:
 - Additive bonus for this param when the required piece count is equipped.
 - 0.0 is +0%.

---

EquipSetBonuses Param1e.png

S Parameters

 TGR:
 GRD:
 REC:
 PHA:
 MCR:
 TCR:
 PDR:
 MDR:
 FDR:
 EXR:
 Rate:
 - Multiplicative bonus for this param when the required piece count is
   equipped.
 - 1.0 is 100%.
 Add:
 - Additive bonus for this param when the required piece count is equipped.
 - 0.0 is +0%.

---

Mechanics Settings

EquipSetBonuses Preview2.png

EquipSetBonuses Param2.png

Mechanics settings for Equipment Set Bonuses.

---

Settings

 Base Parameter Add:
 X Parameter Add:
 S Parameter Add:
 - When do you wish to apply the "Add" bonus parameters?
 - Typical Formula: (base + plus) * rate + flat
   - Plus - Apply Before Rate
   - Flat - Apply After Rate
 - For the purpose of keeping the bonuses consistent without confusing any
   players, there will be no notetags to shift between the two settings as
   an exception for an equip bonus.

---

Tooltip Settings

EquipSetBonuses Preview3.png

EquipSetBonuses Param3.png

Tooltip settings for Equipment Set Bonuses. The tooltip window will appear when selecting equipment with the <Equip Set: name> notetag.

By default, it will by anchored towards the upper left. However, if the position of the tooltip would extend past the bottom of the screen, then the tooltip window will change its anchor towards the bottom left as to not cover the name of the item it is displaying information for.

---

Appearance

 Show Tooltip?:
 - Show tooltips for Equipment Set Bonuses?
 Scale:
 - What scale size do you want for the tooltip?
 - Use 1.0 for normal size.
 Skin Filename:
 - What window skin do you want to use for the tooltip?
 Skin Opacity:
 - What opacity setting is used for the tooltip?
 - Use a number between 0 and 255.

---

Offset

 Offset X:
 - Offset the tooltip X position from the mouse?
 - Negative: left. Positive: right.
 Offset Y:
 - Offset the tooltip Y position from the mouse?
 - Negative: up. Positive: down.
 - Inversed when low on screen.

---


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: March 8, 2021

  • Finished Plugin!

End of File