Picture 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.



PictureCommonEventsHover.gif

PictureCommonEventsBlend.gif

PictureCommonEventsTones.gif


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

With RPG Maker MZ having better touch support, it's important that almost everything can be interacted with such as pictures. Pictures on the map screen can have a Common Event bound to them, which will launch once clicked (assuming no other events are running). These pictures can also change the Common Events bound to them and/or clear them during the game.

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

  • Functionality to bind Common Events to pictures.
  • Change which Common Events run during a playthrough.
  • Clear Common Events from pictures to remove any bindings.
  • Clicked pictures can require clicking on only opaque pixels and not fully transparent ones.
  • Include hover effects like blend mode changes and tone shifts to help players understand when a picture has been selected.

Requirements

This plugin is made for RPG Maker MZ. This will not work in other iterations of RPG Maker.


Tier 4

This plugin is a Tier 4 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.


Compatibility Issues

This plugin will most likely have compatibility issues with anything that involves clicking pictures. If you are using another plugin that does something with clicking pictures on the map screen, the likelihood of clashing can occur if these plugins utilize the same pictures and we will not be held accountable for that as it is something within your power to change by simply picking different pictures.

Instructions

PictureCommonEventsBlend.gif

In the Plugin Parameters, you will see a list of all the pictures that you can bind to a Common Event. If that number is something other than 0, then the number associated with it will be the Common Event that will run. If you assign it to a Common Event ID that does not exist, you will get an error so please be wary of that.

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.

---

System Plugin Commands

---

PictureCommonEventsHover.gif

PicCommonEventsCommand1.png

System: Change Picture Common Event
- Change the Common Event bound to specific picture(s).

  Picture ID(s):
  - Select which Picture ID(s) to change.

  Common Event ID:
  - Change the Common Event bound to specific picture(s).

  Custom

    Opaque Only?
    - Ignore clicks on transparent pixels and accept only opaque pixels for
      this specific picture.

      Error Margin:
      - Error margin when clicking for opaque pixels.
      - This value determines the radius.

    Change Tone on Hover?
    - Change the tone of the picture on hover?

      Hover Tone:
      - Tone settings upon hovering.
      - Format: [Red, Green, Blue, Gray]

    Blend Mode on Hover:
    - The blend mode used when this picture is hovered over.

---

PicCommonEventsCommand2.png

System: Clear All Picture Common Events
- Clears all Common Event bound to specific picture(s).

---

PicCommonEventsCommand3.png

System: Clear Picture Common Event
- Clears any Common Event bound to specific picture(s).

  Picture ID(s):
  - Select which Picture ID(s) to clear.

---

PicCommonEventsCommand4.png

System: Erase & Clear All Pictures
- Erases all pictures on the screen and clears their Common Events.

---

PicCommonEventsCommand5.png

System: Erase & Clear Picture
- Erases and clears any Common Events attached to specific picture(s).

  Picture ID(s):
  - Select which Picture ID(s) to erase and clear.

---

Plugin Parameters

Default Global Settings

PictureCommonEvents1.png

These Plugin Parameters allow you to adjust which Pictures will trigger which Common Events upon being clicked.

---

PictureCommonEventsHover.gif

General

 Opaque Only?
 - Ignore clicks on transparent pixels and accept only opaque pixels for
   the Plugin Parameter bindings.
   Error Margin:
   - Error margin when clicking for opaque pixels.
   - This value determines the radius.

PictureCommonEventsTones.gif

 Change Tone on Hover?
 - Change the tone of the picture on hover?
   Hover Tone:
   - Tone settings upon hovering.
   - Format: [Red, Green, Blue, Gray]

PictureCommonEventsBlend.gif

 Blend Mode on Hover:
 - The blend mode used when this picture is hovered over.

---

Picture Settings

PictureCommonEvents2.png

Each of the 100 picture slots are listed in the Plugin Parameters and can be assigned a default setting that is already set up at the start of the game without needing to assign a Common Event to it by a Plugin Command.

You can still overwrite their settings through a Plugin Command.

---

Pictures #1 through #100

 Picture #1:
 through
 Picture #100:
 - Default Common Event settings to bind to this picture ID.

---

Picture Settings

 Common Event ID:
 - The common event settings you wish to tie to this picture.
 Custom

PictureCommonEventsHover.gif

   Opaque Only?
   - Ignore clicks on transparent pixels and accept only opaque pixels for
     this specific picture.
     Error Margin:
     - Error margin when clicking for opaque pixels.
     - This value determines the radius.

PictureCommonEventsTones.gif

   Change Tone on Hover?
   - Change the tone of the picture on hover?
     Hover Tone:
     - Tone settings upon hovering.
     - Format: [Red, Green, Blue, Gray]

PictureCommonEventsBlend.gif

   Blend Mode on Hover:
   - The blend mode used when this picture is hovered over.

---


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: September 4, 2020

  • Finished Plugin!

Help File