Template:VisuMZ Weapon Unleash Notetags

From Yanfly.moe Wiki
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.

Unleash-Related Notetags

WeaponUnleashMZ.gif

The following notetags are related to Unleashes, which have a percent chance of trigger upon selecting "Attack" or "Guard" commands in-battle.

---

<Weapon Unleash id: x%>
<Weapon Unleash name: x%>

- Used for: Actor, Class, Skill, Weapon, Armor, Enemy, State Notetags
- Gives this object a trait that allows the affiliated battler a chance to
  perform an action other than "Attack" when selected.
- Replace 'id' with either the skill's ID or name you wish for the "Attack"
  command to have a chance of activating.
- Replace 'x' with a number representing the percentile chance to activate
  the Unleash skill.
- If a battler has multiple Weapon Unleash traits, the game will go through
  each trait one by one, taking whichever Unleash skill succeeds first.

---

<Guard Unleash id: x%>
<Guard Unleash name: x%>

- Used for: Actor, Class, Skill, Weapon, Armor, Enemy, State Notetags
- Gives this object a trait that allows the affiliated battler a chance to
  perform an action other than "Guard" when selected.
- Replace 'id' with either the skill's ID or name you wish for the "Guard"
  command to have a chance of activating.
- Replace 'x' with a number representing the percentile chance to activate
  the Unleash skill.
- If a battler has multiple Guard Unleash traits, the game will go through
  each trait one by one, taking whichever Unleash skill succeeds first.

---

<Weapon Unleash: +x%>
<Weapon Unleash: -x%>

- Used for: Actor, Class, Skill, Weapon, Armor, Enemy, State Notetags
- Raises/Lowers the activation chance of all Weapon Unleashes by x%.
- Replace 'x' with a number representing the additive increase/decrease of
  all Weapon Unleash success rates.

---

<Weapon Unleash id: +x%>
<Weapon Unleash id: -x%>

- Used for: Actor, Class, Skill, Weapon, Armor, Enemy, State Notetags
- Raises/Lowers the activation chance of the listed Weapon Unleash by x%.
- Replace 'id' with either the skill's ID or name you wish to increase the
  Weapon Unleash success rate for.
- Replace 'x' with a number representing the additive increase/decrease of
  the specified Weapon Unleash success rates.

---

<Guard Unleash: +x%>
<Guard Unleash: -x%>

- Used for: Actor, Class, Skill, Weapon, Armor, Enemy, State Notetags
- Raises/Lowers the activation chance of all Guard Unleashes by x%.
- Replace 'x' with a number representing the additive increase/decrease of
  all Guard Unleash success rates.

---

<Guard Unleash id: +x%>
<Guard Unleash id: -x%>

- Used for: Actor, Class, Skill, Weapon, Armor, Enemy, State Notetags
- Raises/Lowers the activation chance of the listed Guard Unleash by x%.
- Replace 'id' with either the skill's ID or name you wish to increase the
  Guard Unleash success rate for.
- Replace 'x' with a number representing the additive increase/decrease of
  the specified Guard Unleash success rates.

---

JavaScript Notetags: Unleash-Related

WeaponUnleashMZ.gif

The following notetags are made for users with JavaScript knowledge to determine which Unleash skill will be used (if at all).

---

<JS Weapon Unleash>
 code
 code
 id = code;
</JS Weapon Unleash>

- Used for: Actor, Class, Skill, Weapon, Armor, Enemy, State Notetags
- Determines the Weapon Unleash skill ID to use.
- Replace 'code' with JavaScript code to determine the skill ID to use.
- The 'user' is the battler who is attempting to unleash the skill.
- The 'id' variable is the skill ID that the character will use for the
  "Weapon Unleash".
- Hint: The Unleashes occur at a 100% success rate. If you wish to make a
  percent chance success rate, check for a random number, and make it use
  the desired skill ID if it passes, and the default attack skill ID if it
  does not pass.

---

<JS Guard Unleash>
 code
 code
 id = code;
</JS Guard Unleash>

