Difference between revisions of "Picture Common Events VisuStella MZ"
(17 intermediate revisions by 3 users not shown) | |||
Line 1: | Line 1: | ||
{{MzPlugin | {{MzPlugin | ||
− | |preview = <youtube> | + | |preview = <youtube>https://www.youtube.com/watch?v=qbQ3hme8nqI</youtube> |
− | |link1 = <html><iframe frameborder="0" src="https://itch.io/embed/ | + | |link1 = <html><iframe frameborder="0" src="https://itch.io/embed/744099" width="552" height="167"><a href="https://visustellamz.itch.io/picture-common-events">Picture Common Events plugin for RPG Maker MZ by VisuStellaMZ</a></iframe></html> |
− | |link2 = | + | |link2 = {{VisuStella Wave 2}} |
+ | |link3 = {{VisuStella All Waves Collection}} | ||
}} | }} | ||
Line 8: | Line 9: | ||
<!-- Preview --> | <!-- Preview --> | ||
− | + | [[File:PictureCommonEventsHover.gif]] | |
− | |||
− | |||
− | |||
− | |||
− | + | [[File:PictureCommonEventsBlend.gif]] | |
− | |||
− | + | [[File:PictureCommonEventsTones.gif]] | |
{| style="width: 800px;" cellspacing="0" cellpadding="0" | {| style="width: 800px;" cellspacing="0" cellpadding="0" | ||
Line 36: | Line 32: | ||
{{Visustella MZ}} | {{Visustella MZ}} | ||
− | == | + | == 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. | ||
+ | |||
+ | {{MZ Tier 4}} | ||
+ | |||
+ | == 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 == | ||
+ | |||
+ | [[File: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. | ||
+ | |||
+ | Also be warned that the player CANNOT press Picture Common Events whenever | ||
+ | an event is running (with the exception of Parallels). This is NOT a bug. | ||
+ | |||
+ | This is because if an event is running under the main event interpreter and | ||
+ | a Picture Common Event were to be pressed, it would interrupt the flow of | ||
+ | the event. This would result in cutscenes to be potentially bugged, | ||
+ | currently running events to also be bugged, etc. | ||
+ | |||
+ | As such, the ability to click and activate Picture Common Events during an | ||
+ | event (with the exception of Parallels) are disabled to prevent potential | ||
+ | problems with the game dev cycle. | ||
+ | |||
+ | |||
+ | |||
+ | {{Plugin Commands MZ}} | ||
+ | |||
+ | {{VisuMZ Picture Common Events Plugin Commands}} | ||
+ | |||
+ | == Plugin Parameters == | ||
+ | |||
+ | === Default Global Settings === | ||
+ | |||
+ | [[File:PictureCommonEvents1.png]] | ||
+ | |||
+ | These Plugin Parameters allow you to adjust which Pictures will trigger | ||
+ | which Common Events upon being clicked. | ||
+ | |||
+ | --- | ||
+ | |||
+ | [[File: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. | ||
+ | |||
+ | [[File: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] | ||
+ | |||
+ | [[File:PictureCommonEventsBlend.gif]] | ||
+ | |||
+ | Blend Mode on Hover: | ||
+ | - The blend mode used when this picture is hovered over. | ||
+ | |||
+ | --- | ||
+ | |||
+ | === Picture Settings === | ||
+ | |||
+ | [[File: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 | ||
+ | |||
+ | [[File: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. | ||
+ | |||
+ | [[File: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] | ||
+ | |||
+ | [[File:PictureCommonEventsBlend.gif]] | ||
+ | |||
+ | Blend Mode on Hover: | ||
+ | - The blend mode used when this picture is hovered over. | ||
− | + | --- | |
− | |||
− | |||
{{VisuStella MZ Terms of Use}} | {{VisuStella MZ Terms of Use}} | ||
Line 50: | Line 193: | ||
Team VisuStella | Team VisuStella | ||
− | * | + | * [[Yanfly]] |
− | * | + | * [[Arisu]] |
− | * | + | * [[Olivia]] |
− | * | + | * [[Irina]] |
== Changelog == | == Changelog == | ||
− | * Version 1.00 | + | Version 1.02: March 17, 2022 |
− | * | + | * Documentation Update! |
+ | ** Added to "Instructions" section by Arisu: | ||
+ | *** Also be warned that the player CANNOT press Picture Common Events whenever an event is running (with the exception of Parallels). This is NOT a bug. | ||
+ | *** This is because if an event is running under the main event interpreter and a Picture Common Event were to be pressed, it would interrupt the flow of the event. This would result in cutscenes to be potentially bugged, currently running events to also be bugged, etc. | ||
+ | *** As such, the ability to click and activate Picture Common Events during an event (with the exception of Parallels) are disabled to prevent potential problems with the game dev cycle. | ||
+ | |||
+ | |||
+ | |||
+ | Version 1.01: November 18, 2021 | ||
+ | * Compatibility Update! | ||
+ | ** Should now work properly with VisuStella MZ Picture Choices. Update made by Olivia. | ||
+ | |||
+ | |||
+ | |||
+ | Version 1.00: September 4, 2020 | ||
+ | * Finished Plugin! | ||
+ | |||
+ | |||
+ | |||
+ | == See Also == | ||
+ | |||
+ | * [[Inspiration Behind Wave 2]] | ||
+ | |||
+ | |||
== Help File == | == Help File == | ||
Line 75: | Line 241: | ||
<!-- [[Category: RPG Maker MZ Quest Plugins]] --> | <!-- [[Category: RPG Maker MZ Quest Plugins]] --> | ||
<!-- [[Category: RPG Maker MZ Options Plugins]] --> | <!-- [[Category: RPG Maker MZ Options Plugins]] --> | ||
− | + | [[Category: RPG Maker MZ Eventing Plugins]] | |
− | + | [[Category: RPG Maker MZ Utility Plugins]] | |
− | + | [[Category: RPG Maker MZ Mechanical Plugins]] | |
− | + | [[Category: RPG Maker MZ Visual Plugins]] | |
<!-- [[Category: RPG Maker MZ Menu Plugins]] --> | <!-- [[Category: RPG Maker MZ Menu Plugins]] --> | ||
<!-- [[Category: RPG Maker MZ Message Plugins]] --> | <!-- [[Category: RPG Maker MZ Message Plugins]] --> | ||
− | + | [[Category: RPG Maker MZ Quality of Life Plugins]] | |
<!-- [[Category: Action Sequences (MZ)]] --> | <!-- [[Category: Action Sequences (MZ)]] --> | ||
<!-- [[Category: Comment Tags (MZ)]] --> | <!-- [[Category: Comment Tags (MZ)]] --> |
Latest revision as of 23:21, 20 November 2023
VisuStella, Caz Wolf, Fallen Angel Olivia, Atelier Irina, and other affiliated content creators.
Download | ||
SystemThis 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 MZThis plugin is a part of the VisuStella MZ Plugin Library. Click here if you want to help support VisuStella on Patreon. IntroductionWith 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:
RequirementsThis plugin is made for RPG Maker MZ. This will not work in other iterations of RPG Maker.
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 IssuesThis 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. InstructionsIn 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. Also be warned that the player CANNOT press Picture Common Events whenever an event is running (with the exception of Parallels). This is NOT a bug. This is because if an event is running under the main event interpreter and a Picture Common Event were to be pressed, it would interrupt the flow of the event. This would result in cutscenes to be potentially bugged, currently running events to also be bugged, etc. As such, the ability to click and activate Picture Common Events during an event (with the exception of Parallels) are disabled to prevent potential problems with the game dev cycle.
Plugin CommandsPlugin 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: ---
--- System Plugin Commands--- 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. --- System: Clear All Picture Common Events - Clears all Common Event bound to specific picture(s). --- System: Clear Picture Common Event - Clears any Common Event bound to specific picture(s). Picture ID(s): - Select which Picture ID(s) to clear. --- System: Erase & Clear All Pictures - Erases all pictures on the screen and clears their Common Events. --- 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 ParametersDefault Global SettingsThese Plugin Parameters allow you to adjust which Pictures will trigger which Common Events upon being clicked. --- 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. 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. --- Picture SettingsEach 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 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. ---
Terms of Use1. 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. 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. 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は一切の責任を負いません。 5. VisuStellaは、意図しない使用方法による問題、VisuStella MZライブラリ以外のプラグインとの非互換性の問題、プラグインのバージョンが最新でないことによる問題、第三者による互換性パッチが適切に動作していないことなどが原因でゲーム内で発生した問題については、一切の責任を負いません。VisuStellaは、高度なJavaScriptのノートタグやJavaScriptコードを許可するプラグインのパラメータを含む、カスタムコントロールエフェクトに使用される、ユーザー提供のカスタムコードに起因するエラーについても、一切の責任を負いません。 8. このプラグインの利用規約の追加項目や補足については、VisuStella.comに掲載されていますので、それを参照し従ってください。 CreditsIf you are using this plugin, credit the following people in your game: Team VisuStella ChangelogVersion 1.02: March 17, 2022
Version 1.01: November 18, 2021
Version 1.00: September 4, 2020
See Also
Help File |