TPがどのように処理されるのかをより詳細に制御するプラグイン – YEP_EnhancedTP.js

============================================================================
Introduction
============================================================================

The TP system in RPG Maker MV is rather limiting. A lot of the TP system is
hardcoded in giving RPG Maker MV users very little control over how much TP
gain a battler can receive from particular actions and situations. This
plugin gives you the ability to adjust how much TP battlers will acquire
various actions, different TP modes, and letting players selecting and pick
what TP mode they want for each actor.

============================================================================
Instructions - TP Mode Parameters
============================================================================

TP Modes are given to your actors for them to decide how they want to gain
TP over the course of battle. You can decide the rulings for each TP Mode.

Here is an overview of what each TP Mode Parameter does:

Name
- This is the name of the TP Mode. This is what appears in the TP Mode
selection menu in the Skill Menu (if you have it enabled).

Icon
- This is the icon used for the TP Mode in the TP Mode selection menu in
the Skill Menu (if you have it enabled).

Help Line 1
Help Line 2
- This is the help description used for the TP Mode in the TP Mode
selection menu in the Skill Menu (if you have it enabled).

Preserve
- If set to true, then the user carries any earned TP from on battle to
the next battle. If set to false, the at the start and each of each battle
the user's TP value is cleared.

Initial TP
- This is the formula to determine how much TP is gained at the start of
battle. Previously, this was reserved for non-preserved TP values. Now, it
can be used regardless.

Regen TP
- This is how much TP is regenerated during the regeneration phase for the
user. Typically, the regeneration phase occurs at the end of each turn.

Take HP DMG
- This is how much TP is generated from the user taking HP damage. The
amount of damage taken can be retrieved from the 'value' variable.

Deal HP DMG
- This is how much TP is generated from the user dealing HP damage. The
amount of damage taken can be retrieved from the 'value' variable.

Heal HP DMG
- This is how much TP is generated from the user healing HP damage. The
amount of damage taken can be retrieved from the 'value' variable.

Ally HP DMG
- This is how much TP is generated from an ally taking HP damage. The
amount of damage taken can be retrieved from the 'value' variable.

Take MP DMG
- This is how much TP is generated from the user taking MP damage. The
amount of damage taken can be retrieved from the 'value' variable.

Deal MP DMG
- This is how much TP is generated from the user dealing MP damage. The
amount of damage taken can be retrieved from the 'value' variable.

Heal MP DMG
- This is how much TP is generated from the user healing MP damage. The
amount of damage taken can be retrieved from the 'value' variable.

Ally MP DMG
- This is how much TP is generated from an ally taking MP damage. The
amount of damage taken can be retrieved from the 'value' variable.

Deal State
- This is how much TP is generated from the user issuing a state on a foe.
If the user and target are on the same team, ignore this.

Gain State
- This is how much TP is generated from the user gaining a state from a
foe. If the user and origin are on the same team, ignore this.

Kill Ally
- This is how much TP is generated if an allied member dies. It does not
matter who the killer is.

Kill Enemy
- This is how much TP is generated if an enemy member dies. It does not
matter who the killer is.

Win Battle
- This is how much TP is generated from the player winning a battle.

Flee Battle
- This is how much TP is generated from the player escaping a battle.

Lose Battle
- This is how much TP is generated from the player losing a battle.

Crisis HP
- This is how much TP is generated during the Regen TP timing if the user
is in a critical HP state.

Crisis MP
- This is how much TP is generated during the Regen TP timing if the user
is in a critical MP state.

Only Member
- This is how much TP is generated during the Regen TP timing if the user
is the only alive member left.

Evasion
- This is how much TP is generated whenever the user manages to evade an
action performed by another battler.

============================================================================
Notetags
============================================================================

You can use the following notetags to adjust the various settings for TP.

Actor and Enemy Notetags:

<TP Mode: x>
This will set the actor's default TP mode to x. If this notetag isn't used
then the actor will default to the mode within the plugin's parameters.

<Unlock TP Mode: x>
<Unlock TP Mode: x, x, x>
<Unlock TP Mode: x to y>
This unlocks what TP modes the actor can use by default. This tag will add
upon the default unlocks already preset in the plugin's parameters.

Skill and Item Notetags:

<Unlock TP Mode: x>
<Unlock TP Mode: x, x, x>
<Unlock TP Mode: x to y>
This will cause the target to unlock TP mode x (to y). This will make the
TP mode available in the TP menu.

Skill Notetags:

<Learn Unlock TP Mode: x>
<Learn Unlock TP Mode: x, x, x>
<Learn Unlock TP Mode: x to y>
When this skill is learned, unlock TP mode x (to y) in the process of also
learning it. This will make the TP mode available in the TP menu.

============================================================================
Plugin Commands
============================================================================

You can use the following Plugin Commands to alter Enhanced TP.

Plugin Command:

ShowTpMode
HideTpMode
This will show/hide the TP Mode from the Skill Menu.

EnableTpMode
DisableTpMode
This will enable/disable the TP Mode in the Skill Menu.

ChangeTpMode Actor 1 to 5
This will change the TP mode of Actor 1 to TP Mode 5.

ChangeTpMode Party 2 to 6
This will change the TP mode of Party Member 2 to TP Mode 6.

UnlockTpMode Actor 3 Mode 7
This will make Actor 3 unlock TP Mode 7.

UnlockTpMode Party 4 Mode 8
This will make Party Member 4 unlock TP Mode 8.

RemoveTpMode Actor 1 Mode 9
This will make Actor 1 remove TP Mode 9.

RemoveTpMode Party 2 Mode 10
This will make Party Member 2 remove TP Mode 10.

UnlockAllTpModes Actor 1
This will make Actor 1 unlock all TP modes.

UnlockAllTpModes Party 2
This will make Party member 2 unlock all TP modes.

RemoveAllTpModes Actor 1
This will make Actor 1 remove all TP modes.

RemoveAllTpModes Party 2
This will make Party member 2 remove all TP modes.

============================================================================
Lunatic Mode - New JavaScript Functions
============================================================================

For those experienced with JavaScript, you can use these new functions to
call upon and change various aspects related to TP Modes.

battler.tpMode()
This will return the current TP mode the battler is using.

battler.tpModeId()
This will return the current TP mode's ID the battler is using.

battler.setTpMode(x)
This will set the battler's TP mode to x.

battler.unlockTpMode(x)
This will unlock TP Mode x for the battler.

battler.removeTpMode(x)
This will remove TP Mode x for the battler unless the battler is currently
using TP Mode x.

battler.unlockAllTpModes()
This will unlock all TP Modes for the battler.

battler.removeAllTpModes()
This will remove all TP Modes for the battler except for the TP Mode that
the battler is currently using.

============================================================================
Changelog
============================================================================

Version 1.03:
- Fixed the plugin commands that pertain to party members to prevent them
from crashing the game.

Version 1.02a:
- Updated for RPG Maker MV version 1.1.0.
- Fixed a documentation issue. <TP Mode: x> can work with enemies.

Version 1.01a:
- Fixed a bug with some notetags not working properly.
- Fixed a bug with 'EnableTpMode' plugin command not working properly.

Version 1.00:
- Finished Plugin!