Difference between revisions of "Battle System - ATB VisuStella MZ"

From Yanfly.moe Wiki
Jump to navigation Jump to search
(Changelog)
(18 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
{{MzPlugin
 
{{MzPlugin
|preview = <youtube>link</youtube>
+
|preview = <youtube>https://www.youtube.com/watch?v=hipRs7aqbxA</youtube>
|link1 = <html><iframe frameborder="0" src="https://itch.io/embed/655177" width="552" height="167"><a href="https://visustella.itch.io/visustella-sample-project">Visustella  Sample Project by VisuStella, Caz</a></iframe></iframe></html>
+
|link1 = <html><iframe frameborder="0" src="https://itch.io/embed/760452" width="552" height="167"><a href="https://visustellamz.itch.io/battle-system-atb">Battle System - ATB plugin for RPG Maker MZ by VisuStellaMZ</a></iframe></html>
|link2 = <html><iframe frameborder="0" src="https://itch.io/embed/754729" width="552" height="167"><a href="https://visustellamz.itch.io/wave-3-bundle">[Access Key] Wave 3 Plugins Bundle by VisuStellaMZ</a></iframe></html>
+
|link2 = {{VisuStella Wave 3}}
 +
|link3 = {{VisuStella All Waves Collection}}
  
 
}}
 
}}
Line 8: Line 9:
 
<!-- Preview -->
 
<!-- Preview -->
  
{|
+
[[File:VisuMZ_ATB_Preview1.png|600px]]
| [[File:VisuMZ_Polish.png|400px]]
+
 
| [[File:VisuMZ_Polish.png|400px]]
+
[[File:VisuMZ_ATB_Preview2.png|600px]]
 
   
 
   
|-
+
[[File:VisuMZ_ATB_Preview3.png|600px]]
  
| [[File:VisuMZ_Polish.png|400px]]
+
[[File:VisuMZ_ATB_Preview4.png|600px]]
| [[File:VisuMZ_Polish.png|400px]]
 
 
 
|}
 
  
 
{| style="width: 800px;" cellspacing="0" cellpadding="0"
 
{| style="width: 800px;" cellspacing="0" cellpadding="0"
Line 49: Line 47:
 
showing different colors for different states and showing a new gauge for
 
showing different colors for different states and showing a new gauge for
 
the casting state.
 
the casting state.
 +
 +
[[File:VisuMZ_ATB_Setup_Note.png]]
  
 
*NOTE* You will need to set the game project to run in either TPB mode,
 
*NOTE* You will need to set the game project to run in either TPB mode,
Line 86: Line 86:
  
 
=== ATB Gauges ===
 
=== ATB Gauges ===
 +
 +
[[File:VisuMZ_ATB_Preview2.png|600px]]
  
 
The gauges are now revamped to show different colors to depict the various
 
The gauges are now revamped to show different colors to depict the various
 
ATB states a battler can be in. These various states include the following:
 
ATB states a battler can be in. These various states include the following:
  
- When a battler's speed is fully stopped.
+
* When a battler's speed is fully stopped.
- When a battler's speed is slower/faster past a specific rating.
+
* When a battler's speed is slower/faster past a specific rating.
- When a battler is ready for an action.
+
* When a battler is ready for an action.
- When a battler is casting an action (those with negative speed values).
+
* When a battler is casting an action (those with negative speed values).
  
 
The colors used for these states can be found and altered in the Plugin
 
The colors used for these states can be found and altered in the Plugin
Line 137: Line 139:
 
---
 
---
  
== Notetags ==
+
[[Options Core VisuStella MZ]]
 
 
The following are notetags that have been added through this plugin. These
 
notetags will not work with your game if this plugin is OFF or not present.
 
 
 
=== General ATB-Related Notetags ===
 
 
 
These notetags are general purpose notetags that have became available
 
through this plugin.
 
 
 
---
 
 
 
<ATB Help>
 
description
 
description
 
</ATB Help>
 
 
 
- Used for: Skill, Item Notetags
 
- If your game happens to support the ability to change battle systems, this
 
  notetag lets you change how the skill/item's help description text will
 
  look under TPB/ATB.
 
- This is primarily used if the skill behaves differently in TPB/ATB versus
 
  any other battle system.
 
- Replace 'description' with help text that's only displayed if the game's
 
  battle system is set to TPB/ATB.
 
 
 
---
 
 
 
<Hide ATB Gauge>
 
 
 
- Used for: Enemy Notetags
 
- If you don't want an enemy to show their ATB Gauge, use this notetag.
 
 
 
---
 
 
 
=== ATB Field Gauge-Related Notetags ===
 
 
 
These notetags only work if the ATB Field Gauge is enabled.
 
 
 
---
 
 
 
<ATB Field Gauge Icon: x>
 
 
 
- Used for: Actor, Enemy Notetags
 
- Changes the marker graphic used for the battler to a specific icon.
 
- Replace 'x' with the icon index to be used.
 
 
 
---
 
 
 
<ATB Field Gauge Face: filename, index>
 
 
 
- Used for: Enemy Notetags
 
- Changes the marker graphic used for the enemy (actors do not apply) to a
 
  specific face.
 
- Replace 'filename' with the filename of the image.
 
  - Do not include the file extension.
 
- Replace 'index' with the index of the face. Index values start at 0.
 
- Example: <ATB Field Gauge Face: Monster, 1>
 
 
 
---
 
 
 
=== ATB Gauge Manipulation-Related Notetags ===
 
 
 
These notetags are used for ATB Gauge manipulation purposes.
 
 
 
---
 
 
 
<ATB After Gauge: x%>
 
 
 
- Used for: Skill, Item Notetags
 
- After using the skill/item, the user's ATB Gauge will be set to x%.
 
- Replace 'x' with a percentile value representing the amount you want the
 
  ATB Gauge to reset to after the skill/item's usage.
 
 
 
---
 
 
 
<ATB Charge Gauge: x%>
 
<ATB Charge Gauge: +x%>
 
<ATB Charge Gauge: -x%>
 
 
 
- Used for: Skill, Item Notetags
 
- If the target is in a charging state, change the target's gauge amount to
 
  x% or by x% (if using the +/- variants).
 
- Replace 'x' with a percentile value representing the amount of the ATB
 
  Gauge you wish to alter it to/by.
 
- This only affects targets who are in a charging state.
 
 
 
---
 
 
 
<ATB Cast Gauge: x%>
 
<ATB Cast Gauge: +x%>
 
<ATB Cast Gauge: -x%>
 
 
 
- Used for: Skill, Item Notetags
 
- If the target is in a casting state, change the target's gauge amount to
 
  x% or by x% (if using the +/- variants).
 
- Replace 'x' with a percentile value representing the amount of the ATB
 
  Gauge you wish to alter it to/by.
 
- This only affects targets who are in a casting state.
 
 
 
---
 
 
 
<ATB Interrupt>
 
 
 
- Used for: Skill, Item Notetags
 
- If this skill/item hits a target who is in a casting state, interrupt that
 
  action to cancel it and reset the target's ATB Gauge to 0%.
 
 
 
---
 
 
 
<ATB Cannot Be Interrupted>
 
 
 
- Used for: Skill, Item Notetags
 
- Makes the skill/item immune to ATB Interruptions.
 
 
 
---
 
 
 
<ATB Battle Start Gauge: +x%>
 
<ATB Battle Start Gauge: -x%>
 
 
 
- Used for: Actor, Class, Skill, Weapon, Armor, Enemy, State Notetags
 
- Determine how much extra or less ATB Gauge the battler will start with if
 
  associated with one of these database objects.
 
- Replace 'x' with a percentile value determining how much extra or less ATB
 
  Gauge value the battler will start battle with.
 
- These values are additive when stacked.
 
 
 
---
 
 
 
<ATB After Gauge: +x%>
 
<ATB After Gauge: -x%>
 
 
 
- Used for: Actor, Class, Skill, Item, Weapon, Armor, Enemy, State Notetags
 
- Determine how much influence there is on the ATB Gauge after finishing a
 
  skill/item. Increase or decrease the amount after each action.
 
- Replace 'x' with a percentile value determining how much influence there
 
  is on the ATB Gauge after the skill/item has finished performing.
 
- These values are additive when stacked.
 
 
 
---
 
 
 
=== JavaScript Notetags: ATB Gauge Manipulation ===
 
 
 
The following are notetags made for users with JavaScript knowledge to
 
give more control over conditional ATB Gauge Manipulation.
 
 
 
---
 
 
 
<JS ATB Charge Gauge>
 
code
 
code
 
rate = code;
 
/<JS ATB Charge Gauge>
 
  
- Used for: Skill, Item Notetags
+
* Having the VisuStella Options Core available will allow you to adjust the speed at which the ATB gauges fill up.
- Replace 'code' with JavaScript code to determine how much to change the
 
  ATB Gauge to if the target is in a charging state.
 
- The 'rate' variable represents rate value the ATB Gauge will change to
 
  between the values of 0 and 1.
 
- The 'rate' variable will default to the target's current ATB Gauge rate
 
  if the target is in a charging state.
 
  
---
+
* The VisuStella Options Core also gives the player the option to toggle between Active and Wait-based ATB.
 
 
<JS ATB Cast Gauge>
 
code
 
code
 
rate = code;
 
/<JS ATB Cast Gauge>
 
 
 
- Used for: Skill, Item Notetags
 
- Replace 'code' with JavaScript code to determine how much to change the
 
  ATB Gauge to if the target is in a casting state.
 
- The 'rate' variable represents rate value the ATB Gauge will change to
 
  between the values of 0 and 1.
 
- The 'rate' variable will default to the target's current ATB Gauge rate
 
  if the target is in a casting state.
 
  
 
---
 
---
  
<JS ATB After Gauge>
+
{{Notetags MZ}}
code
 
code
 
rate = code;
 
/<JS ATB After Gauge>
 
  
- Used for: Skill, Item Notetags
+
{{VisuMZ Battle System ATB Notetags}}
- Replace 'code' with JavaScript code to determine how much to change the
 
  ATB Gauge to after performing this skill/item action.
 
- The 'rate' variable represents rate value the ATB Gauge will change to
 
  between the values of 0 and 1.
 
- The 'rate' variable will default to 0.
 
  
---
+
{{Plugin Commands MZ}}
 
 
== Plugin Commands ==
 
 
 
The following are Plugin Commands that come with this plugin. They can be
 
accessed through the Plugin Command event command.
 
  
---
+
{{VisuMZ Battle System ATB Plugin Commands}}
 
 
=== Actor Plugin Commands ===
 
 
 
---
 
 
 
Actor: Change Field Gauge Icon
 
- Changes the icons used for the specific actor(s) on the ATB Field Gauge.
 
 
 
  Actor ID(s):
 
  - Select which Actor ID(s) to affect.
 
 
 
  Icon:
 
  - Changes the graphic to this icon.
 
 
 
---
 
 
 
Actor: Clear Field Gauge Graphic
 
- Clears the ATB Field Gauge graphics for the actor(s).
 
- The settings will revert to the Plugin Parameter settings.
 
 
 
  Actor ID(s):
 
  - Select which Actor ID(s) to affect.
 
 
 
---
 
 
 
=== Enemy Plugin Commands ===
 
 
 
---
 
 
 
Enemy: Change Field Gauge Icon
 
- Changes the icons used for the specific enemy(ies) on the ATB Field Gauge.
 
 
 
  Enemy Index(es):
 
  - Select which enemy index(es) to affect.
 
 
 
  Icon:
 
  - Changes the graphic to this icon.
 
 
 
---
 
 
 
Enemy: Change Field Gauge Face
 
- Changes the faces used for the specific enemy(ies) on the ATB Field Gauge.
 
 
 
  Enemy Index(es):
 
  - Select which enemy index(es) to affect.
 
 
 
  Face Name:
 
  - This is the filename for the target face graphic.
 
 
 
  Face Index:
 
  - This is the index for the target face graphic.
 
 
 
---
 
 
 
Enemy: Clear Field Gauge Graphic
 
- Clears the ATB Field Gauge graphics for the enemy(ies).
 
- The settings will revert to the Plugin Parameter settings.
 
 
 
  Enemy Index(es):
 
  - Select which enemy index(es) to affect.
 
 
 
---
 
  
 
== Plugin Parameters ==
 
== Plugin Parameters ==
  
 
=== Mechanics Settings ===
 
=== Mechanics Settings ===
 +
 +
[[File:VisuMZ_ATB_Params1.png]]
  
 
Mechanics settings used for Battle System ATB. The majority of these are
 
Mechanics settings used for Battle System ATB. The majority of these are
Line 415: Line 171:
 
   Escape Fail Penalty:
 
   Escape Fail Penalty:
 
   - Gauge penalty if an escape attempt fails.
 
   - Gauge penalty if an escape attempt fails.
 +
 +
  Stuns Reset Gauge?:
 +
  - Should stuns reset the ATB Gauge?
  
 
   JS: Initial Gauge:
 
   JS: Initial Gauge:
Line 440: Line 199:
  
 
=== Interrupt Settings ===
 
=== Interrupt Settings ===
 +
 +
[[File:VisuMZ_ATB_Params2.png]]
  
 
Interrupt settings used for Battle System ATB.
 
Interrupt settings used for Battle System ATB.
Line 477: Line 238:
  
 
=== General Gauge Settings ===
 
=== General Gauge Settings ===
 +
 +
[[File:VisuMZ_ATB_Preview3.png|600px]]
 +
 +
[[File:VisuMZ_ATB_Params3.png]]
  
 
General gauge settings used for ATB Gauges.
 
General gauge settings used for ATB Gauges.
Line 528: Line 293:
  
 
=== Field Gauge Settings ===
 
=== Field Gauge Settings ===
 +
 +
[[File:VisuMZ_ATB_Preview1.png|600px]]
 +
 +
[[File:VisuMZ_ATB_Params4.png]]
  
 
The ATB Field Gauge is a large gauge placed on the screen with all of the
 
The ATB Field Gauge is a large gauge placed on the screen with all of the
Line 552: Line 321:
 
   - Left
 
   - Left
 
   - Right
 
   - Right
 +
 +
  Offset X:
 +
  Offset Y:
 +
  - How much to offset the X/Y coordinates by.
  
 
   Reposition for Help?:
 
   Reposition for Help?:
Line 714: Line 487:
  
 
=== Gauge Color Settings ===
 
=== Gauge Color Settings ===
 +
 +
[[File:VisuMZ_ATB_Preview2.png|600px]]
 +
 +
[[File:VisuMZ_ATB_Params5.png]]
  
 
Gauge color settings used for ATB Gauges.
 
Gauge color settings used for ATB Gauges.
Line 739: Line 516:
  
 
=== Options Settings ===
 
=== Options Settings ===
 +
 +
[[File:VisuMZ_ATB_Preview4.png|600px]]
 +
 +
[[File:VisuMZ_ATB_Params6.png]]
  
 
Options settings used for Battle System ATB.
 
Options settings used for Battle System ATB.
Line 771: Line 552:
  
 
== Changelog ==
 
== Changelog ==
 +
 +
Version 1.04: October 18, 2020
 +
* Compatibility Update!
 +
** Plugins should be more compatible with one another.
 +
 +
 +
 +
Version 1.03: October 11, 2020
 +
* Documentation Update
 +
** Help file updated with new features.
 +
* Feature Update!
 +
** Enemy letters are no longer drawn on the Field Gauge unless there are multiple enemies of the same type. Added by Arisu.
 +
* New Features!
 +
** New Plugin Parameters added by Arisu and Yanfly.
 +
*** Plugin Parameters > Field Gauge > Offset X and Y
 +
**** How much to offset the X/Y coordinates of the Field Gauge by.
 +
 +
 +
 +
Version 1.02: October 4, 2020
 +
* New Features!
 +
** New Plugin Command added "System: ATB Field Gauge Visibility" to let you show or hide the Field Gauge during battle. Added by Arisu.
 +
 +
 +
 +
Version 1.01: September 27, 2020
 +
* Bug Fixes!
 +
** ATB Cast and Charge notetags no longer cause crashes. Fix made by Olivia.
 +
* New Features!
 +
** New plugin parameter added by Olivia.
 +
*** Plugin Parameters > Mechanics > Stuns Reset Gauge?
 +
**** Should stuns reset the ATB Gauge?
 +
 +
  
 
Version 1.00: September 21, 2020
 
Version 1.00: September 21, 2020
Line 781: Line 596:
 
<!-- This is a comment, remove the arrows surrounding this for the categories you want to show -->
 
<!-- This is a comment, remove the arrows surrounding this for the categories you want to show -->
 
<!-- [[Category: RPG Maker MZ Core Plugins]] -->
 
<!-- [[Category: RPG Maker MZ Core Plugins]] -->
<!-- [[Category: RPG Maker MZ Battle Plugins]] -->
+
[[Category: RPG Maker MZ Battle Plugins]]
 
<!-- [[Category: RPG Maker MZ Item Plugins]] -->
 
<!-- [[Category: RPG Maker MZ Item Plugins]] -->
 
<!-- [[Category: RPG Maker MZ Skill Plugins]] -->
 
<!-- [[Category: RPG Maker MZ Skill Plugins]] -->
 
<!-- [[Category: RPG Maker MZ Equip Plugins]] -->
 
<!-- [[Category: RPG Maker MZ Equip Plugins]] -->
 
<!-- [[Category: RPG Maker MZ Status Menu Plugins]] -->
 
<!-- [[Category: RPG Maker MZ Status Menu Plugins]] -->
<!-- [[Category: RPG Maker MZ Gameplay Plugins]] -->
+
[[Category: RPG Maker MZ Gameplay Plugins]]
 
<!-- [[Category: RPG Maker MZ Movement Plugins]] -->
 
<!-- [[Category: RPG Maker MZ Movement Plugins]] -->
 
<!-- [[Category: RPG Maker MZ Quest Plugins]] -->
 
<!-- [[Category: RPG Maker MZ Quest Plugins]] -->
 
<!-- [[Category: RPG Maker MZ Options Plugins]] -->
 
<!-- [[Category: RPG Maker MZ Options Plugins]] -->
 
<!-- [[Category: RPG Maker MZ Eventing Plugins]] -->
 
<!-- [[Category: RPG Maker MZ Eventing Plugins]] -->
<!-- [[Category: RPG Maker MZ Utility Plugins]] -->
+
[[Category: RPG Maker MZ Utility Plugins]]
<!-- [[Category: RPG Maker MZ Mechanical Plugins]] -->
+
[[Category: RPG Maker MZ Mechanical Plugins]]
<!-- [[Category: RPG Maker MZ Visual Plugins]] -->
+
[[Category: RPG Maker MZ Visual Plugins]]
 
<!-- [[Category: RPG Maker MZ Menu Plugins]] -->
 
<!-- [[Category: RPG Maker MZ Menu Plugins]] -->
 
<!-- [[Category: RPG Maker MZ Message Plugins]] -->
 
<!-- [[Category: RPG Maker MZ Message Plugins]] -->
<!-- [[Category: RPG Maker MZ Quality of Life Plugins]] -->
+
[[Category: RPG Maker MZ Quality of Life Plugins]]
 
<!-- [[Category: Action Sequences (MZ)]] -->
 
<!-- [[Category: Action Sequences (MZ)]] -->
 
<!-- [[Category: Comment Tags (MZ)]] -->
 
<!-- [[Category: Comment Tags (MZ)]] -->

Revision as of 19:29, 17 October 2020

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.



Download

System

This is a plugin created for RPG Maker MZ.

Click here for help on how to install plugins and an explanation on the Tier Hierarchy System.


UpdatePlugins.png

Click here to learn how to update plugins.


Troubleshooting.jpg

Click here for how to troubleshoot plugins if you get an error.



VisuMZ ATB Preview1.png

VisuMZ ATB Preview2.png

VisuMZ ATB Preview3.png

VisuMZ ATB Preview4.png

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.


VisuStella MZ

This plugin is a part of the VisuStella MZ Plugin Library.


Support VisuStella

Click here if you want to help support VisuStella on Patreon.


Introduction

The RPG Maker MZ Time Progress Battle (TPB) system is only a few steps away from the acclaimed Active Turn Battle (ATB) system. This plugin will grant it the various features needed to turn it from TPB into ATB.

This plugin will grant control over how the various mechanics work, ranging from penalties to calculations, to actions that can manipulate the ATB gauge of battlers. Battlers that are in the middle of casting a spell can also be interrupted with specific notetag traits.

ATB Gauges can also be displayed on enemies and/or allies, giving the player full access to the current battle state. The ATB Gauges are also improved, showing different colors for different states and showing a new gauge for the casting state.

VisuMZ ATB Setup Note.png

  • NOTE* You will need to set the game project to run in either TPB mode,

Time Progress (Active) or Time Progress (Wait), for these new ATB effects to work. You can find this setting in Database > System 1.

Features include all (but not limited to) the following:

  • Full control over the TPB/ATB mechanics such as speed, calculations, etc.
  • Notetags that give skills and items access to ATB Gauge manipulation, by altering how filled they are.
  • Interrupts can be used on battlers in the middle of casting a skill.
  • Visual ATB Gauges can be displayed over battlers' heads.
  • ATB Gauges have extra coloring options added to them to let the player quickly know the current speed state of the ATB Gauge.
  • A field-wide ATB Gauge that positions actor and enemy markers on it to show how far along actors and enemies are relative to each other's turns.

Requirements

This plugin is made for RPG Maker MZ. This will not work in other iterations of RPG Maker.

Required Plugin List

This plugin requires the above listed plugins to be installed inside your game's Plugin Manager list in order to work. You cannot start your game with this plugin enabled without the listed plugins.


Tier 2

This plugin is a Tier 2 plugin. Place it under other plugins of lower tier value on your Plugin Manager list (ie: 0, 1, 2, 3, 4, 5).

This is to ensure that your plugins will have the best compatibility with the rest of the VisuStella MZ Plugin library.


Major Changes

This plugin adds some new hard-coded features to RPG Maker MZ's functions. The following is a list of them.

---

ATB Gauges

VisuMZ ATB Preview2.png

The gauges are now revamped to show different colors to depict the various ATB states a battler can be in. These various states include the following:

  • When a battler's speed is fully stopped.
  • When a battler's speed is slower/faster past a specific rating.
  • When a battler is ready for an action.
  • When a battler is casting an action (those with negative speed values).

The colors used for these states can be found and altered in the Plugin Parameters under Gauge Color Settings.

---

Skill & Item Speeds

With TPB, skills and items with negative speed values will cause the battler to enter a "casting" state, meaning they have to wait extra time before the action takes off. With this delayed action execution, one might assume that if there is a positive speed value, the battler would require less time for their next turn.

However, this isn't the case with RPG Maker MZ's TPB. By changing it to ATB, skills and items with positive speed values will have an impact on how full their ATB Gauges will be in the following turn. A value of 2000 will put the gauge at 50% full, 1000 will put the gauge at 25% full, 500 will put it at 12.5% full, and so on. Notetags can also be used to influence this.

---

JS Calculation Mechanics

While the calculation mechanics aren't changed from their original RPG Maker MZ formulas, the functions for them have been overwritten to allow you, the game developer, to alter them as you see fit.

---

Extra Features

There are some extra features found if other VisuStella MZ plugins are found present in the Plugin Manager list.

---

Core Engine VisuStella MZ

  • ATB Interrupts can have animations played when they trigger if the Core Engine is installed.

---

Options Core VisuStella MZ

  • Having the VisuStella Options Core available will allow you to adjust the speed at which the ATB gauges fill up.
  • The VisuStella Options Core also gives the player the option to toggle between Active and Wait-based ATB.

---

Notetags

RPG Maker MZ'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 are notetags that have been added through this plugin. These notetags will not work with your game if this plugin is OFF or not present.

General ATB-Related Notetags

VisuMZ ATB Preview3.png

These notetags are general purpose notetags that have became available through this plugin.

---

<ATB Help>
 description
 description
</ATB Help>

- Used for: Skill, Item Notetags
- If your game happens to support the ability to change battle systems, this
  notetag lets you change how the skill/item's help description text will
  look under TPB/ATB.
- This is primarily used if the skill behaves differently in TPB/ATB versus
  any other battle system.
- Replace 'description' with help text that's only displayed if the game's
  battle system is set to TPB/ATB.

---

<Hide ATB Gauge>

- Used for: Enemy Notetags
- If you don't want an enemy to show their ATB Gauge, use this notetag.

---

ATB Field Gauge-Related Notetags

VisuMZ ATB Preview1.png

These notetags only work if the ATB Field Gauge is enabled.

---

<ATB Field Gauge Icon: x>

- Used for: Actor, Enemy Notetags
- Changes the marker graphic used for the battler to a specific icon.
- Replace 'x' with the icon index to be used.

---

<ATB Field Gauge Face: filename, index>

- Used for: Actor, Enemy Notetags
- Changes the marker graphic used for the enemy to a specific face.
- Replace 'filename' with the filename of the image.
  - Do not include the file extension.
- Replace 'index' with the index of the face. Index values start at 0.
- Example: <ATB Field Gauge Face: Monster, 1>

---

ATB Gauge Manipulation-Related Notetags

VisuMZ ATB Preview2.png

These notetags are used for ATB Gauge manipulation purposes.

---

<ATB After Gauge: x%>

- Used for: Skill, Item Notetags
- After using the skill/item, the user's ATB Gauge will be set to x%.
- Replace 'x' with a percentile value representing the amount you want the
  ATB Gauge to reset to after the skill/item's usage.

---

<ATB Charge Gauge: x%>
<ATB Charge Gauge: +x%>
<ATB Charge Gauge: -x%>

- Used for: Skill, Item Notetags
- If the target is in a charging state, change the target's gauge amount to
  x% or by x% (if using the +/- variants).
- Replace 'x' with a percentile value representing the amount of the ATB
  Gauge you wish to alter it to/by.
- This only affects targets who are in a charging state.

---

<ATB Cast Gauge: x%>
<ATB Cast Gauge: +x%>
<ATB Cast Gauge: -x%>

- Used for: Skill, Item Notetags
- If the target is in a casting state, change the target's gauge amount to
  x% or by x% (if using the +/- variants).
- Replace 'x' with a percentile value representing the amount of the ATB
  Gauge you wish to alter it to/by.
- This only affects targets who are in a casting state.

---

<ATB Interrupt>

- Used for: Skill, Item Notetags
- If this skill/item hits a target who is in a casting state, interrupt that
  action to cancel it and reset the target's ATB Gauge to 0%.

---

<ATB Cannot Be Interrupted>

- Used for: Skill, Item Notetags
- Makes the skill/item immune to ATB Interruptions.

---

<ATB Battle Start Gauge: +x%>
<ATB Battle Start Gauge: -x%>

- Used for: Actor, Class, Skill, Weapon, Armor, Enemy, State Notetags
- Determine how much extra or less ATB Gauge the battler will start with if
  associated with one of these database objects.
- Replace 'x' with a percentile value determining how much extra or less ATB
  Gauge value the battler will start battle with.
- These values are additive when stacked.

---

<ATB After Gauge: +x%>
<ATB After Gauge: -x%>

- Used for: Actor, Class, Skill, Item, Weapon, Armor, Enemy, State Notetags
- Determine how much influence there is on the ATB Gauge after finishing a
  skill/item. Increase or decrease the amount after each action.
- Replace 'x' with a percentile value determining how much influence there
  is on the ATB Gauge after the skill/item has finished performing.
- These values are additive when stacked.

---

JavaScript Notetags: ATB Gauge Manipulation

VisuMZ ATB Preview2.png

The following are notetags made for users with JavaScript knowledge to give more control over conditional ATB Gauge Manipulation.

---

<JS ATB Charge Gauge>
 code
 code
 rate = code;
</JS ATB Charge Gauge>

- Used for: Skill, Item Notetags
- Replace 'code' with JavaScript code to determine how much to change the
  ATB Gauge to if the target is in a charging state.
- The 'rate' variable represents rate value the ATB Gauge will change to
  between the values of 0 and 1.
- The 'rate' variable will default to the target's current ATB Gauge rate
  if the target is in a charging state.

---

<JS ATB Cast Gauge>
 code
 code
 rate = code;
</JS ATB Cast Gauge>

- Used for: Skill, Item Notetags
- Replace 'code' with JavaScript code to determine how much to change the
  ATB Gauge to if the target is in a casting state.
- The 'rate' variable represents rate value the ATB Gauge will change to
  between the values of 0 and 1.
- The 'rate' variable will default to the target's current ATB Gauge rate
  if the target is in a casting state.

---

<JS ATB After Gauge>
 code
 code
 rate = code;
</JS ATB After Gauge>

- Used for: Skill, Item Notetags
- Replace 'code' with JavaScript code to determine how much to change the
  ATB Gauge to after performing this skill/item action.
- The 'rate' variable represents rate value the ATB Gauge will change to
  between the values of 0 and 1.
- The 'rate' variable will default to 0.

---

Plugin Commands

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 MZ.

Here is a list of Plugin Command(s) that you may use:

---


The following are Plugin Commands that come with this plugin. They can be accessed through the Plugin Command event command.

---

Actor Plugin Commands

VisuMZ ATB Preview1.png

---

VisuMZ ATB Command1.png

Actor: Change Field Gauge Icon
- Changes the icons used for the specific actor(s) on the ATB Field Gauge.

  Actor ID(s):
  - Select which Actor ID(s) to affect.

  Icon:
  - Changes the graphic to this icon.

---

VisuMZ ATB Update11 Command1.png

Actor: Change Field Gauge Face
- Changes the faces used for the specific actor(s) on the ATB Field Gauge.

  Actor ID(s):
  - Select which Actor ID(s) to affect.

  Face Name:
  - This is the filename for the target face graphic.

  Face Index:
  - This is the index for the target face graphic.

---

VisuMZ ATB Command2.png

Actor: Clear Field Gauge Graphic
- Clears the ATB Field Gauge graphics for the actor(s).
- The settings will revert to the Plugin Parameter settings.

  Actor ID(s):
  - Select which Actor ID(s) to affect.

---

Enemy Plugin Commands

VisuMZ ATB Preview1.png

---

VisuMZ ATB Command3.png

Enemy: Change Field Gauge Icon
- Changes the icons used for the specific enemy(ies) on the ATB Field Gauge.

  Enemy Index(es):
  - Select which enemy index(es) to affect.

  Icon:
  - Changes the graphic to this icon.

---

VisuMZ ATB Command4.png

Enemy: Change Field Gauge Face
- Changes the faces used for the specific enemy(ies) on the ATB Field Gauge.

  Enemy Index(es):
  - Select which enemy index(es) to affect.

  Face Name:
  - This is the filename for the target face graphic.

  Face Index:
  - This is the index for the target face graphic.

---

VisuMZ ATB Command5.png

Enemy: Clear Field Gauge Graphic
- Clears the ATB Field Gauge graphics for the enemy(ies).
- The settings will revert to the Plugin Parameter settings.

  Enemy Index(es):
  - Select which enemy index(es) to affect.

---

System Plugin Commands

---

BattleSysATB Update7 Command1.png

System: ATB Field Gauge Visibility
- Determine the visibility of the ATB Field Gauge.

  Visibility:
  - Changes the visibility of the ATB Field Gauge.

---

Plugin Parameters

Mechanics Settings

VisuMZ ATB Params1.png

Mechanics settings used for Battle System ATB. The majority of these are JavaScript-based and will require knowledge of JavaScript to fully utilize the plugin parameters.

---

Mechanics

 Escape Fail Penalty:
 - Gauge penalty if an escape attempt fails.
 Stuns Reset Gauge?:
 - Should stuns reset the ATB Gauge?
 JS: Initial Gauge:
 - JavaScript code to determine how much ATB gauge to give each battler at
   the start of battle.
 JS: Speed:
 - JavaScript code to determine how much speed a battler has.
 JS: Base Speed:
 - JavaScript code to determine how much base speed a battler has.
 JS: Relative Speed:
 - JavaScript code to determine what is the relative speed of a battler.
 JS: Acceleration:
 - JavaScript code to determine how much gauges accelerate by relative to
   reference time.
 JS: Cast Time:
 - JavaScript code to determine how much cast time is used for skills/items
   with negative speed modifiers.

---

Interrupt Settings

VisuMZ ATB Params2.png

Interrupt settings used for Battle System ATB.

---

Interrupt

 Animation ID:
 - Play this animation when a unit is interrupted.
 - Requires VisuMZ_0_CoreEngine.
   Mirror Animation:
   - Mirror the interrupt animation?
   - Requires VisuMZ_0_CoreEngine.
   Mute Animation:
   - Mute the interrupt animation?
   - Requires VisuMZ_0_CoreEngine.
 Text Popup:
 - Text used for popup when interrupts happen.
 - Leave empty for no popup.
 Text Color:
 - Use #rrggbb for custom colors or regular numbers for text colors from
   the Window Skin.
   Flash Color:
   - Adjust the popup's flash color.
   - Format: [red, green, blue, alpha]
   Flash Duration:
   - What is the frame duration of the flash effect?

---

General Gauge Settings

VisuMZ ATB Preview3.png

VisuMZ ATB Params3.png

General gauge settings used for ATB Gauges.

---

General

 Anchor X:
 Anchor Y:
 - Where do you want the ATB Gauge sprite's anchor X/Y to be?
 - Use values between 0 and 1 to be safe.
 Scale:
 - How large/small do you want the ATB Gauge to be scaled?
 Offset X:
 Offset Y:
 - How many pixels to offset the ATB Gauge's X/Y by?

---

AGI Gauge Rates

 Slow Rate:
 - How much should the AGI rate be at to be considered slow?
 Fast Rate:
 - How much should the AGI rate be at to be considered fast?

---

Actors

 Show Sprite Gauges:
 - Show ATB Gauges over the actor sprites' heads?
 - Requires SV Actors to be visible.
 Show Status Gauges:
 - Show ATB Gauges in the status window?
 - Applies only to sideview.

---

Enemies

 Show Sprite Gauges:
 - Show ATB Gauges over the enemy sprites' heads?

---

Field Gauge Settings

VisuMZ ATB Preview1.png

VisuMZ ATB Params4.png

The ATB Field Gauge is a large gauge placed on the screen with all of the current battle's active participants shown on it. The participants are represented by a marker. Each marker's position on the gauge indicates its battler's ATB progress towards a turn.

In order for this feature to work, enable "Use Field Gauge?" in the Plugin Parameters.

---

General

 Use Field Gauge?:
 - This value must be set to true in order for the ATB Field Gauge
   to appear.
 - This needs to be on in order for this feature to work.
 Display Position:
 - Select where the Field Gauge will appear on the screen.
 - Top
 - Bottom
 - Left
 - Right
 Offset X:
 Offset Y:
 - How much to offset the X/Y coordinates by.
 Reposition for Help?:
 - If the display position is at the top, reposition the gauge when the
   help window is open?
 Forward Direction:
 - Decide on the direction of the Field Gauge.
 - Settings may vary depending on position.
 - Left to Right
 - Right to Left
 - Up to Down
 - Down to Up

---

Field Gauge Settings

 Gauge Skin:
 - Optional. Select an image to place behind the gauge.
 - This will be centered on the Field Gauge's position.
 Show Gauge?:
 - Decide if you want the gauge to be shown.
 Horizontal Length:
 - The length of the Field Gauge if placed horizontally.
 Vertical Length:
 - The length of the Field Gauge if placed vertically.
 Thickness:
 - The thickness of the Field Gauge for either direction.
 Split Location:
 - Determine where the gauge should split.
 - Use 0.00 for the start. Use 1.00 for the end.

---

Marker Sprites

 Actor Marker Side:
 - Which side do you want the actor markers to appear?
 Enemy Marker Side:
 - Which side do you want the enemy markers to appear?
 Marker Offset:
 - How many pixels do you want to offset the markers by?
 Marker Size:
 - How pixels wide and tall do you want the markers to be?
 Marker Speed:
 - How many pixels maximum can a marker travel in one frame?
 Opacity Rate:
 - If a marker has to change opacity, how fast should it change by?

---

Marker Border

 Show Border?:
 - Show borders for the marker sprites?
 Border Thickness:
 - How many pixels thick should the colored portion of the border be?
 Actors
 Enemies
   Border Color:
   - Use #rrggbb for custom colors or regular numbers for text colors
     from the Window Skin.
   Border Skin:
   - Optional. Place a skin on the actor/enemy borders instead of
     rendering them?

---

Marker Sprites

 Actors
   Sprite Type:
   - Select the type of sprite used for the actor graphic.
   - Face Graphic - Show the actor's face.
   - Icon - Show a specified icon.
   - Sideview Actor - Show the actor's sideview battler.
   Default Icon:
   - Which icon do you want to use for actors by default?
 Enemies
   Sprite Type:
   - Select the type of sprite used for the enemy graphic.
   - Face Graphic - Show a specified face graphic.
   - Icon - Show a specified icon.
   - Enemy - Show the enemy's graphic or sideview battler.
   Default Face Name:
   - Use this default face graphic if there is no specified face.
   Default Face Index:
   - Use this default face index if there is no specified index.
   Default Icon:
   - Which icon do you want to use for enemies by default?
   Match Hue?:
   - Match the hue for enemy battlers?
   - Does not apply if there's a sideview battler.

---

Marker Letter

 Show Enemy Letter?:
 - Show the enemy's letter on the marker sprite?
 Font Name:
 - The font name used for the text of the Letter.
 - Leave empty to use the default game's font.
 Font Size:
 - The font size used for the text of the Letter.

---

Marker Background

 Show Background?:
 - Show the enemy's letter on the marker sprite?
 Actors
 Enemies
   Background Color 1:
   Background Color 2:
   - Use #rrggbb for custom colors or regular numbers for text colors
     from the Window Skin.
   Background Skin:
   - Optional. Use a skin for the actor background instead of
     rendering them?

---

Marker Arrow

 Show Arrow?:
 - Show the arrow sprite pointing towards the Field Gauge?
 Arrow Skin:
 - Pick a window skin to draw arrows from.

---

Gauge Color Settings

VisuMZ ATB Preview2.png

VisuMZ ATB Params5.png

Gauge color settings used for ATB Gauges.

---

Colors

 Default Color 1:
 Default Color 2:
 Full Color 1:
 Full Color 2:
 Cast Color 1:
 Cast Color 2:
 Fast Color 1:
 Fast Color 2:
 Slow Color 1:
 Slow Color 2:
 Stop Color 1:
 Stop Color 2:
 - Use #rrggbb for custom colors or regular numbers for text colors from
   the Window Skin.

---

Options Settings

VisuMZ ATB Preview4.png

VisuMZ ATB Params6.png

Options settings used for Battle System ATB.

---

Options

 Add Option?:
 - Add the 'Show ATB Gauges' option to the Options menu?
 Adjust Window Height:
 - Automatically adjust the options window height?
 Option Name:
 - Command name of the option.

---


Terms of Use

1. These plugins may be used in free or commercial games provided that they have been acquired through legitimate means at VisuStella.com and/or any other official approved VisuStella sources. Exceptions and special circumstances that may prohibit usage will be listed on VisuStella.com.

2. All of the listed coders found in the Credits section of this plugin must be given credit in your games or credited as a collective under the name: "VisuStella".

3. You may edit the source code to suit your needs, so long as you do not claim the source code belongs to you. VisuStella also does not take responsibility for the plugin if any changes have been made to the plugin's code, nor does VisuStella take responsibility for user-provided custom code used for custom control effects including advanced JavaScript notetags and/or plugin parameters that allow custom JavaScript code.

4. You may NOT redistribute these plugins nor take code from this plugin to use as your own. These plugins and their code are only to be downloaded from VisuStella.com and other official/approved VisuStella sources. A list of official/approved sources can also be found on VisuStella.com.

5. VisuStella is not responsible for problems found in your game due to unintended usage, incompatibility problems with plugins outside of the VisuStella MZ library, plugin versions that aren't up to date, nor responsible for the proper working of compatibility patches made by any third parties. VisuStella is not responsible for errors caused by any user-provided custom code used for custom control effects including advanced JavaScript notetags and/or plugin parameters that allow JavaScript code.

6. If a compatibility patch needs to be made through a third party that is unaffiliated with VisuStella that involves using code from the VisuStella MZ library, contact must be made with a member from VisuStella and have it approved. The patch would be placed on VisuStella.com as a free download to the public. Such patches cannot be sold for monetary gain, including commissions, crowdfunding, and/or donations.

7. If this VisuStella MZ plugin is a paid product, all project team members must purchase their own individual copies of the paid product if they are to use it. Usage includes working on related game mechanics, managing related code, and/or using related Plugin Commands and features. Redistribution of the plugin and/or its code to other members of the team is NOT allowed unless they own the plugin itself as that conflicts with Article 4.

8. Any extensions and/or addendums made to this plugin's Terms of Use can be found on VisuStella.com and must be followed.

Terms of Use: Japanese


『VisuStella MZ』利用規約

1. これらのプラグインは、VisuStella.comおよび/または公式に承認されたVisuStellaのソースから合法的な手段で入手したものである限り、フリーゲームや商用ゲームに使用することができます。例外的に使用が禁止される場合については、VisuStella.comの記載をご確認ください。

2. 本プラグインの「クレジット」部分に記載されているすべてのコーダーの名前は、ゲーム内にクレジット表記を行うか、もしくは「VisuStella」という名前の下にまとめて表記する必要があります。

3. ソースコードを自分のものだと主張しない限りは、必要に応じて編集することが可能です。ただしプラグインのコードに変更が加えられた場合、VisuStellaはそのプラグインに対して一切の責任を負いません。高度なJavaScriptのノートタグやJavaScriptコードを許可するプラグインのパラメータを含む、カスタムコントロールエフェクトに使用される、ユーザー提供のカスタムコードについても、VisuStellaは一切の責任を負いません。

4. これらのプラグインやプラグイン内のコードを、「自分のもの」として再配布したり使用したりすることはできません。これらのプラグインとそのコードは、VisuStella.comおよび、その他の公式/承認済みVisuStellaソースからのみダウンロードすることができます。公式/承認済みのソースのリストは、VisuStella.comでご確認いただけます。

5. VisuStellaは、意図しない使用方法による問題、VisuStella MZライブラリ以外のプラグインとの非互換性の問題、プラグインのバージョンが最新でないことによる問題、第三者による互換性パッチが適切に動作していないことなどが原因でゲーム内で発生した問題については、一切の責任を負いません。VisuStellaは、高度なJavaScriptのノートタグやJavaScriptコードを許可するプラグインのパラメータを含む、カスタムコントロールエフェクトに使用される、ユーザー提供のカスタムコードに起因するエラーについても、一切の責任を負いません。

6. VisuStella MZライブラリのコードを使用した互換性パッチをVisuStellaとは関係のない第三者を通じて作成する必要がある場合は、まずVisuStellaのメンバーと連絡を取り、承認を得る必要があります。パッチはVisuStella.comに公開され、誰でも無料でダウンロードすることができるようになります。このようなパッチを、制作発注やクラウドファンディングの対象にしたり、寄付などの金銭的な利益を得るために販売することはできません。

7. このVisuStella MZプラグインが商用製品である場合、プロジェクトチームのすべてのメンバーは、それを使用するため、それぞれ製品を購入しなければなりません。使用方法には、関連するゲームメカニクスの作業、関連するコードの管理、および/または関連するプラグインコマンドや機能の使用、が含まれます。プラグインそのものやそのコードをチームの他のメンバーに再配布することは第4項に抵触するため、そのメンバーがプラグインそのものを所有していない限りは許可されません。

8. このプラグインの利用規約の追加項目や補足については、VisuStella.comに掲載されていますので、それを参照し従ってください。

Credits

If you are using this plugin, credit the following people in your game:

Team VisuStella

Changelog

Version 1.04: October 18, 2020

  • Compatibility Update!
    • Plugins should be more compatible with one another.


Version 1.03: October 11, 2020

  • Documentation Update
    • Help file updated with new features.
  • Feature Update!
    • Enemy letters are no longer drawn on the Field Gauge unless there are multiple enemies of the same type. Added by Arisu.
  • New Features!
    • New Plugin Parameters added by Arisu and Yanfly.
      • Plugin Parameters > Field Gauge > Offset X and Y
        • How much to offset the X/Y coordinates of the Field Gauge by.


Version 1.02: October 4, 2020

  • New Features!
    • New Plugin Command added "System: ATB Field Gauge Visibility" to let you show or hide the Field Gauge during battle. Added by Arisu.


Version 1.01: September 27, 2020

  • Bug Fixes!
    • ATB Cast and Charge notetags no longer cause crashes. Fix made by Olivia.
  • New Features!
    • New plugin parameter added by Olivia.
      • Plugin Parameters > Mechanics > Stuns Reset Gauge?
        • Should stuns reset the ATB Gauge?


Version 1.00: September 21, 2020

  • Finished Plugin!

End of File