Turn Order Display (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

Required Plugins

The following plugins are required in order to use this plugin.

Place the following plugins above this plugin located in the Plugin Manager.

Yanfly Engine Plugins

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


Introduction

This plugin requires YEP_BattleEngineCore. Make sure this plugin is located
under YEP_BattleEngineCore in the plugin list.

For Turn-Based Battle Systems like DTB (Default Turn Battle), letting the
player see the turn order visually can add a whole lot more depth to the
battle system. This plugin will add a display of icons showing the turn
order of the player's party and the enemy party within a corner of the
screen (modifiable).

NOTE! This plugin does NOT work with tick-based Battle Systems like ATB or
CTB! It is specifically made to work only with turn-based battle systems.

Notetags

NotetagsMV.png

RPG Maker MV'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.

Insert the following notetags to give your actors and enemies unique turn
order icons.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Actor and Enemy Notetags:

  <Turn Order Icon: x>
  - This sets the icon used for the actor/enemy to be x.

  <Turn Order Border Color: x>
  - This sets the border color used for the actor/enemy to text color x.

  <Turn Order Background Color: x>
  - This sets the background color used for the actor/enemy to text color x.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Actor Only Notetags:

  <Class x Turn Order Icon: y>
  - This sets it so that if the actor is a specific class, the actor will
  get a specific icon used for the Turn Order Display. If the actor is class
  x, it will receive icon y.

  <Hero Turn Order Icon: x>
  <Warrior Turn Order Icon: x>
  <Mage Turn Order Icon: x>
  <Priest Turn Order Icon: x>
  - If you prefer to use names instead of class ID's, you can use the above
  notetag format. If the actor is the named class, it will receive icon x.
  If you have multiple classes with the same name, priority will be given to
  the class with the highest ID.

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:

Use the following plugin commands to control the Turn Order Display.

Plugin Command:

  EnableTurnOrderDisplay
  - Turns on the Turn Order Display to be shown in battle if the battle is
  a turn-based battle system can support the Turn Order Display.

  DisableTurnOrderDisplay
  - Turns off the Turn Order Display to be hidden in battle.

Changelog

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

Version 1.02:
- Fixed a bug that caused enemies to endlessly have turns if dynamic actions
were enabled.

Version 1.01:
- Fixed some bugs that caused crashes when returning to the battle scene.
- Fixed a bug that altered the order flow during a Surprise Attack or a
Preemptive Attack for battle advantage.
- Made turn order display not cover up certain windows.

Version 1.00:
- Finished Plugin!