Gab Window VisuStella MZ

From Yanfly.moe Wiki
Revision as of 14:05, 4 September 2020 by Irina (talk | contribs) (Plugin Commands)
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.



VisuMZ Polish.png VisuMZ Polish.png
VisuMZ Polish.png VisuMZ Polish.png


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

Sometimes there's random jibber jabber that does not warrant a message box. The Gab Window fulfills that jibber jabber by placing such text outside of the message window box and at the corner of the screen. The gab text will appear briefly and then disappear, not showing up again until the gab text is updated with something else.

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

  • Create gab text that does not interrupt gameplay.
  • Gabs can be queued together to create a streamlined conversation.
  • Gabs can play sound effects when played, allowing you to attach voices to them if desired.
  • Multiple lines can be used per gab to display more text.
  • Attach faces, map sprites, sideview sprites, and even pictures to gabs.
  • Gabs can be automatically positioned above specific events, actors, and even enemies.
  • Turn on switches after a gab is completed.
  • Run custom JavaScript code upon displaying or finish a gab.

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.


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.

Gab Plugin Commands

---

GabWindowScreen3.png

GabWindowCommand01.png

Gab: Text Only
- Show a Gab Window with the specified settings.

  Text:
  - The text to be shown in the Gab Window.

  Force Gab?:
  - Forced gabs will clear other gabs and display immediately.

  Optional Settings:
  - Change the settings you want to override with this gab.
    Blank settings will use default Plugin Parameter settings.

---

GabWindowScreen2.png

GabWindowCommand02.png

Gab: Gab: Text + Face (Any)
- Show a Gab Window with the specified settings.
- Any face graphic can be displayed next to text.

  Text:
  - The text to be shown in the Gab Window.

  Filename:
  - The filename of the face graphic to use.

  Index:
  - This is the index of the face graphic.
  - Index values start at 0.

  Force Gab?:
  - Forced gabs will clear other gabs and display immediately.

  Optional Settings:
  - Change the settings you want to override with this gab.
    Blank settings will use default Plugin Parameter settings.

---

GabWindowCommand03.png

Gab: Text + Face (Actor)
- Show a Gab Window with the specified settings.
- Pick an actor's face graphic to show with it.

  Text:
  - The text to be shown in the Gab Window.

  Actor ID:
  - This is the ID of the actor you want the face graphic of.

  Force Gab?:
  - Forced gabs will clear other gabs and display immediately.

  Optional Settings:
  - Change the settings you want to override with this gab.
    Blank settings will use default Plugin Parameter settings.

---

GabWindowCommand04.png

Gab: Text + Face (Party)
- Show a Gab Window with the specified settings.
- Pick a party member's face graphic to show with it.

  Text:
  - The text to be shown in the Gab Window.

  Party Member Index:
  - This is the index of the party member you want the face graphic of.
  - Index values start at 0.

  Force Gab?:
  - Forced gabs will clear other gabs and display immediately.

  Optional Settings:
  - Change the settings you want to override with this gab.
    Blank settings will use default Plugin Parameter settings.

---

GabWindowScreen5.gif

GabWindowCommand05.png

Gab: Text + Map Sprite (Any)
- Show a Gab Window with the specified settings.
- Any map sprite can be displayed next to text.

  Text:
  - The text to be shown in the Gab Window.

  Filename:
  - The filename of the sprite graphic to use.

  Index:
  - This is the index of the sprite graphic.
  - Index values start at 0.

  Force Gab?:
  - Forced gabs will clear other gabs and display immediately.

  Optional Settings:
  - Change the settings you want to override with this gab.
    Blank settings will use default Plugin Parameter settings.

---

GabWindowCommand06.png

Gab: Text + Map Sprite (Actor)
- Show a Gab Window with the specified settings.
- Pick an actor's sprite graphic to show with it.

  Text:
  - The text to be shown in the Gab Window.

  Actor ID:
  - This is the ID of the actor you want the map sprite of.

  Force Gab?:
  - Forced gabs will clear other gabs and display immediately.

  Optional Settings:
  - Change the settings you want to override with this gab.
    Blank settings will use default Plugin Parameter settings.

---

GabWindowCommand07.png

Gab: Text + Map Sprite (Party)
- Show a Gab Window with the specified settings.
- Pick a party member's sprite graphic to show with it.

  Text:
  - The text to be shown in the Gab Window.

  Party Member Index:
  - This is the index of the party member you want the map sprite of.
  - Index values start at 0.

  Force Gab?:
  - Forced gabs will clear other gabs and display immediately.

  Optional Settings:
  - Change the settings you want to override with this gab.
    Blank settings will use default Plugin Parameter settings.

---

GabWindowScreen1.png

GabWindowCommand08.png

Gab: Text + Sideview Actor (Any)
- Show a Gab Window with the specified settings.
- Any Sideview Actor can be displayed next to text.

  Text:
  - The text to be shown in the Gab Window.

  Filename:
  - The filename of the Sideview Actor graphic to use.

  Force Gab?:
  - Forced gabs will clear other gabs and display immediately.

  Optional Settings:
  - Change the settings you want to override with this gab.
    Blank settings will use default Plugin Parameter settings.

---

GabWindowCommand09.png

