Shop Common Events 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.



ShopCommonEvents Preview.gif

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

ShopCommonEvents Preview.gif

This plugin allows for shop items, weapons, and/or armors to launch common events upon buying or selling them, either as a one-time event or repeating. These launched Common Events will take the player outside of the shop to process the Common Events before (optionally) returning back, giving your player's party members a chance to comment on his or her purchases.

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

  • Items, weapons, and armors can launch Common Events went bought or sold.
  • These launched Common Events can occur once or repeat multiple times.
  • Store the quantity of an item bought or sold into variables to allow for some more dynamic Common Events.
  • Use switches to function as requirements to determine if the Common Events will launch, either by having all switches enabled or any one of a set.
  • A plugin command that will return the player back to the previous shop with all of the shop settings intact.

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.

---

Launching Common Events

ShopCommonEvents Preview.gif

When launching a Common Event, through either buying or selling, any of the event commands part of the initial shop launch will be cached away until the player exits the shop normally.

However, if the Common Event finishes without returning the player back to the shop without usage of the Plugin Command, then any of the cached event commands will be lost.

---

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.

---

Shop Common Event-Related Notetags

ShopCommonEvents Preview.gif

---

<Once Buy Common Event: id>
<Repeat Buy Common Event: id>

- Used for: Item, Weapon, Armor Notetags
- This will cause a specific Common Event to launch when bought.
- Replace 'id' with a number representing the ID of the Common Event that
  you wish to launch upon this item being bought.
- The "Once" notetag variant will only occur once when bought.
  - Any subsequent purchases of the item will not launch the Common Event.
- The "Repeat" notetag variant will occur repeatedly when bought.
- If both "Once" and "Repeat" notetags are present in the item, then the
  "Once" variant will take priority first. Any subsequent purchases will go
  to the "Repeat" variant.
- Any switche requirement notetags need to be met in order for either
  notetag to have any effect.

---

<Once Sell Common Event: id>
<Repeat Sell Common Event: id>

- Used for: Item, Weapon, Armor Notetags
- This will cause a specific Common Event to launch when sold.
- Replace 'id' with a number representing the ID of the Common Event that
  you wish to launch upon this item being sold.
- The "Once" notetag variant will only occur once when sold.
  - Any subsequent sellings of the item will not launch the Common Event.
- The "Repeat" notetag variant will occur repeatedly when sold.
- If both "Once" and "Repeat" notetags are present in the item, then the
  "Once" variant will take priority first. Any subsequent sellings will go
  to the "Repeat" variant.
- Any switche requirement notetags need to be met in order for either
  notetag to have any effect.

---

Requirement Switch-Related Notetags

---

<Once Buy Common Event Switch: id>
<Once Buy Common Event All Switches: id, id, id>
<Once Buy Common Event Any Switches: id, id, id>

<Repeat Buy Common Event Switch: id>
<Repeat Buy Common Event All Switches: id, id, id>
<Repeat Buy Common Event Any Switches: id, id, id>

- Used for: Item, Weapon, Armor Notetags
- Requires the respective Buy Common Events to have these Switches enabled
  in the "ON" position in order for them to launch.
  - "Once" variant will only affect the "Once" notetag buy variants.
  - "Repeat" variant will only affect the "Repeat" notetag buy variants.
- The "All" variant will require all listed Switch ID's to be "ON".
- The "Any" variant will require only one listed Switch ID to be "ON".
- Replace 'id' with a number representing the Switch ID that needs to be in
  the "ON" position for the requirement to be met.
  - Insert multiple 'id' to require more Switch ID's.

---

<Once Sell Common Event Switch: id>
<Once Sell Common Event All Switches: id, id, id>
<Once Sell Common Event Any Switches: id, id, id>

<Repeat Sell Common Event Switch: id>
<Repeat Sell Common Event All Switches: id, id, id>
<Repeat Sell Common Event Any Switches: id, id, id>

- Used for: Item, Weapon, Armor Notetags
- Requires the respective Sell Common Events to have these Switches enabled
  in the "ON" position in order for them to launch.
  - "Once" variant will only affect the "Once" notetag sell variants.
  - "Repeat" variant will only affect the "Repeat" notetag sell variants.
- The "All" variant will require all listed Switch ID's to be "ON".
- The "Any" variant will require only one listed Switch ID to be "ON".
- Replace 'id' with a number representing the Switch ID that needs to be in
  the "ON" position for the requirement to be met.
  - Insert multiple 'id' to require more Switch ID's.

---


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.

---

Return Plugin Commands

ShopCommonEvents Preview.gif

---

ShopCommonEvents Command1.png

Return: To Last Shop
- Return to the last shop if coming from a Shop Common Event.

---

Plugin Parameters

General Settings

ShopCommonEvents Preview.gif

ShopCommonEvents Params.png

These are primarily settings to automatically record the quantity/amount of an item, weapon, or armor bought or sold in the shop in case you want to have a dynamic Common Event dependent on them.

---

General Settings

 Variable: Buy Quantity:
 - When buying, register amount bought to this variable.
 - 0 to not use this feature.
 Variable: Sell Quantity:
 - When Selling, register amount sold to this variable.
 - 0 to not use this feature.

---


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

Shop Common Events VisuStella MZ

Version 1.01: September 17, 2021

  • Bug Fixes!
    • Prevents canceling purchases from launching Common Events. Fix by Arisu.


Version 1.00 Official Release Date: October 4, 2021

  • Finished Plugin!

End of File