Actor Variables (YEP)

From Yanfly.moe Wiki
Jump to navigation Jump to search


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_StatusMenuCore.js.
Place this plugin under YEP_StatusMenuCore.js in the Plugin Manager.

This plugin lets you place variables into the Status Menu Core in a unique
page for display as actor data. These variables can come from a global or
individual source per actor. Variables listed in the Global Columns found in
the parameters will be listed for all actors. Variables defined in the actor
noteboxes will be listed for that actor when displayed.

If you wish to place the Actor Variables tab in the Status Menu in a
specific spot, place 'Variables' without the quotes in the Status Menu
Core's Command Order parameter. If it's not present there, it will
automatically order itself in the 'Custom' tab.

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.

Use the following notetags to display variables in your Status Menu.

Actor Notetags:
  <Column x Variables: y>
  <Column x Variables: y, y, y>
  <Column x Variables: y to z>
  This will display in column x (1 through 4) the variable(s) y. If using
  the y to z notetag, this will display all the variables from y to z.

Variable Icons and Display

To display icons and change the display of your variables, write the name
of your variables like text codes in the variable editor.

A variable name like this \i[42]Variable Name will show up with an icon.

However, if you wish to make notes that do not appear, you can place the
notes between << and >>. For example:

Hello <<You can't see me>>World!

will show up as 'Hello World!' because of the << and >> markers.

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:

These are plugin commands to allow you to hide/show specific variables
throughout your game.

Plugin Command:

HideActorVariable 1
Hides variable 1 from being shown in the actor status menu.

ShowActorVariable 2
Disables any hidden properties for variable 2 in the actor status menu.

Changelog

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

Version 1.04:
- Plugin fixed to be standalone if you wish to use the x to y notetags.

Version 1.03:
- Fixed a bug that prevented custom positioning with the Status Menu Core's
command order parameter.

Version 1.02:
- Updated for RPG Maker MV version 1.1.0.

Version 1.01a:
- Added 'Hidden Variables' plugin parameter.
- Added 'HideActorVariable' and 'ShowActorVariable' plugin command.

Version 1.00:
- Finished Plugin!