Gab: Text + Sideview Actor (Actor)
- Show a Gab Window with the specified settings.
- Pick an actor's sideview graphic to show with it.

  Text:
  - The text to be shown in the Gab Window.

  Actor ID:
  - This is the ID of the actor you want the sideview graphic of.

  Force Gab?:
  - Forced gabs will clear other gabs and display immediately.

  Optional Settings:
  - Change the settings you want to override with this gab.
    Blank settings will use default Plugin Parameter settings.

---

GabWindowCommand10.png

Gab: Text + Sideview Actor (Party)
- Show a Gab Window with the specified settings.
- Pick a party member's sideview graphic to show with it.

  Text:
  - The text to be shown in the Gab Window.

  Party Member Index:
  - This is the index of the party member you want the sideview graphic of.
  - Index values start at 0.

  Force Gab?:
  - Forced gabs will clear other gabs and display immediately.

  Optional Settings:
  - Change the settings you want to override with this gab.
    Blank settings will use default Plugin Parameter settings.

---

GabWindowScreen6.png

GabWindowCommand11.png

Gab: Text + Picture
- Show a Gab Window with the specified settings.
- Any picture graphic can be displayed next to text.

  Text:
  - The text to be shown in the Gab Window.

  Filename:
  - The filename of the face graphic to use.

  Stretch Picture:
  - Stretch the picture to fit the window?

  Force Gab?:
  - Forced gabs will clear other gabs and display immediately.

  Optional Settings:
  - Change the settings you want to override with this gab.
    Blank settings will use default Plugin Parameter settings.

---

Optional Settings

GabWindowScreen4.png

GabWindowCommandOptional.png

These settings appear in the above Gab Plugin Commands. Opening up the Optional Settings will yield the following:

---

DimColor

  Dim Color 1:
  Dim Color 2:
  - The dim colors to use for this Gab Window.
  - Format: rgba(red, green, blue, alpha)

---

Fade

  Fade Rate:
  - How fast this Gab Window fades away.

  Fade Direction:
  - The direction this Gab Window fades out in.

---

Font

  Font Name:
  - The font name to use for this Gab Window.

  Font Size:
  - The font size to use for this Gab Window.

---

Position

  Y Location:
  - The Y coordinate this Gab Window will appear in.
  - Ignore if you are using a locked sprite position.

  Actor ID:
  - The ID of the actor to display this Gab Window above.
  - For Map/Battle.

  Party Index:
  - Index of the party member to display Gab Window above.
  - For Map/Battle. Index values start at 0. Ignore under 0.

  Enemy Index:
  - Index of an enemy battler to display Gab Window above.
  - Battle only. Index values start at 0. Ignore under 0.

  Event ID:
  - The ID of the event to display this Gab Window above.
  - Map only.

---

On Display

  Bypass Anti-Repeat:
  - Allows this gab to bypass the Anti-Repeat settings.

  Sound Filename:
  - The filename of the SE to play when the Gab Window shows.

  JS: On Display:
  - Runs this code once this Gab Window shows up.

---

On Finish

  Gab Switch:
  - The specified switch will be turned ON when the Gab Window finishes.

  JS: On Finish:
  - Runs this code once this Gab Window finishes.

---

Waiting

  Wait Time:
  - The number of frames this Gab Window stays visible.

  Time Per Character:
  - Frames added per Text Character in this Gab Window.

---

System Plugin Commands

---

GabWindowCommand12.png

System: Clear Gabs
- Clears out the current Gab and any which are queued.

---

GabWindowCommand13.png

System: Wait For Gab Completion
- Causes the game to wait until all gabs are finished playing.

---

Plugin Parameters

General Settings

General settings regarding the Gab Window.

---

General

 Anti-Repeat:
 - Stops gabs of the same settings from being queued.
 Center Graphics:
 - Centers graphics vertically if there are multiple lines.

---

Fade

 Fade Rate:
 - How fast the gab window fades away.
 Fade Direction:
 - The direction to move the window in when fading out.

---

Font

 Gab Font Name:
 - The font name used for the text of the Gab Window
 - Leave empty to use the default game's font.
 Gab Font Size:
 - The font size used for the text of the Gab Window.
 - Default: 28

---

Sprites > Character Sprites

 X Position:
 - X position of the character.
 Y Position:
 - Y position of the character.

---

Sprites > Sideview Sprites

 X Position:
 - X position of the Sideview Actor.
 Y Position:
 - Y position of the Sideview Actor.

---

Waiting

 Base Wait Time:
 - Minimum frames the Gab Window stays visible.
 - Default: 90
 Time Per Character:
 - Frames added per Text Character.
 - Default: 4

---

JavaScript

 JS: On Display:
 - Runs this code once this Gab Window shows up.
 - This applies to every single gab.
 JS: On Finish:
 - Runs this code once this Gab Window finishes.
 - This applies to every single gab.

---

Map Settings

Settings related to the gab window while in the map scene.

---

Map

 Y Location:
 - This is the Y location of the Gab Window.
 Dim Color 1:
 Dim Color 2:
 - These are the dim colors used for maps.
 - Format: rgba(red, green, blue, alpha)

---

Battle Settings

Settings related to the gab window while in the battle scene.

---

Battle

 Y Location:
 - This is the Y location of the Gab Window.
 Dim Color 1:
 Dim Color 2:
 - These are the dim colors used for battles.
 - Format: rgba(red, green, blue, alpha)

---


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 11, 2020

  • Finished Plugin!

End of File