Event Mini Label (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.



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.

Download

Yanfly Engine Plugins

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


Introduction

This plugin lets you place text above the heads of various events using a
miniature label through a comment tag.

Comment Tags

CommentTags.png

Comment Tags are similar to Notetags. RPG Maker MV's editor is unable to allow for custom traits/properties that a game dev may wish to associate with an event or common event. Comment Tags are used to work around such limitations by allowing the game dev to tag certain traits/properties using specific Comment Tags declared by the related plugin.

Here is a list of Comment Tag(s) that you may use.

Comment tags are 'notetags' used within the lines of an event's comments.
The reason I'm using the comment tags instead of the notetags is because
each page of an event can yield a different potential name.

To use this, make a comment within the event you wish to make the mini
label for and insert the following:

  <Mini Label: text>
  This will display the 'text' above the event. You can use text codes for
  this comment tag and it will create dynamic messages.

  <Mini Label Font Size: x>
  This will change the font size used for the mini label to x. If this tag
  isn't used, the font size will be the default value in the parameters.

  <Mini Label X Buffer: +x>
  <Mini Label X Buffer: -x>
  This will adjust the X buffer for the mini label by x value. If this tag
  isn't used, the X buffer will be the default value in the parameters.

  <Mini Label Y Buffer: +x>
  <Mini Label Y Buffer: -x>
  This will adjust the Y buffer for the mini label by x value. If this tag
  isn't used, the Y buffer will be the default value in the parameters.

  <Always Show Mini Label>
  This will make the mini label to always be shown, even when the plugin
  command to hide mini labels is used.

  <Mini Label Range: x>
  The player will have to be within x tiles of this event in order for the
  mini label to appear visibly.

  <Mini Label Require Facing>
  This will require the player to be facing the direction of the event in
  order for the mini label to appear.

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:

If you would like to shut off the Event Mini Label mid-game or turn it on,
you can use the following plugin commands:

Plugin Command:

  HideMiniLabel
  Hides all Event Mini Label.

  ShowMiniLabel
  Shows all Event Mini Label.

  RefreshMiniLabel
  Refreshes all Event Mini Labels on the map.

Changelog

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

Version 1.11:
- Added 'Battle Transition' plugin parameter. Enabling this will allow you
to show the Event Mini Labels during the battle transition. Keeping it
disabled will hide them during the transition.

Version 1.10:
- Mini Windows will now readjust their size to show at normal scale if the
map is zoomed in.

Version 1.09:
- Fixed a bug that caused Mini Labels that started off as hidden to remain
hidden even after turning the Mini Labels on.

Version 1.08:
- Added <Mini Label Require Facing> comment tag.
- Moved the priority of the Mini Labels to be later added to the spriteset
so they can stay on top of more effects.

Version 1.07:
- Added more padding space so text doesn't get cut off.

Version 1.06:
- Fixed a bug that caused some mini labels to show if the event was loaded
onto the map without any currently active pages.

Version 1.05:
- Added 'X Buffer' plugin parameter and the <Mini Label X Buffer: +x> and
<Mini Label X Buffer: -x> comment tags to alter the X position of the event
mini label.

Version 1.04:
- Added 'RefreshMiniLabel' plugin command to allow you to manually refresh
all mini labels on the map.

Version 1.03:
- Optimized updating performance to reduce lag on maps with many events.

Version 1.01:
- Fixed a bug that didn't update event labels under certain page conditions.
- Added <Mini Label Range: x> notetag.

Version 1.00:
- Finished Plugin!