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




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

VisuMZ PictureChoices.png

PictureChoices Example.gif

Ever wanted to create custom menus using pictures and have them work akin to how "Show Choices" event commands behave? This plugin makes that possible by letting you, the game dev, determine how pictures will behave when selected, deselected, and tie them to the various choices in the "Show Choices" window events. Create vivid menu systems with better visuals!

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

  • Use Plugin Commands to determine how specific pictures (by ID or range) will behave when selected or deselected.
  • Behaviors include easing options, position adjustments, opacity changes, blend mode differences, and tinting.
  • Determine which pictures are bound to which choice through this plugin's newly added text codes.
  • Hide the choice window through text codes to make the look more authentic.
  • Works with touch controls! Hovering over pictures will select the picture and choice option!
  • Works with keyboard controls! Even if the choice window is hidden, the keyboard will still let you scroll through the various pictures as if they were the ones arranged by the show choice options!

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.

---

Mouse Over

PictureChoices Example.gif

When the mouse is hovering a picture bound to a "Show Choices" option, the Choice Window will automatically select that option in the Choice Window regardless of whether or not hovering is disabled for windows. This decision has been made for a more intuitive user experience.

Pictures without any bindings will not have any effect.

---

Mouse Click

PictureChoices Bind.png

When the mouse clicks on a picture bound to a "Show Choices" option, the Choice Window will select that option and then prompt an "OK" handler to trigger the action as long as that option is enabled. This action will occur even if click select is the default selection process for windows for a more intuitive user experience.

Pictures without any bindings will not have any effect.

---

Usage Instructions

For a quick run through on how to use this plugin properly, follow the instructions listed below, separated into various steps.

---

Step 1

PictureChoices Step1.png

- Put out "Show Picture" events where you want them. - Create their initial positions, their ID's, their images used, and their origins decided.

---

Step 2

PictureChoices Step2.png

- Use Plugin Commands for "Picture Settings: Change ID(s)" or the "Picture Settings: Change Range". - This is used to change how images look when selected or deselected either by mouse cursor or by keyboard.

  • NOTE* Steps 1 and 2 are interchangeable but works best with "Show Picture"

before the Plugin Commands.

---

Step 3

PictureChoices Bind.png

- Use "Show Choices" event command. - For each Show Choice event command, use the following notetag:

  <Bind Picture: id>
  - where 'id' is the picture ID to bind that choice to.

- ie: <Bind Picture: 3> will have that choice be tied to picture ID 3.

---

Step 4 (Optional)

PictureChoices Step4.png

