Shop Batches 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. Items and Equips 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 Sometimes, you want shops to have promotional sales when certain items are bought in batches, bundles, or goodie bags. This plugin allows that to happen. Create a batch item that can be bought, and when the player acquires it, a bunch of items are acquired at the same time. Features include all (but not limited to) the following: Simple notetag system that allows you to create shop batch items. Batch items can include items, weapons, and armors of any quantity. When selected, batch items will show the contents of what items will be acquired when bought. Batch items will disable purchase when all items are maxed in the player party's inventory. Adjust the vocabulary settings to make the visible text appear the way you want for your game. Requirements This plugin is made for RPG Maker MZ. This will not work in other iterations of RPG Maker. Required Plugin List Items and Equips 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 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. Major Changes This plugin adds some new hard-coded features to RPG Maker MZ's functions. The following is a list of them. --- Batch Item Restrictions Batch items cannot list proxy items from the Items & Equips Core. This is because there's simply no point in doing so and that listing the real item itself is better. --- 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 On buy/sell effects will NOT apply for the items within the batch. This means if a Potion is included in a batch, and that Potion item has a notetag that would turn on a switch through the <Buy Turn On Switch: x> notetag, these effects will NOT take place. Instead, put that effect on the actual batch item itself. --- Shop Common Events VisuStella MZ On buy/sell shop Common Events will NOT take effect for items within the batch. This means if a Potion is included in a batch, and that Potion item has a notetag that would run a Common Event through a notetag such as <Repeat Buy Common Event: id>, that effect will NOT take place. Instead, put that notetag effect on the actual batch item itself. --- Shop Listing Unlock VisuStella MZ If a batch item needs to be unlocked via the VisuStella MZ Shop List Unlock feature first, the status window will show the unlock requirements first. --- 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. --- Batch-Related Notetags --- <Shop Batch> listing listing listing </Shop Batch> - Used for: Item, Weapon, Armor Notetags - Creates a list of items, weapons, and armors that the player will gain when this batch object is bought. - Proxy items, weapons, or armors cannot be listed and will be bypassed. - This item, weapon, or armor cannot be sold if all of the listed items, weapons, or armors are at max quantity within the party's inventory. - The listed items will NOT utilize any buy/sell effects for the individual listed items themselves. - Replace 'listing' with any of the listing types found below: Item id Item name Weapon id Weapon name Armor id Armor name Item id: quantity Item name: quantity Weapon id: quantity Weapon name: quantity Armor id: quantity Armor name: quantity - Replace 'id' with a number representing the ID of the item, weapon, or armor that is to be listed. - Replace 'name' with the associated item, weapon, or armor's name. - Replace 'quantity' with a number representing the number of items, weapons, or armors that will be acquired when the batch item is bought. - If the variant without 'quantity' is used, quantity will default to 1. Examples: --- <Shop Batch> Item Potion: 10 Item Super Potion: 5 Weapon Short Sword: 3 Weapon Long Sword: 2 Armor Linen Clothing: 4 Armor Cloth Armor: 3 </Shop Batch> --- <Shop Batch> Item 7: 10 Item 8: 5 Weapon 1: 3 Weapon 2: 2 Armor 2: 4 Armor 8: 3 </Shop Batch> --- --- Plugin Parameters Vocabulary Settings These settings let you adjust the text displayed for this plugin. --- Status Window Title Text: - Text that appears in the title for shop batches. - Text codes allowed. Item Name Format: - Text format used for item names. - %1 - Item Name. %2 - Item Icon. Allow Name Colors?: - If item names have custom colors, add them? - Used for items with <Color: x> notetag. - Also used for items with <Color: #rrggbb> notetag. - This one requires VisuMZ_1_MessageCore to be installed. Quantity Format: - Text format used for batch quantity. - %1 - Gain Quantity. %2 - In Party Inventory. Max Quantity Format: - Text format used for max quantity. - %1 - In Party Inventory. --- 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 Arisu Irina Olivia Yanfly Changelog Version 1.02: February 15, 2024 Bug Fixes! Fixed a bug that allowed the player to buy shop batches in bulk while ignoring price constraints. Fix made by Arisu. Version 1.01: December 14, 2023 Documentation Update! Help file updated for new features. Feature Update! Updated default Plugin Parameter settings. New Feature! New Plugin Parameter added by Irina: Plugin Parameters > Vocabulary > Allow Name Colors? If item names have custom colors, add them? Used for items with <Color: x> notetag. Also used for items with <Color: #rrggbb> notetag. This one requires VisuMZ_1_MessageCore to be installed. Version 1.00 Official Release Date: November 29, 2023 Finished Plugin! See Also Inspiration Behind Merchant Manager Volume 4 End of Helpfile