Party Limit Gauge (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.

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

Introduction

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

This plugin enables a Party Limit Gauge for both the player party and the
enemy party. These gauges will fill up or decrease depending on what actions
take place. The amounts they raise can be adjusted within the plugin's
parameters to your liking. Once a party has enough of the Party Limit Gauge,
members from that party can use it as a skill resource to unleash powerful
actions in battle!

Instructions

Limit Gain
There are various ways for the Party Limit Gauge to raise. The settings are
adjusted in the plugin parameters but here will be a detailed explanation of
what each parameter does:

  Reset Gauge
  - If set to true, then the Party Limit Gauge will empty out at the start
  of each battle. If set to false, the Party Limit Gauge will carry to each
  battle for the player party. The enemy party will always empty out.

  Battle Start
  - This determines how much of the Party Limit Gauge will be gained when a
  new battle has been started.

  Take HP Damage
  - This is how much the Party Limit Gauge will increase when an ally takes
  HP damage dealt by the opposing team.

  Deal HP Damage
  - This is how much the Party Limit Gauge will increase when an ally deals
  HP damage to the opposing team.

  Heal HP Damage
  - This is how much the Party Limit Gauge will increase whenever an ally
  receives HP healing through actions. Healing done through trait effects
  will not apply here.

  Take MP Damage
  - This is how much the Party Limit Gauge will increase when an ally takes
  MP damage dealt by the opposing team.

  Deal MP Damage
  - This is how much the Party Limit Gauge will increase when an ally deals
  MP damage to the opposing team.

  Heal MP Damage
  - This is how much the Party Limit Gauge will increase whenever an ally
  receives MP healing through actions. Healing done through trait effects
  will not apply here.

  Gain State
  - This is how much the Party Limit Gauge will increase whenever an ally
  receives a non-death state from the opposing team.

  Deal State
  - This is how much the Party Limit Gauge will increase whenever an ally
  inflicts a non-death state to the opposing team.

  Killed Ally
  - This is how much the Party Limit Gauge will increase whenever an ally
  dies in battle.

  Killed Foe
  - This is how much the Party Limit Gauge will increase whenever a foe
  dies in battle.

  Win Battle
  - This is how much the Party Limit Gauge will increase for the player's
  party when the player wins a battle.

  Flee Battle
  - This is how much the Party Limit Gauge will increase for the player's
  party when the player escapes a battle.

  Lose Battle
  - This is how much the Party Limit Gauge will increase for the player's
  party when the player loses a battle.

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.

You can use these notetags to adjust the Party Limit Gauge aspects.

Skill Notetags:

  <Party Limit Cost: x>
  Adds a Party Limit Gauge cost to this skill. This skill will require x
  increments of the Party Limit Gauge to be able to use it.

  <Party Limit Cost: x%>
  Adds a party Limit Gauge cost to this skill equal to x% of the total max
  gauge size of the battler's party max limit gauge size. The cost is always
  rounded upward.

Skill and Item Notetags:

  <Ally Party Limit Gauge: +x>
  <Ally Party Limit Gauge: -x>
  Using this skill will cause the user's party limit gauge to increase or
  decrease by x. This is the point value cost and not the increment value.

  <Foe Party Limit Gauge: +x>
  <Foe Party Limit Gauge: -x>
  Using this skill will cause the foe's party limit gauge to increase or
  decrease by x. This is the point value cost and not the increment value.

Actor and Enemy Notetag:

  <Party Limit: x>
  Increases the Party Limit Gauge by x when this party member is present in
  battle (dead or alive). If this notetag isn't used, the value will default
  to the settings in the plugin parameters.

Actor, Class, Enemy, Weapon, Armor, and State Notetags:

  <Party Limit: +x>
  <Party Limit: -x>
  Increases or decreases the Party Limit Gauge by x if the related unit has
  is that actor, class, enemy, or has the weapon or armor equipped, or is
  affected by that state.

  <Party Limit Cost: x%>
  Sets the party limit costs paid by this actor to x%. The modifications are
  are multiplicative. The final cost is always rounded upward.

Lunatic Mode

JavaScript.png

For advanced users who have an understanding of JavaScript, you can use the following features added by the plugin to further enhance what you can do with your game project.

For those with JavaScript experience, you can implement conditional costs
for the Party Limit costs of skills, how much is gained or lost for user
and/or target(s).

Skill Notetags:

  <Custom Party Limit Cost>
   cost = user.friendsUnit().members().length;
  </Custom Party Limit Cost>
  The 'cost' variable will reference the original cost of the skill, and can
  be modified to add more or less than original amount. The cost value will
  be the finalized amount for the skill but rounded upward if the cost is a
  decimal value. This is the increment cost.

  <Custom Ally Party Limit Gauge>
   value += user.level;
  </Custom Ally Party Limit Gauge>
  The 'value' variable determines how much of the gauge will be added to the
  user's Party Limit Gauge. This is not an increment value but the raw value
  added to the amount.

  <Custom Foe Party Limit Gauge>
   value -= target.level;
  </Custom Foe Party Limit Gauge>
  The 'value' variable determines how much of the gauge will be added to the
  target's Party Limit Gauge. This is not an increment value but the raw
  value added to the amount.

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:

Those using JavaScript functions can make some use out of some new functions
added with this plugin. Whenever the word "unit" appears, replace it with
either $gameParty or $gameTroop depending on which you want to affect.

unit.partyLimitGauge()
- Returns the raw value of the unit's Party Limit Gauge.

unit.partyLimitGaugeMax()
- Returns the raw maximum cap of the Party Limit Gauge.

unit.setPartyLimitGauge(x)
- Sets the raw value of the Party Limit Gauge to x for that unit.

unit.gainPartyLimitGauge(x)
- Causes the unit to gain x Party Limit Gauge in raw value.

unit.losePartyLimitGauge(x)
- Causes the unit to lose x Party Limit Gauge in raw value.

unit.partyLimitGaugeCurrent()
- Returns the unit's number of usable increments of the Party Limit Gauge.

unit.partyLimitGaugeIncrements()
- Returns the unit's number of max increments of the Party Limit Gauge.

unit.setPartyLimitGaugeIncrement(x)
- Sets the unit's Party Limit Gauge to exactly x increments.

unit.gainPartyLimitGaugeIncrement(x)
- Causes the unit to gain exactly x increments of the Party Limit Gauge.

unit.losePartyLimitGaugeIncrement(x)
- Causes the unit to lose exactly x increments of the Party Limit Gauge.

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 plugin commands inside events to alter the amount of Party Limit
Gauge the player's party or enemy party has.

Plugin Command

  SetPartyLimitGaugeValue x
  SetTroopLimitGaugeValue x
  - Sets the player party's or enemy party's raw Party Limit Gauge
  value to x.

  GainPartyLimitGaugeValue x
  GainTroopLimitGaugeValue x
  - The player party's or enemy party's raw Party Limit Gauge gains
  x value.

  LosePartyLimitGaugeValue x
  LoseTroopLimitGaugeValue x
  - The player party's or enemy party's raw Party Limit Gauge gains
  x value.

  SetPartyLimitGaugeIncrement x
  SetTroopLimitGaugeIncrement x
  - Sets the player party's or enemy party's Party Limit Gauge value
  to x increments.

  GainPartyLimitGaugeIncrement x
  GainTroopLimitGaugeIncrement x
  - The player party's or enemy party's Party Limit Gauge gains
  x increments.

  LosePartyLimitGaugeIncrement x
  LoseTroopLimitGaugeIncrement x
  - The player party's or enemy party's Party Limit Gauge gains
  x increments.

  ShowPartyLimitGauge
  HidePartyLimitGauge
  ShowTroopLimitGauge
  HideTroopLimitGauge
  - Shows or hides the Party/Troop Limit Gauge.

Changelog

Version 1.11:
- Bypass the isDevToolsOpen() error when bad code is inserted into a script
call or custom Lunatic Mode code segment due to updating to MV 1.6.1.

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

Version 1.09:
- Lunatic Mode fail safes added.

Version 1.08:
- Calculations for Party Limit Gauge increasing for HP and MP values are now
calculated based on the actual HP and MP damage taken as per the results
rather than based off of the raw incoming value (in the event that raw value
gets modified as per the effects of other plugins).

Version 1.07:
- Fixed a bug that didn't apply the 'Party Max Bonus' parameter properly.

Version 1.06:
- Fixed a bug that caused some of the Plugin Commands to not work properly.

Version 1.05:
- Fixed a bug that caused the enemy troops to have the same settings as the
player team.

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

Version 1.03:
- Fixed a bug with some damage formulas being unable to use 'user'.

Version 1.02a:
- Fixed a bug that caused certain notetags to crash the game.
- Battle Engine Core's 'Hide Battle HUD' will now hide the Party Limit Gauge
as well.

Version 1.01:
- Added 'ShowPartyLimitGauge', 'HidePartyLimitGauge', 'ShowTroopLimitGauge',
'HideTroopLimitGauge' Plugin Commands to hide/show the Party Limit Gauges
while midgame.

Version 1.00:
- Finished Plugin!