Gab Window (YEP)

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

For help on how to install plugins, click here.

For help on how to update plugins, click here.

Got errors with your RPG Maker MV plugin? Click here.

Yanfly Engine Plugins

This plugin is a part of the Yanfly Engine Plugins library.


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.

New to the MV version is the ability to play sounds for your Gab Window in
addition to queueing multiple gabs together to have them form a conversation
of sorts. When queued up, the currently playing gab will continue showing
until it fades out before loading up the next gab.

Plugin Commands

PluginCommandsMV.png

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

Here is a list of Plugin Command(s) that you may use:

Using the Gab Window is quite simple. By default, it can be used in either
the map scene or the battle scene. To call upon it, you will to use a few
Plugin Commands to set up what you wish for the Gab Window to display.

Plugin Commands:

--- Setup Commands ---

GabText text
This will set the gab window to type out the above text. Text codes can be
used for the Gab Window.

GabFaceName filename
If you wish to display a face graphic, use this plugin command to have it
display a face from the filename.

GabFaceIndex x
Used in combination with the above plugin command to define which index the
face will use.

GabSpriteName filename
If you wish to display a particular character sprite, use this plugin
command to have it display a sprite from the filename.

GabSpriteIndex x
Used in combination with the above plugin command to define which index the
sprite will use.

GabActor x
GabActorFace x
This will display actor x's face graphic where x is the actor's ID.

GabActorSprite x
This will display actor x's sprite graphic where x is the actor's ID.

GabParty x
GabPartyFace x
This will display party member x's face graphic where x is the position.

GabPartySprite x
This will display party member x's sprite graphic where x is the position.

GabSound filename
This will play a sound from the SE folder under that particular filename.

GabSwitch x
This will enable switch x when this gab finishes playing.

WaitForGab
Causes the game to wait until all gabs are finished playing.

--- Display Commands ---

ShowGab
Once the above settings are complete, use this Plugin Command to launch the
Gab Window and display the above data. This will put the gab data into a
queue which means if there's another gab playing, this will be next in line.

*Note If multiple ShowGabs are used, they will be queued up. The current
playing gab will finish playing before moving onto the next. If it so
happens that the inputted Gab would have the same exact settings as a
previously loaded gab within the same queue, it will not be inserted to
prevent any redundancy amongst the conversation.

ForceGab
Once the above settings are complete, use this Plugin Command to clear all
the other gabs in the Gab Window and display the above data.

ClearGab
This clears out the Gab Window of the current gab and any gabs queued.

Changelog

Version 1.06:
- Updated for RPG Maker MV version 1.5.0.

Version 1.05:
- Added 'WaitForGab' plugin command. This plugin command causes the game to
wait until all gabs are finished playing.

Version 1.04:
- Fixed an issue with ForceGab that didn't make it work properly with text
coded Gabs.

Version 1.03a:
- Fixed a bug with GabSound that didn't load the proper sound filenames.
- Fixed the time count for Gabs to not include text codes.

Version 1.02a:
- Added functionality for battle gabs to be saved when going into other
scenes and returning to battle.
- Added GabSwitch x to enable switch x when the gab finishes playing.

Version 1.01:
- Added 'GabParty x' and 'GabPartySprite x' plugin commands to help with
those without dynamic party setups.

Version 1.00:
- Finished Plugin!