Button Trigger Events VisuStella MZ

From Yanfly.moe Wiki
Revision as of 14:09, 9 February 2022 by Irina (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
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.



Riviera Preview1.gif

Riviera Preview2.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

Riviera Preview1.gif

This plugin allows you, the game dev, the setup events that can be remotely triggered by certain button presses even if the player character is across the map. This can be used in a number of ways such as setting up specific interactions or even reproducing a point and click navigation style.

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

  • Setup events that can remotely trigger upon the player pressing specific keyboard buttons. The player character doesn't need to be near the event.
  • Setup which buttons will trigger the event. These buttons range from the directional arrows, the OK, cancel, Page Up, Page Down, CTRL, Shift, and Tab buttons on the keyboard.
  • Automatically setup Click Triggers and icons based on the button assigned.
  • When multiple events are assigned to a button key, the player will enter a spotlight mode to help determine which event the player wishes to interact with relative to the key press.
  • Use custom settings or images for the spotlight mode.

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


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.

---

Event-Related Notetags and Comment Tags

Riviera Preview1.gif

---

<Trigger Button: button>
<Trigger Buttons: button, button, button>

- Used for: Event Notetags and Comment Tags
- Allows the event to remotely trigger upon the player pressing a specific
  keyboard button.
  - The event's Trigger condition must be either "Action Button",
    "Player Touch", or "Event Touch".
  - This does not work with "Autorun" or "Parallel".
- Insert the tag inside the Notebox to make the Button Trigger apply to ALL
  of the event's pages.
- Insert the tag inside of a Comment to make the Button Trigger apply ONLY
  to the specific event pages that have those comments on them.
- Replace 'button' with any of the following buttons (remove quotes):
  - "Down", "Left", "Right", "Up"
  - "OK", "Cancel", "PageUp", "PageDown",
  - "Control", "Shift", "Tab"
  - Typing in a button wrong (such as adding a space to "Page Up") will
    yield no results.
  - The "Cancel" button trigger will prevent the Main Menu from being called
    when pressed with the Keyboard, but it will NOT prevent the Main Menu
    from being called with mouse buttons or touch controls.
- Insert multiple buttons separated by commas to allow for multiple keyboard
  buttons to trigger them.

Examples:

<Trigger Button: OK>
<Trigger Button: Left, Down>
<Trigger Button: Up, Right>
<Trigger Button: PageUp, PageDown>

---

<No Auto Trigger Icon>

- Used for: Event Notetags and Comment Tags
- Prevents icons from being automatically assigned to the event if it is
  assigned a Trigger Button.

---

<No Auto Click Trigger>

- Used for: Event Notetags and Comment Tags
- Prevents click trigger from being automatically assigned to the event if
  it is assigned a Trigger Button.

---

Map-Related Notetags

Riviera Preview2.gif

---

<Seal Input Move>

- Used for: Map Notetags
- Prevents the player from being able to use directional inputs and touch
  navigation on this specific map.
- If this notetag is not used, the setting will default to whatever is set
  up in the Plugin Parameters > Auto QOL Settings > Auto <Seal Input Move>
  setting.

---

<No Seal Input Move>

- Used for: Map Notetags
- Allows the player to be able to use directional inputs and utilize touch
  navigation on this specific map.
- If this notetag is not used, the setting will default to whatever is set
  up in the Plugin Parameters > Auto QOL Settings > Auto <Seal Input Move>
  setting.

---

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

Riviera Preview1.gif

---

System: Enable Button Trigger Events
- Enable/disable Button Trigger Events from activating.

  Enable/Disable?:
  - Enables Button Trigger Events and allows them to activate.

---

Plugin Parameters

Automatic Quality of Life Settings

Riviera Preview1.gif

Riviera Param1.png

These Plugin Parameters allow you to quickly adjust and streamline your game to utilize the Button Trigger Events in a more efficient manner.

---

General

  Auto <Seal Input Move>:
  - Seal off input movement by default for every map?
  - Player will be unable to with the keyboard or with the mouse if enabled.

  Auto <Click Trigger>:
  - Add <Click Trigger> for events with Trigger Buttons?
  - Player can click the events and automatically trigger them.

---

Auto <Icon: x>

  Direction:

    Down:
    Left:
    Right:
    Up:
    - Which icon do you wish to use for this button?
    - Use 0 for no changes.
    - If a Trigger Button is discovered using this key(s), this icon will
      be automatically assigned to the event.

  Actions:

    OK / Confirm:
    Menu / Cancel:
    Page Up:
    Page Down:
    - Which icon do you wish to use for this button?
    - Use 0 for no changes.
    - If a Trigger Button is discovered using this key(s), this icon will
      be automatically assigned to the event.

  Other:

    CTRL:
    Shift:
    Tab:
    - Which icon do you wish to use for this button?
    - Use 0 for no changes.
    - If a Trigger Button is discovered using this key(s), this icon will
      be automatically assigned to the event.

---

Spotlight Settings

Riviera Preview2.gif

Riviera Param2.png

If multiple events are assigned the same Trigger Button, then Spotlight Mode will occur. The player character and all other events will freeze in place, while the player selects which event to trigger.

Spotlight Mode will only enlist the events that are on the player's screen and will filter out the ones that aren't close. If there aren't any near the player's screen, then the one with the lowest event ID will automatically trigger. Otherwise, the player will select from the events visible on the screen close to the player.

You can assign a custom graphic for the spotlight. However, if no custom graphic is used, an auto-generated one will be used instead. The generated spotlight is a simplistic darkened screen with a light in the middle.

---

Custom Graphic

  Filename:
  - Insert a filename here to use a custom graphic.
  - Leave empty to not use. Located in img/system/

  Anchor X:
  - Custom anchor X value for the custom spotlight.
  - 0.0 - left; 0.5 - center; 1.0 - right
  - This does NOT apply to the auto-generated spotlight.

  Anchor Y:
  - Custom anchor Y value for the custom spotlight.
  - 0.0 - top; 0.5 - middle; 1.0 - bottom
  - This does NOT apply to the auto-generated spotlight.

  Blend Mode:
  - What kind of blend mode do you wish to apply to the custom spotlight?
  - This does NOT apply to the auto-generated spotlight.

---

Generated Image

  Radius:
  - If no custom graphic is used, generate a spotlight bitmap.
  - This determines the radius.

---

Fade Effect

  Target Opacity:
  - What is the target opacity when the spotlight is visible?
  - 1 - More Transparent
  - 255 - Max Opaque

  Fade Speed:
  - What speed does the opacity fade in and out at?

---


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.01: February 3, 2022

  • Documentation Update!
    • Added text for "Plugin Parameters: Spotlight Settings"
      • Spotlight Mode will only enlist the events that are on the player's screen and will filter out the ones that aren't close. If there aren't any near the player's screen, then the one with the lowest event ID will automatically trigger. Otherwise, the player will select from the events visible on the screen close to the player.
  • Feature Update!
    • Updated the handling of event triggers for multiple events that may not appear on the player's screen. Update made by Arisu.
  • Optimization Update!
    • Plugin should run more optimized.


Version 1.00 Official Release Date: February 9, 2022

  • Finished Plugin!

End of File