Party System 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.

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 RPG Maker MZ only gives game projects the ability to switch party members within the main menu and nothing more. There's no inherent functionality to lock party members, make party members required, and/or give players the ability to switch party members mid-battle. This plugin will add in all of those functions as well as a dedicated scene for switching party members. Party switching will allow party members to be removed, swapped, and sorted. Through the usage of Plugin Commands, party members can also be locked and/or required for party presence. Those using the VisuStella MZ Battle Core will also have access to features in this plugin that aren't available otherwise. These features give players the functionality to switch out the whole party lineup mid-battle and/or individual party member switching. Features include all (but not limited to) the following: Custom scene dedicated to party management. Change the maximum number of party members that can participate in battle. Plugin Commands to lock party members. Plugin Commands to make certain party members required. Added functionality with Battle Core to switch party members mid-battle. This comes in the form of changing either the whole party at once. Or switching individual members out one at a time. Requirements This plugin is made for RPG Maker MZ. This will not work in other iterations of RPG Maker. 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. --- 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. --- Battle System - OTB VisuStella MZ With Battle System - OTB, the player cannot change entire parties at once from the Party Command Window. The feature will be unaccessible while Order Turn Battle is in play. However, the player can still change party members through the Actor Command Window by having actors replace other actors. Party changing is also available through battle events, Common Events, and script calls. --- Main Menu Formation Command This command is now changed to send the player to Scene_Party for the player to have a dedicated scene for changing the party. --- Battle Members Array Previously, the battle members are decided by which actors are lined up first in the party roster. This has been changed to give players the freedom to have a party size less than the maximum. This change is made by changing the way the battle members are determined by using a new array. However, any and all functions utilize the $gameParty.battleMembers() function will still behave as normal. --- Formation Change OK Function RPG Maker MZ did not do anything with the Game_Actor.isFormationChangeOk function so this plugin overwrote it completely to allow for the new lock and require features to work. --- 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 If the VisuStella MZ Battle Core plugin is present, players are able to access party switching functionality mid-battle at will. This can be in the form of switching out the entire active party roster at once or individually for each actor. Switching Entire Rosters: This can be done by going into this plugin's Plugin Parameters => General => Party Command Window => Add Party Command. If the Party Command Window is accessible, the player will be able to see the option between 'Auto Battle' and 'Options'. Individual Member Switching: This requires going to VisuMZ_1_BattleCore's Plugin Parameters => Actor Command Window => Battle Commands => Command List and add in the "party" option. The "party" option can also be added to the <Battle Commands> notetag. --- 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. --- Party Plugin Commands --- Party: Call Party Scene - Calls the party changing scene. --- Party: Change Max Battle Members - Changes the number of max battle members possible. - Cannot be use mid-battle. Max Members: - Changes the number of max battle members possible. - Use 0 for the game's default number. --- Party: Lock/Unlock Member(s) - Allows you to lock/unlock a party member. - Locked actors cannot change their party position. Actor ID(s): - Select which actor(s) to lock/unlock. - Locked actors cannot change their party position. Lock?: - Lock the selected actor(s)? --- Party: Move Actor(s) to Active - Map Only. - Moves an actor to the active party if there is room. - The actor needs to have joined the party. Actor ID(s): - Select which actor(s) to move to the active party if there is room. --- Party: Move Actor(s) to Reserve - Map Only. - Moves an actor to the reserve party. - Must be 1 actor left. - The actor needs to have joined the party. Actor ID(s): - Select which actor(s) to move to the reserve party. --- Party: Move Party Index to Reserve - Map only. - Moves an actor in a specific party index to reserve. - Must be 1 actor left. Index: - Type in which index to move. - Index values start at 0. - You may use JavaScript code. --- Party: Move Random Reserve to Active - Map only. - Moves a random actor from the reserve party to active. - Must be enough space in active party. --- Party: Require Member(s) - Allows you to require/free a party member. - Required actors must be in the party to exit the scene. Actor ID(s): - Select which actor(s) to require/free. - Required actors must be in the party to exit the scene. Require?: - Make the selected actor(s) required? --- Plugin Parameters General Settings These Plugin Parameters control the overall behaviors pertaining to the Party System added with this plugin. These behaviors range from the maximum number of members that can participate in battle to the availability of the party switching mechanics. --- General Max Battle Members: - Maximum number of battle members. --- Party Scene Add Remove Command: - Add the 'Remove' command to the party scene? Locked Member Icon: - Icon used for a locked party member. Required Member Icon: - Icon used for a required party member. Show Back Rectangles?: - Show back rectangles of darker colors to display information better? Back Rectangle Color: - Use #rrggbb for custom colors or regular numbers for text colors from the Window Skin. --- Party Command Window - These require VisuMZ_1_BattleCore! Add Party Command: - Add the 'Party' command to the Party Command Window? Command Cooldown: - Cooldown (in turns) for this command to be available again. --- Actor Command Window - These require VisuMZ_1_BattleCore! Add Switch Command: - Add the 'Switch' command to the Actor Command Window? Command Cooldown: - Cooldown (in turns) for this command to be available again. Switch Out Animation?: - Show the sprites switching out when using individual party member switching? TPB: Immediate Action: - Allow actors to immediate act upon switching in for TPB battle systems? --- Vocabulary Settings These Plugin Parameters control the text that you see in-game related to the Party System plugin. --- General Active Party: - Vocabulary used to represent the Active Party. Reserve Party: - Vocabulary used to represent the Reserve Party. Status: - Vocabulary used to represent the Status Window. --- Party Scene > Windows Empty: - For the party and status windows when no actor is selected. Remove: - For the remove option. --- Party Scene > Button Assist Swap Positions: - Button assist text for the page up/down commands. - Requires VisuMZ_0_CoreEngine! Remove: - Button assist text for the removal command. - Requires VisuMZ_0_CoreEngine! Sort: - Button assist text for the sort command. - Requires VisuMZ_0_CoreEngine! Swap In: - Button assist text for swapping in actors. - Requires VisuMZ_0_CoreEngine! Swap Out: - Button assist text for swapping out actors. - Requires VisuMZ_0_CoreEngine! --- Battle Scene Party Command: - Command text for entering Party Scene. - Requires VisuMZ_1_BattleCore! Help: Formation: - Help text for Formation command. - Requires VisuMZ_1_BattleCore! Queue Message: - Message to say the Party Scene is queued. - Requires VisuMZ_1_BattleCore! Switch Command: - Command text for switching out members. - Requires VisuMZ_1_BattleCore! Help: Switch: - Help text for Switch command. - Requires VisuMZ_1_BattleCore! --- Background Settings Background settings for Scene_Party. --- Background Settings Snapshop Opacity: - Snapshot opacity for the scene. Background 1: - Filename used for the bottom background image. - Leave empty if you don't wish to use one. Background 2: - Filename used for the upper background image. - Leave empty if you don't wish to use one. --- Window Settings If you don't like the locations of the windows in Scene_Party, change them up with these Plugin Parameters, provided that you have an understanding of JavaScript code. --- Active Party Label Active Party Window Reserve Party Label Reserve Party Window Status Label Status Window Battle Switch Window Background Type: - Select background type for this window. Columns: - Available only for the Reserve Party Window. - How many columns do you want there to be for the window? Actor Graphic: - Available only for Active Party Window and Reserve Party Window. - Choose how the actor graphics appear in the specific windows. - Face - Map Sprite - Sideview Battler (Requires VisuMZ_1_MainMenuCore) Map Sprite: Sideview Battler: Offset X: Offset Y: - If showing map sprites, offset the x or y coordinates. JS: X, Y, W, H: - Code used to determine the dimensions for this window. --- 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.24: March 24, 2022 Compatibility Update! Compatibility update with Skills & States Core Passive Conditions involving the party leader. Update made by Arisu. Version 1.23: January 13, 2022 Optimization Update! Plugin should run more optimized. Version 1.22: July 16, 2021 Feature Update! Added a fail safe that prevents on-battle start events from triggering when adding party members outside of battle under evented circumstances that function as a bridge between event and battle. Fix by Irina. Version 1.21: July 9, 2021 Bug Fixes! When using TPB-based battle systems, adding actors to the main party would not enable them to move. This should be fixed. Fix made by Irina. Version 1.20: July 2, 2021 Optimization Update! Plugin should run more optimized. Version 1.19: June 18, 2021 Compatibility Update Added compatibility functionality for future plugins. Version 1.18: April 16, 2021 Documentation Update! Fixed typo. Fix made by Arisu. Version 1.17: March 26, 2021 Documentation Update! Added "VisuStella MZ Compatibility" section for detailed compatibility explanations with the VisuMZ_2_BattleSystemOTB plugin. Version 1.16: March 19, 2021 Compatibility Update Added compatibility functionality for future plugins. Version 1.15: March 5, 2021 Documentation Update! Help file updated for new features. New Features New Plugin Parameter added by Irina: Plugin Parameters > Gneral > Battle Scene > Battle Party Icon For some reason, we never had a setting that lets you change the party icon. Well, now there is! Version 1.14: February 5, 2021 Documentation Update! Help file updated for new features. New Features! New Plugin Commands added by Arisu! Party: Move Party Index to Reserve Moves an actor in a specific party index to reserve. Map only. Must be 1 actor left. You may use code. Party: Move Random Reserve to Active Moves a random actor from the reserve party to active. Map only. Must be enough space in active party. Version 1.13: January 29, 2021 Documentation Update! Help file updated for new features. New Features! New Plugin Commands added by Arisu! Party: Move Actor(s) to Active Map only. Moves an actor to the active party if there is room. Party: Move Actor(s) to Reserve Map only. Moves an actor to the reserve party. Version 1.12: January 15, 2021 Bug Fixes! For battle testing, if the number of battle test members exceeds the maximum battle member slots, trim them until they match. Fix by Olivia. Version 1.11: January 1, 2021 Compatibility Update Plugins should be more compatible with one another. Version 1.10: December 25, 2020 Compatibility Update Plugins should be more compatible with one another. Version 1.09: December 18, 2020 Bug Fixes! Removing party members in the active party by event command will now be properly removed from the party. Fix made by Yanfly. Version 1.08: December 4, 2020 Bug Fixes! With TPB battle systems, after switching out party members, the battle system will no longer carry over any previous active battle members in the command window. Fix made by Yanfly. Compatibility Update! Plugins should be more compatible with one another. Version 1.07: November 22, 2020 Bug Fixes! With Active TPB, switching out a party member mid-action is no longer possible to prevent bugs. Intead, there party switching action will be queued and take effect after the action has been completed. Fix made by Yanfly. Compatibility Update! Game_Party.swapOrder function now works with this plugin. However, keep in mind that due to how this party system plugin allows you have empty slots in the active battle party, this function will fill in the empty slots upon usage. Update made by Yanfly. Version 1.06: November 1, 2020 Compatibility Update! Plugins should be more compatible with one another. Version 1.05: October 25, 2020 Bug Fixes! Plugin Command "Party: Change Max Battle Members" now works again. Fix made by Arisu. Version 1.04: October 18, 2020 Compatibility Update! Plugins should be more compatible with one another. Version 1.03: October 11, 2020 Bug Fixes! Adding party members during battle through the party window command will no longer cause crashes after they input an action. Fix made by Yanfly. Version 1.02: October 4, 2020 Bug Fixes! Adding party members during test play should now work again. Fix made by Irina. Changing party members mid-battle through the actor command should now refresh the party followers afterwards. Fix made by Yanfly. New Features! New Plugin Parameter added by Arisu! General > Party Command Window > TPB: Immediate Action Allow actors to immediate act upon switching in for TPB battle systems? Version 1.01: September 27, 2020 Bug Fixes! When switching actors with states, buffs, and/or debuffs already applied, the state icons found in the status window will now switch over properly, too. Fix made by Arisu. Version 1.00: September 7, 2020 Finished Plugin! Help File