Equip Battle Skills VisuStella MZ

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.	Click here to learn how to update plugins.	Click here for how to troubleshoot plugins if you get an error.

Masterarbeit Writer

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. Core Engine VisuStella MZ Battle Core VisuStella MZ Skills and States Core VisuStella MZ 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 This plugin creates a new gameplay mechanic where players have to choose which skills to bring into battle. They can select what skills to bring from the skill menu. In addition to being able to do that, equipped skills can also add bonuses such as stats and/or passive states. This plugin can also impose a limit upon actors to limit what skills can be equipped based on skill tiers. Features include all (but not limited to) the following: Limit the amount of skills actors can bring into battle. They can choose which to equip and which they cannot equip. Skill tiers can be used to further limit the strength of the skills they can bring into battle. Add and/or customize the skill tiers to your liking. Choose their name, their appearance, the associated skill name color, and the number of slots that actors can utilize. Equipped skills can bestow stat bonuses or passive states when equipped. Plugin Commands can increase or decrease the maximum amount of battle skill slots an actor can have. Plugin Commands can also increase or decrease the skill tier limitations regarding equipped battle skills. Trait objects such as weapons and armors can also have an influence on the maximum number of equipped battle skills and the skill tier limitations. Requirements This plugin is made for RPG Maker MZ. This will not work in other iterations of RPG Maker. Required Plugin List Core Engine VisuStella MZ Battle Core VisuStella MZ Skills and States Core VisuStella MZ 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. --- Battle Command > Skill Types Substitute If an actor uses equipped battle skills, skill types added by the Battle Command 'skills' will be substituted for a single category, 'battle skills'. Here, only the equipped skills for battle will be listed. However, any uses of 'SType: x' or 'SType: name' will still enable those specific skill types to be fully usable. This is also how to imitate Yanfly Engine Plugins' version of "Allowed Types" for Equip Battle Skills. This does NOT mean that if you use 'SType: x' that only the equipped skills will appear in there and the non-equipped skills will be unavailable. This means that for 'SType: x' skill access, ALL of the skills for that skill type linked to the actor will become available regardless of what is equipped for the battle skills or not. --- Battle Command > All Skills Substitute If an actor uses equipped battle skills, the Battle Command 'all skills' will only list the skills currently equipped for battle. Empty slots will be bypassed in favor of keeping the Battle Command Window condensed. You can still use 'Skill: x' or 'Skill: name' to manually add specific single skills to the Battle Command Window. --- Skills with Multiple Skill Types If you are using the Skills and States Core and add multiple skill types to a skill, if one of them belongs to a 'SType: x' battle command, that skill will appear in the skill type while also appearing in the equipped battle skills listing. --- Skills with Multiple Skill Types If you are using the Skills and States Core and add multiple skill types to a skill, if one of them belongs to a 'SType: x' battle command, that skill will appear in the skill type while also appearing in the equipped battle skills listing. --- Battle Test For the sake of better play testing, battle tests will have this equipped battle skills disabled. This is because there's no way to properly prepare a skill loadout through RPG Maker MZ's battle test preparation window. --- Skill Name Colors If equip skill tiers are enabled, then skill name colors will be based on their equip skill tier settings. --- Extra Features There are some extra features found if other VisuStella MZ plugins are found present in the Plugin Manager list. --- Items and Equips Core VisuStella MZ When equipping battle skills have that parameter changes that affect MaxHP or MaxMP, the changes will be affected by the "Equip-Adjust HP/MP" plugin parameter where the game will adjust HP/MP differences after equipping any skills with MaxHP/MaxMP values. --- 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. --- Max Slots-Related Notetags --- <Equip Skill Base Slots: x> - Used for: Actor, Class Notetags - Determines the base equip battle skill slots an actor can have. - Priority will be given to the actor notetag over the class notetag if both notetags are present. - Replace 'x' with a number representing the base slots amount. - If this notetag is not used, use the Plugin Parameters default value. --- <Equip Skill Slots: +x> <Equip Skill Slots: -x> - Used for: Actor, Class, Weapon, Armor, State Notetags - Alters the maximum amount of equip battle skill slots an actor can have on top of the base value. - Replace 'x' with a number representing the increase or decrease in maximum equip battle skill slots. --- Skill Tier-Related Notetags --- <Skill Tier: key> - Used for: Skill Notetags - Determines the skill tier the skill belongs to. - Replace 'key' with the 'Tier ID Key' of the tier. You can find this data in the 'Skill Tiers' Plugin Parameters. --- <Skill Tier key Base Slots: x> - Used for: Actor, Class Notetags - Determines the base skill slots associated with the 'key' skill tier that an actor can have. - Priority will be given to the actor notetag over the class notetag if both notetags are present. - Replace 'key' with the 'Tier ID Key' of the tier. You can find this data in the 'Skill Tiers' Plugin Parameters. - Replace 'x' with a number representing the base slots amount. - Insert multiple copies of this notetag to provide different base amounts for different skill tiers. --- <Skill Tier key Slots: +x> <Skill Tier key Slots: -x> - Used for: Actor, Class, Weapon, Armor, State Notetags - Alters the maximum amount of skill slots associated with the 'key' skill tier that an actor can have. - Replace 'key' with the 'Tier ID Key' of the tier. You can find this data in the 'Skill Tiers' Plugin Parameters. - Replace 'x' with a number representing the increase or decrease in maximum equip battle skill slots. - Insert multiple copies of this notetag to provide different bonus amounts for different skill tiers. --- Equip Bonuses-Related Notetags --- <Equip param: +x> <Equip param: -x> - Used for: Skill Notetags - If this skill is equipped as a battle skill, it will also provide a flat stat increase/decrease to 'param' by 'x' amount. - Replace 'param' with 'MaxHP', 'MaxMP', 'ATK', 'DEF', 'MAT', 'MDF', 'AGI', or 'LUK' to determine which parameter to alter. - Replace 'x' with an integer to determine the flat increase or decrease to the designated parameter. - Insert multiple copies of this notetag to provide different bonus amounts for different parameters. --- <Equip State: id> <Equip States: id, id, id> <Equip State: name> <Equip States: name, name, name> - Used for: Skill Notetags - If this skill is equipped as a battle skill, it will also provide the designated state(s) as passive state(s) as long as the skill is equipped. - Replace 'id' with a number representing the ID of the state to add as a passive state that is only active while this equipped as a battle skill. - Replace 'name' with the name of the state to add as a passive state that is only active while this equipped as a battle skill. - Separate multiple names with commas. Case is not sensitive. - This differs from <Passive State: x> in how <Passive State: x> will always be providing the passive state regardless if the skill is equipped or not. This notetag requires the skill to be equipped in order to work. --- Actor Restriction-Related Notetags --- <Can Equip Battle Skills> <Cannot Equip Battle Skills> - Used for: Class Notetags - Determines if certain classes can equip battle skills or not. - If a class can equip battle skills, then the actor can utilize the equip battle skill mechanics. - If a class cannot, then they will behave as normally. --- Skill Restriction-Related Notetags --- <Cannot Equip> - Used for: Skill Notetags - This skill cannot be equipped as a battle skill. --- <Hide Equippable> - Used for: Skill Notetags - This skill cannot be equipped as a battle skill and will also be hidden from the equip skill list. --- <Access Equippable> <Access Only Equippable> - Used for: Skill Notetags - This skill can only be equipped as a battle skill if the actor would normally have access to its skill type(s). - The notetag variants do the same thing. Which you choose to use is entirely up to personal preference. --- <Always Equippable> <All Access Equippable> - Used for: Skill Notetags - This skill can always be equipped as a battle skill regardless if the actor would normally have access to its skill type(s). - The notetag variants do the same thing. Which you choose to use is entirely up to personal preference. --- Plugin Commands Plugin Commands are event commands that are used to call upon functions added by a plugin that aren't inherently a part of RPG Maker MZ. Here is a list of Plugin Command(s) that you may use: --- The following are Plugin Commands that come with this plugin. They can be accessed through the Plugin Command event command. --- Actor Plugin Commands --- Actor: Change Max Skill Slots - Changes maximum skill slots for target actor(s). - Cannot be used in battle. Actor ID(s): - Select which Actor ID(s) to affect. Change Amount: - Changes the maximum skill slots by this amount. - Max slots cannot go below 1 or above hard cap. --- Actor: Change Skill Tier Slots - Changes skill tier slots for target actor(s). - Cannot be used in battle. Actor ID(s): - Select which Actor ID(s) to affect. Tiers(s): - Enter in the Tier ID Key to alter the skill slots for. Change Amount: - Changes the maximum skill slots by this amount. - Max slots cannot go below 1 or above hard cap. --- Party Plugin Commands --- Party: Change Max Skill Slots - Changes maximum skill slots for target party member(s). - Cannot be used in battle. Party Index(es): - Select which party member(s) to affect. - Index values start at 0. Change Amount: - Changes the maximum skill slots by this amount. - Max slots cannot go below 1 or above hard cap. --- Party: Change Skill Tier Slots - Changes skill tier slots for target party member(s). - Cannot be used in battle. Party Index(es): - Select which party member(s) to affect. - Index values start at 0. Tiers(s): - Enter in the Tier ID Key to alter the skill slots for. Change Amount: - Changes the maximum skill slots by this amount. - Max slots cannot go below 1 or above hard cap. --- Plugin Parameters General Settings General settings for Equip Battle Skills. --- General Default Enable?: - Enable Equip Battle Skills for all actors by default? - Bypassed by <Can Equip Battle Skills> and <Cannot Equip Battle Skills> notetags. All Type Access?: - Can actors equip skills from all skill types or just the skill types they have access to? --- Skill Slots Default Base Slots: - What is the default amount of equip battle skill slots available for each actor? Maximum Slots: - What is the maximum number of equip battle skill slots that an actor can achieve? --- Skill Tier Settings A list of the skill tiers available in this game and the various settings used for it. Add more skill tiers or edit the available tiers to your needs. --- Plugin Parameters Enable Tier System?: - Enable the Equip Tier System for Equip Battle Skills? --- Skill Tier Entries Tier ID Key: - What is this skill tier's ID key? --- Skill Tier Entries > Display Display Name: - What is the text used to display this skill tier in the Skill Status Window? Display Color: - Use #rrggbb for custom colors or regular numbers for text colors from the Window Skin. Display Icon: - Select an icon to display for this skill tier. - This icon will be used in the Skill Status Window. Marker Abbreviation: - What is the text used to display this skill tier as an abbreviation marker in the equip skill list? --- Skill Tier Entries > Tier Slots Base Slots: - What is the default amount of skill tier slots available for this skill tier type? Maximum Slots: - What is the maximum number of skill tier slots that can be achieved? --- Vocabulary Settings These settings let you adjust the text displayed for this plugin. --- Command Windows Battle Command: - Command name used for the Battle Command Window. Skill Type Command: - Command name used for the Skill Type Window. --- Equip Window Marker Format: - Format used when showing skills in equip list. - %1 - Skill Name, %2 - Equip Marker, %3 - Tier Marker Equipped: - Text used when displaying skill is currently equipped. Tier Format: - Format used when displaying tier name. - %1 - Tier Name Available Format: - Format used to display available slots. - %1 - Current Used, %2 - Max Slots --- Help Window Empty List: - Description used for picking a slot to equip. - Text codes allowed. Empty Equip: - Description used for picking a skill to equip. - Text codes allowed. --- Button Assist Window Unequip Text: - Text used for unequip skill shortcut. --- Window Settings These settings let you adjust the windows displayed for this plugin. --- Empty Slot Empty Icon: - Icon used for empty slots. Empty Slot Name: - Text used for an empty slot. Empty Color: - Use #rrggbb for custom colors or regular numbers for text colors from the Window Skin. --- Skill Type Window Above Skill Types: - Do you want the "Equip" command above skill types or below them in the skill type command window? Battle Skills Icon: - Icon used for "Equip" command and "Battle Skills" in the battle command window. --- Equip Skill Window Background Type: - Select background type for this window. --- Skill Status Window Show Skill Tiers?: - Show skill tiers in the Skill Status Window? - There needs to be enough space for this to work. Normal Slots Color: - Use #rrggbb for custom colors or regular numbers for text colors from the Window Skin. Full Slots Color: - Use #rrggbb for custom colors or regular numbers for text colors from the Window Skin. Slots Font Size: - Font size used for skill tier slots available. JS: Draw Status: - JavaScript code used to draw in Window_SkillStatus to display Equip Battle Skill Tiers. --- 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 Yanfly Arisu Olivia Irina Changelog Version 1.07: July 16, 2024 Compatibility Update! Compatibility with Option Core's Auto-Battle + Attack Only should now work together with this plugin. Update made by Olivia. Version 1.06: May 16, 2024 Compatibility Update! Plugins should be more compatible with one another. Version 1.05: April 18, 2024 Bug Fixes! Auto battle now limits the skill pool to the equipped battle skills list rather than giving access to unequipped skills. Fix made by Irina. Plugin now works better with Command Remember. Fix made by Irina. Documentation Update! Help file updated for new features. New Features! New notetag added by Irina: <Hide Equippable> This skill cannot be equipped as a battle skill and will also be hidden from the equip skill list. Version 1.04: January 18, 2024 Bug Fixes! Fixed a problem where no skills would show at all. Fixed made by Olivia. Version 1.03: December 14, 2023 Bug Fixes! Fixed a bug where <Hide in Battle> did not apply to equipped battle skills during battle. Fix made by Olivia. Version 1.02: August 17, 2023 Documentation Update! Explanation for Battle Command > Skill Types Substitute updated. If an actor uses equipped battle skills, skill types added by the Battle Command 'skills' will be substituted for a single category, 'battle skills'. Here, only the equipped skills for battle will be listed. However, any uses of 'SType: x' or 'SType: name' will still enable those specific skill types to be fully usable. This is also how to imitate Yanfly Engine Plugins' version of "Allowed Types" for Equip Battle Skills. This does NOT mean that if you use 'SType: x' that only the equipped skills will appear in there and the non-equipped skills will be unavailable. This means that for 'SType: x' skill access, ALL of the skills for that skill type linked to the actor will become available regardless of what is equipped for the battle skills or not. Version 1.01: June 15, 2023 Documentation Update! Added a section to "Major Changes" Skills with Multiple Skill Types If you are using the Skills and States Core and add multiple skill types to a skill, if one of them belongs to a 'SType: x' battle command, that skill will appear in the skill type while also appearing in the equipped battle skills listing. Feature Update! If equipped battle skills are hidden by <Hide in Battle> notetags, they will become disabled and unusable for those who want to use them as equippable passives. Update made by Irina. Version 1.00 Official Release Date: June 26, 2023 Finished Plugin! See Also Equip Battle Skills (YEP) Inspiration Behind Battle Technician Volume 4 End of Helpfile