Template:VisuMZ Battle System ATB Notetags

From Yanfly.moe Wiki
Revision as of 12:11, 24 October 2020 by Yanfly (talk | contribs) (ATB Field Gauge-Related Notetags)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

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.

---