- Insert <Hide Choice Window> text code somewhere in the choice list (doesn't matter where) to hide the choice list window. - This step is optional.

---

Step 5

PictureChoices Command1.png

- At the very end, use the Plugin Commands "Clear: All Selection Settings" or "Clear: Picture ID(s) Selection Settings" or "Clear: Picture Range Selection Settings" to remove their on select or on deselect changes. - Erase picture will do the same to them. - This is to clear the binding settings so that they do not affect other "Show Choices" event commands. - This step is optional IF you have the Plugin Parameter "Auto Clear" set to "true". "Auto Clear" will trigger whenever the OK Handler or Cancel Handler is processed.

---

Text Codes

ShowTextWindowMZ.png

Text Codes are used in the Show Text event command. They are used to display things that text normally can't produce on its own, such as colors, get the name of a specific actor, change icons, and more.

RPG Maker MZ already comes with text codes of its own:

\V[n] Will be replaced with the value of the nth variable.
\N[n] Will be replaced with the name of the nth actor.
\P[n] Will be replaced by the name of the nth (arranged order) party member.
\G Will be replaced by the currency unit.
\C[n] Draw the subsequent text in the nth color. Text color conforms to the contents of the [Window.png] system image.
\I[n] Draws the nth icon.
\FS[n] Changes the text font size to 'n'.
\{ Increases the text by 1 step.
\} Decreases the text by 1 step.
\\ Replaced with the backslash character.
\$ Open the gold window.
\. Wait for 1/4 second.
\| Wait for 1 second.
\! Wait for button input.
\> Display remaining text on same line all at once.
\< Cancel the effect that displays text all at once.
\^ Do not wait for input after displaying the next.


The following are text codes that you may use with this plugin.

Picture Choice-Related Text Codes

---

PictureChoices Example.gif

--------------------   -----------------------------------------------------
Text Code              Effect (Show Choice Text Only)
--------------------   -----------------------------------------------------

<Bind Picture: id>     Replace 'id' with a Picture ID to bind the choice to.
                       If the choice is selected or deselected, the bound
                       picture will alter its look accordingly.

<Hide Choice Window>   Hides the Choice Window from view. This is so that if
                       any Picture Choices are visible, the screen won't
                       look extremely repetitive. Insert this into any of
                       the choices. Only once is needed.

---

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.

---

Clear Plugin Commands

---

PictureChoices Command1.png

Clear: All Selection Settings
- Clears all selection settings for all pictures 1 through 100.

---

PictureChoices Command2.png

Clear: Picture ID(s) Selection Settings
- Clears all selection settings for the ID'd pictures.

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

---

PictureChoices Command3.png

Clear: Picture Range Selection Settings
- Clears all selection settings for the picture ID's in range.

  Starting ID:
  - The starting ID of the picture binds to clear.

  Ending ID:
  - The ending ID of the picture binds to clear.

---

Picture Settings Plugin Commands

PictureChoices Example.gif

---

PictureChoices Command4.png

Picture Settings: Change ID(s)
- Changes select and deselect settings for the picture ID(s).

  Step 1:

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

  Step 2:

    On Select Settings:
    - Picture settings when selecting that choice.

    On Deselect Settings:
    - Picture settings when deselecting that choice.

---

PictureChoices Command5.png

Picture Settings: Change ID(s)
- Changes select and deselect settings for the picture ID(s).

  Step 1:

    Starting ID:
    - The starting ID of the picture binds to clear.

    Ending ID:
    - The ending ID of the picture binds to clear.

  Step 2:

    On Select Settings:
    - Picture settings when selecting that choice.

    On Deselect Settings:
    - Picture settings when deselecting that choice.

---

PictureChoices Command Sub.png

Picture Settings
- These are the settings used for "On Select" and "On Deselect" settings.

  Easing:

    Duration:
    - Insert a number to determine duration of the changed settings when
      applied.

    Easing Type:
    - Select which easing type you wish to apply.
    - Many of these choices require VisuMZ_0_CoreEngine.

  Position:

    Target X:
    Target Y:
    - Insert a number to determine new X/Y position.
    - Use 'Unchanged' to not change the X/Y position.

    Target Width %:
    Target Height %:
    - Insert a number to determine new width/height.
    - 'Unchanged' for no changes.
    - For 100%, use 100.

  Blend:

    Target Opacity:
    - Insert a number to determine new opacity level.
    - 'Unchanged' for no changes.
    - Use a number between 0 and 255.

    Blend Mode:
    - What kind of blend mode do you wish to apply to the picture?

  Tone:

    Target Tone Red:
    Target Tone Green:
    Target Tone Blue:
    - Insert a number to determine new red/green/blue tone tint.
    - 'Unchanged' for no changes.
    - Use a number between -255 and 255.

    Target Tone Gray:
    - Insert a number to determine new red/green/blue tone tint.
    - 'Unchanged' for no changes.
    - Use a number between 0 and 255.

---

Plugin Parameters

General Settings

PictureChoices Example.gif

PictureChoices Params.png

The majority of the settings are unique to the Plugin Commands and not the Plugin Parameters. However, the Plugin Parameters can be used as a quality of life to reduce the amount of work needed if one wants to enable the "Auto Clear" option to reduce steps needed.

---

General

 Auto Clear:
 - Automatically clear picture selection settings after each Show Choice
   command is done?
 - Erase picture will do the same to them.
 - This is to clear the binding settings so that they do not affect other
   "Show Choices" event commands.

---


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 Official Release Date: July 5, 2021

  • Finished Plugin!

End of File