- Used for: Actor, Class, Skill, Weapon, Armor, Enemy, State Notetags
- Determines the Guard Unleash skill ID to use.
- Replace 'code' with JavaScript code to determine the skill ID to use.
- The 'user' is the battler who is attempting to unleash the skill.
- The 'id' variable is the skill ID that the character will use for the
  "Guard Unleash".
- Hint: The Unleashes occur at a 100% success rate. If you wish to make a
  percent chance success rate, check for a random number, and make it use
  the desired skill ID if it passes, and the default attack skill ID if it
  does not pass.

---

<JS On Unleash>
 code
 code
 code
</JS On Unleash>

- Used for: Actor, Class, Skill, Weapon, Armor, Enemy, State Notetags
- This code runs when any kind of Unleash, Weapon or Guard, triggers.
- Runs 'code' with JavaScript code to determine any effects that occur.
- The 'user' is the battler who is currently using the unleash skill.
- The 'id' variable is the skill ID being unleashed.
- The 'skill' variable is the skill being unleashed.

---

<JS On Weapon Unleash>
 code
 code
 code
</JS On Weapon Unleash>

- Used for: Actor, Class, Skill, Weapon, Armor, Enemy, State Notetags
- This code runs when a Weapon Unleash triggers.
- Runs 'code' with JavaScript code to determine any effects that occur.
- The 'user' is the battler who is currently using the unleash skill.
- The 'id' variable is the skill ID being unleashed.
- The 'skill' variable is the skill being unleashed.

---

<JS On Guard Unleash>
 code
 code
 code
</JS On Guard Unleash>

- Used for: Actor, Class, Skill, Weapon, Armor, Enemy, State Notetags
- This code runs when a Guard Unleash triggers.
- Runs 'code' with JavaScript code to determine any effects that occur.
- The 'user' is the battler who is currently using the unleash skill.
- The 'id' variable is the skill ID being unleashed.
- The 'skill' variable is the skill being unleashed.

---

Replace-Related Notetags

UnleashReplace.png

Skill replacement traits will replace the "Attack" and "Guard" commands in battle with other skills. They will always be replaced unless an Unleash successfully triggers and overrides them.

---

<Replace Attack: id>

- Used for: Actor, Class, Skill, Weapon, Armor, Enemy, State Notetags
- Replaces the battler's Attack command in battle with a different skill.
- Replace 'id' with the skill's ID or name you wish to replace the battler's
  Attack command with.
- If a Weapon Unleash occurs, the Weapon Unleash will take priority over the
  Replace Attack skill.
- If a battler has multiple Replace Attack traits, the game will go through
  each trait one by one, taking whichever replaced skill is found first.

---

<Replace Guard: id>

- Used for: Actor, Class, Skill, Weapon, Armor, Enemy, State Notetags
- Replaces the battler's Guard command in battle with a different skill.
- Replace 'id' with the skill's ID or name you wish to replace the battler's
  Guard command with.
- If a Weapon Unleash occurs, the Weapon Unleash will take priority over the
  Replace Guard skill.
- If a battler has multiple Replace Guard traits, the game will go through
  each trait one by one, taking whichever replaced skill is found first.

---

JavaScript Notetags: Replace-Related

UnleashReplace.png

The following notetags are made for users with JavaScript knowledge to determine which replacement skill will be used (if at all).

---

<JS Replace Attack>
 code
 code
 id = code;
</JS Replace Attack>

- Used for: Actor, Class, Skill, Weapon, Armor, Enemy, State Notetags
- Determines the Replace Attack skill ID to use.
- Replace 'code' with JavaScript code to determine the skill ID to use.
- The 'id' variable is the skill ID that the character will use for the
  attack replacement.

---

<JS Replace Guard>
 code
 code
 id = code;
</JS Replace Guard>

- Used for: Actor, Class, Skill, Weapon, Armor, Enemy, State Notetags
- Determines the Replace Guard skill ID to use.
- Replace 'code' with JavaScript code to determine the skill ID to use.
- The 'id' variable is the skill ID that the character will use for the
  attack replacement.

---