Equip Battle Skills (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

Extension Plugins

The following plugins are Extension Plugins that require this plugin as its Parent Plugin.

Place the following plugins below this plugin located in the Plugin Manager if you plan on using them.

Yanfly Engine Plugins

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

Click here if you want to help support Team Yanfly on Patreon.

Introduction

This plugin creates a new gameplay mechanic where players have to choose
which skills to bring into battle. They can select what skills to bring from
the skill menu. In addition to being able to do that, equipped skills can
also add bonuses such as stats and/or passive states.

Note: During Battle Test, equip skill slots will be disabled for the sake of
better battle testing control.

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.

The following notetags adjust various aspects about equippable battle skills.

Actor Notetag:
  <Starting Skill Slots: x>
  This sets the actor's starting skill slots to x amount. This value will
  not allow the actor to bypass the Maximum Skills limit.

Skill Notetags:
  <Equip stat: +x>
  <Equip stat: -x>
  Replace 'stat' with 'HP', 'MP', 'ATK', 'DEF', 'MAT', 'MDF', 'AGI', or
  'LUK' to have that stat increase or decrease by x amount while the skill
  is equipped for battle.

  <Equip State: x>
  <Equip State: x, x, x>
  <Equip State: x through x>
  This causes the actor to be affected by state x while the skill is
  equipped for battle.

  <Unequippable>
  This skill cannot be equipped no matter what.

  <All Access Equippable>
  This makes the skill equippable whether the actor has the available skill
  type needed for the skill or not.

  <Access Only Equippable>
  This makes the skill equippable only for actors with the specific skill
  type. Actors without access to the skill type cannot equip it.

Class, Skill, Weapon, Armor, and State Notetags:
  <Equip Skill Slots: +x>
  <Equip Skill Slots: -x>
  This increases or decreases the amount of skills the actor can equip for
  battle by x. This value will not allow the actor to bypass the Maximum
  Skills Limit.

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:

You can use the following plugin commands to increase or decrease the amount
of battle slots for specific actors.

Plugin Command:

  IncreaseActorBattleSlots 3 by 4
  - This will increase actor 3's number of battle skill slots by 4. The
  total amount of battle skill slots cannot go beyond the 'Maximum Skills'
  plugin parameter.

  DecreaseActorBattleSlots 5 by 2
  - This will decrease actor 5's number of battle skill slots by 2. The
  total amount of battle skill slots cannot go beneath 1.

Here are some plugin commands you can use for your game!

Plugin Command:

  EnableEquipBattleSkills
  - This will enable the 'Equip Skills' command in the skill menu.

  DisableEquipBattleSkills
  - This will disable the 'Equip Skills' command in the skill menu.

  ShowEquipBattleSkills
  - This will show the 'Equip Skills' command in the skill menu.

  HideEquipBattleSkills
  - This will hide the 'Equip Skills' command in the skill menu.

Script Calls

ScriptCallsMV.png

Script Calls are event commands that are used to run JavaScript code during an event to call upon unique functions, usually added by the related plugin.

Here is a list of Script Call(s) that you may use:

For those with JavaScript experience, you can use the following newly added
functions from this plugin within script calls or Lunatic Mode notetags.

JavaScript Function:

  actor.clearBattleSkillMaxPlus()
  - This clears any bonus skill equip slots available for the actor.

  actor.getBattleSkillMaxPlus()
  - This returns the amount of bonus equip slots available for the actor.

  actor.setBattleSkillMaxPlus(x)
  - This sets the amount of available bonus equip slots for the actor to x.
  This value can go negative, but it cannot force the actor to have less
  than 1 available equip slot. This can go positive but it cannot force the
  actor to have more than the 'Maximum Skills' plugin parameter value.

  actor.increaseBattleSkillSlots(x)
  - This will raise the maximum amount of equip skill slots for the actor to
  x but cannot go beyond the 'Maximum Skills' plugin parameter value.

  actor.decreaseBattleSkillSlots(x)
  - This will lower the maximum amount of equip skill slots for the actor to
  x but cannot go under a minimum of 1 battle equip slot.

  actor.maxBattleSkills()
  - This returns the amount of battle skills the actor can equip currently.

  actor.battleSkills()
  - This returns an array of the skills in their object form that the actor
  has equipped currently.

  actor.battleSkillsRaw()
  - This returns an array of the skills in their ID form that the actor has
  equipped currently.

  actor.equipSkill(id, slot)
  - This will cause the actor to equip skill ID into the specific slot.
  This will bypass whether or not the actor can equip the skill or not.

Tips & Tricks

The following Tips & Tricks effects use this plugin:

Changelog

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

Version 1.12:
- Fixed a bug that made the help window not update after changing a skill.

Version 1.11:
- Fixed a bug caused by Plugin Command 'DecreaseActorBattleSlots 5 by 2'
that would increase instead of decrease.

Version 1.10:
- Added a new check to remove equipped battle skills from skills that were
manually forgotten, unequipping items, or removing states.

Version 1.09:
- Fixed a bug that caused equipped skills to not list their applied states.

Version 1.08:
- Optimization update.

Version 1.07:
- Updated for RPG Maker MV version 1.3.2.

Version 1.06b:
- Users with Skill Core and using the <Hide in Battle> notetag will now have
those skills hidden while in the battle if equipped.
- Fixed a crash that occurs when no skills are equipped.
- Optimization update for future plugins.

Version 1.05a:
- Compatibility update with Skill Core's <Hide if Learned Skill: x> notetag.
- Updated to remove skills that are already equipped and to become hidden if
learning a new skill through the <Hide if Learned Skill: x> notetag.

Version 1.04:
- Fixed an error stacking state.
- Fixed drawing errors when actors have 0 MaxMP.

Version 1.03:
- Added four new plugin commands to enable, disable, show, and hide the
'Equip Skills' command from the skill menu.

Version 1.02:
- Fixed a bug that caused certain passive states to not appear correctly.

Version 1.01:
- Fixed a bug that prevented increasing or decreasing battle skill slots
from working properly.

Version 1.00:
- Finished Plugin!