Difference between revisions of "Template:VisuMZ Skill Cooldowns Notetags"

From Yanfly.moe Wiki
Jump to navigation Jump to search
(Cooldown/Warmup Notetag Traits)
(JavaScript Notetags: Skill-Only)
 
(2 intermediate revisions by the same user not shown)
Line 103: Line 103:
 
- The 'skill' variable refers to the skill being used.
 
- The 'skill' variable refers to the skill being used.
 
- The 'turns' variable refers to the finalized cooldown value.
 
- The 'turns' variable refers to the finalized cooldown value.
 +
</pre>
 +
 +
---
 +
 +
<pre>
 +
<JS On Cooldown Update>
 +
code
 +
code
 +
code
 +
</JS On Cooldown Update>
 +
 +
- Used for: Skill Notetags
 +
- Replace 'code' with JavaScript code to perform various actions whenever
 +
  the skill's cooldown updates.
 +
- The 'user' variable refers to the user about to perform the skill.
 +
- The 'skill' variable refers to the skill being used.
 +
- The 'turns' variable refers to the finalized cooldown value.
 +
</pre>
 +
 +
---
 +
 +
<pre>
 +
<JS On Cooldown Ready>
 +
code
 +
code
 +
code
 +
</JS On Cooldown Ready>
 +
 +
- Used for: Skill Notetags
 +
- Replace 'code' with JavaScript code to perform various actions whenever
 +
  the skill's cooldown hits 0 and becomes ready.
 +
- The 'user' variable refers to the user about to perform the skill.
 +
- The 'skill' variable refers to the skill being used.
 
</pre>
 
</pre>
  
Line 110: Line 143:
  
 
<pre>
 
<pre>
<Warmup: x>
 
 
 
<JS Warmup>
 
<JS Warmup>
 
  code
 
  code
Line 124: Line 155:
 
- The 'skill' variable refers to the skill being used.
 
- The 'skill' variable refers to the skill being used.
 
- The 'turns' variable refers to the finalized warmup value.
 
- The 'turns' variable refers to the finalized warmup value.
 +
</pre>
 +
 +
---
 +
 +
<pre>
 +
<JS On Warmup Update>
 +
code
 +
code
 +
code
 +
</JS On Warmup Update>
 +
 +
- Used for: Skill Notetags
 +
- Replace 'code' with JavaScript code to perform various actions whenever
 +
  the skill's warmup updates.
 +
- The 'user' variable refers to the user about to perform the skill.
 +
- The 'skill' variable refers to the skill being used.
 +
- The 'turns' variable refers to the finalized warmup value.
 +
</pre>
 +
 +
---
 +
 +
<pre>
 +
<JS On Warmup Ready>
 +
code
 +
code
 +
code
 +
</JS On Warmup Ready>
 +
 +
- Used for: Skill Notetags
 +
- Replace 'code' with JavaScript code to perform various actions whenever
 +
  the skill's warmup hits 0 and becomes ready.
 +
- The 'user' variable refers to the user about to perform the skill.
 +
- The 'skill' variable refers to the skill being used.
 
</pre>
 
</pre>
  
Line 417: Line 481:
  
 
---
 
---
 +
 +
[[File:SkillCooldownsCD.png|600px]]
  
 
<pre>
 
<pre>
Line 427: Line 493:
  
 
---
 
---
 +
 +
[[File:SkillCooldownsWU.png|600px]]
  
 
<pre>
 
<pre>
Line 437: Line 505:
  
 
---
 
---
 +
 +
[[File:SkillCooldownsCD.png|600px]]
  
 
<pre>
 
<pre>
Line 495: Line 565:
  
 
---
 
---
 +
 +
[[File:SkillCooldownsWU.png|600px]]
  
 
<pre>
 
<pre>

Latest revision as of 19:00, 1 September 2020

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.

Skill-Only Notetags

SkillCooldownsCD.png

The following notetags are used for skills and are related to setting the primary uses of Cooldowns and Warmups.

---

<Bypass Cooldowns>
<Bypass Warmups>

- Used for: Skill Notetags
- Lets the skill bypass cooldowns and/or warmups.

---

<Cooldown: x>

- Used for: Skill Notetags
- The skill will gain a cooldown upon usage.
- Replace 'x' with the number of turns to set the cooldown to.

---

<Skill id Cooldown: x>
<Skill name Cooldown: x>

- Used for: Skill Notetags
- The skill will cause listed skills to gain a cooldown upon usage.
- Replace 'x' with the number of turns to set the cooldown to.
- Replace 'id' with the ID of the skill found in Database => Skills.
- Replace 'name' with the name of the skill found in Database => Skills.

---

<Stype id Cooldown: x>
<Stype name Cooldown: x>

- Used for: Skill Notetags
- The skill will cause all skills with the skill type to gain a cooldown
  upon usage.
- Replace 'x' with the number of turns to set the cooldown to.
- Replace 'id' with the ID of the skill type found in Database => Types.
- Replace 'name' with the name of the skill type found in Database => Types.

---

<Global Cooldown: x>

- Used for: Skill Notetags
- The skill will cause all skills to gain a cooldown upon usage.
- Replace 'x' with the number of turns to set the cooldown to.

---

SkillCooldownsWU.png

<Warmup: x>

- Used for: Skill Notetags
- The skill will gain a warmup upon the start of battle.
- Replace 'x' with the number of turns to set the warmup to.

---

JavaScript Notetags: Skill-Only

The following are notetags made for users with JavaScript knowledge to give skills dynamic cooldown or warmup durations.

---

SkillCooldownsCD.png

<JS Cooldown>
 code
 code
 turns = code
</JS Cooldown>

- Used for: Skill Notetags
- Replace 'code' with JavaScript code used to determine the base cooldown
  for this skill.
- The 'user' variable refers to the user about to perform the skill.
- The 'skill' variable refers to the skill being used.
- The 'turns' variable refers to the finalized cooldown value.

---

<JS On Cooldown Update>
 code
 code
 code
</JS On Cooldown Update>

- Used for: Skill Notetags
- Replace 'code' with JavaScript code to perform various actions whenever
  the skill's cooldown updates.
- The 'user' variable refers to the user about to perform the skill.
- The 'skill' variable refers to the skill being used.
- The 'turns' variable refers to the finalized cooldown value.

---

<JS On Cooldown Ready>
 code
 code
 code
</JS On Cooldown Ready>

- Used for: Skill Notetags
- Replace 'code' with JavaScript code to perform various actions whenever
  the skill's cooldown hits 0 and becomes ready.
- The 'user' variable refers to the user about to perform the skill.
- The 'skill' variable refers to the skill being used.

---

SkillCooldownsWU.png

<JS Warmup>
 code
 code
 turns = code
</JS Warmup>

- Used for: Skill Notetags
- Replace 'code' with JavaScript code used to determine the base warmup
  for this skill.
- The 'user' variable refers to the user about to perform the skill.
- The 'skill' variable refers to the skill being used.
- The 'turns' variable refers to the finalized warmup value.

---

<JS On Warmup Update>
 code
 code
 code
</JS On Warmup Update>

- Used for: Skill Notetags
- Replace 'code' with JavaScript code to perform various actions whenever
  the skill's warmup updates.
- The 'user' variable refers to the user about to perform the skill.
- The 'skill' variable refers to the skill being used.
- The 'turns' variable refers to the finalized warmup value.

---

<JS On Warmup Ready>
 code
 code
 code
</JS On Warmup Ready>

- Used for: Skill Notetags
- Replace 'code' with JavaScript code to perform various actions whenever
  the skill's warmup hits 0 and becomes ready.
- The 'user' variable refers to the user about to perform the skill.
- The 'skill' variable refers to the skill being used.

---

Cooldown/Warmup Notetag Traits

These Notetag Traits help modify the finalized value of a cooldown/warmup. The final cooldown/warmup duration is calculated by the following formula:

(base + plus) * rate + flat

The base value is the amount calculated through the <Cooldown: x> and <Warmup: x> notetags found in the section above.

---

SkillCooldownsCD.png

<Skill id Cooldown Plus: +x>
<Skill id Cooldown Plus: -x>

<Skill name Cooldown Plus: +x>
<Skill name Cooldown Plus: -x>

- Used for: Actor, Class, Item, Weapon, Armor, Enemy, State Notetags
- Affects specific cooldown changes towards this specific skill.
- Replace 'x' with the numeric value to change duration by.
- Replace 'id' with the ID of the skill found in Database => Skills.
- Replace 'name' with the name of the skill found in Database => Skills.

---

<Skill id Cooldown Rate: x%>
<Skill id Cooldown Rate: x.x>

<Skill name Cooldown Rate: x%>
<Skill name Cooldown Rate: x.x>

- Used for: Actor, Class, Item, Weapon, Armor, Enemy, State Notetags
- Affects specific cooldown changes towards this specific skill.
- Replace 'x' with the percentile value to change duration by.
- Replace 'x.x' with the float value to change duration by.
- Replace 'id' with the ID of the skill found in Database => Skills.
- Replace 'name' with the name of the skill found in Database => Skills.

---

<Skill id Cooldown Flat: +x>
<Skill id Cooldown Flat: -x>

<Skill name Cooldown Flat: +x>
<Skill name Cooldown Flat: -x>

- Used for: Actor, Class, Item, Weapon, Armor, Enemy, State Notetags
- Affects specific cooldown changes towards this specific skill.
- Replace 'x' with the numeric value to change duration by.
- Replace 'id' with the ID of the skill found in Database => Skills.
- Replace 'name' with the name of the skill found in Database => Skills.

---

<Stype id Cooldown Plus: +x>
<Stype id Cooldown Plus: -x>

<Stype name Cooldown Plus: +x>
<Stype name Cooldown Plus: -x>

- Used for: Actor, Class, Item, Weapon, Armor, Enemy, State Notetags
- Affects specific cooldown changes towards skills with this skill type.
- Replace 'x' with the numeric value to change duration by.
- Replace 'id' with the ID of the skill type found in Database => Types.
- Replace 'name' with the name of the skill type found in Database => Types.

---

<Stype id Cooldown Rate: x%>
<Stype id Cooldown Rate: x.x>

<Stype name Cooldown Rate: x%>
<Stype name Cooldown Rate: x.x>

- Used for: Actor, Class, Item, Weapon, Armor, Enemy, State Notetags
- Affects specific cooldown changes towards skills with this skill type.
- Replace 'x' with the percentile value to change duration by.
- Replace 'x.x' with the float value to change duration by.
- Replace 'id' with the ID of the skill type found in Database => Types.
- Replace 'name' with the name of the skill type found in Database => Types.

---

<Stype id Cooldown Flat: +x>
<Stype id Cooldown Flat: -x>

<Stype name Cooldown Flat: +x>
<Stype name Cooldown Flat: -x>

- Used for: Actor, Class, Item, Weapon, Armor, Enemy, State Notetags
- Affects specific cooldown changes towards skills with this skill type.
- Replace 'x' with the numeric value to change duration by.
- Replace 'id' with the ID of the skill type found in Database => Types.
- Replace 'name' with the name of the skill type found in Database => Types.

---

<Global Cooldown Plus: +x>
<Global Cooldown Plus: -x>

- Used for: Actor, Class, Item, Weapon, Armor, Enemy, State Notetags
- Affects specific cooldown changes towards all skills.
- Replace 'x' with the numeric value to change duration by.

---

<Global Cooldown Rate: x%>
<Global Cooldown Rate: x.x>

- Used for: Actor, Class, Item, Weapon, Armor, Enemy, State Notetags
- Affects specific cooldown changes towards all skills.
- Replace 'x' with the percentile value to change duration by.
- Replace 'x.x' with the float value to change duration by.

---

<Global Cooldown Flat: +x>
<Global Cooldown Flat: -x>

- Used for: Actor, Class, Item, Weapon, Armor, Enemy, State Notetags
- Affects specific cooldown changes towards all skills.
- Replace 'x' with the numeric value to change duration by.

---

SkillCooldownsWU.png

<Skill id Warmup Plus: +x>
<Skill id Warmup Plus: -x>

<Skill name Warmup Plus: +x>
<Skill name Warmup Plus: -x>

- Used for: Actor, Class, Item, Weapon, Armor, Enemy, State Notetags
- Affects specific warmup changes towards this specific skill.
- Replace 'x' with the numeric value to change duration by.
- Replace 'id' with the ID of the skill found in Database => Skills.
- Replace 'name' with the name of the skill found in Database => Skills.

---

<Skill id Warmup Rate: x%>
<Skill id Warmup Rate: x.x>

<Skill name Warmup Rate: x%>
<Skill name Warmup Rate: x.x>

- Used for: Actor, Class, Item, Weapon, Armor, Enemy, State Notetags
- Affects specific warmup changes towards this specific skill.
- Replace 'x' with the percentile value to change duration by.
- Replace 'x.x' with the float value to change duration by.
- Replace 'id' with the ID of the skill found in Database => Skills.
- Replace 'name' with the name of the skill found in Database => Skills.

---

<Skill id Warmup Flat: +x>
<Skill id Warmup Flat: -x>

<Skill name Warmup Flat: +x>
<Skill name Warmup Flat: -x>

- Used for: Actor, Class, Item, Weapon, Armor, Enemy, State Notetags
- Affects specific warmup changes towards this specific skill.
- Replace 'x' with the numeric value to change duration by.
- Replace 'id' with the ID of the skill found in Database => Skills.
- Replace 'name' with the name of the skill found in Database => Skills.

---

<Stype id Warmup Plus: +x>
<Stype id Warmup Plus: -x>

<Stype name Warmup Plus: +x>
<Stype name Warmup Plus: -x>

- Used for: Actor, Class, Item, Weapon, Armor, Enemy, State Notetags
- Affects specific warmup changes towards skills with this skill type.
- Replace 'x' with the numeric value to change duration by.
- Replace 'id' with the ID of the skill type found in Database => Types.
- Replace 'name' with the name of the skill type found in Database => Types.

---

<Stype id Warmup Rate: x%>
<Stype id Warmup Rate: x.x>

<Stype name Warmup Rate: x%>
<Stype name Warmup Rate: x.x>

- Used for: Actor, Class, Item, Weapon, Armor, Enemy, State Notetags
- Affects specific warmup changes towards skills with this skill type.
- Replace 'x' with the percentile value to change duration by.
- Replace 'x.x' with the float value to change duration by.
- Replace 'id' with the ID of the skill type found in Database => Types.
- Replace 'name' with the name of the skill type found in Database => Types.

---

<Stype id Warmup Flat: +x>
<Stype id Warmup Flat: -x>

<Stype name Warmup Flat: +x>
<Stype name Warmup Flat: -x>

- Used for: Actor, Class, Item, Weapon, Armor, Enemy, State Notetags
- Affects specific warmup changes towards skills with this skill type.
- Replace 'x' with the numeric value to change duration by.
- Replace 'id' with the ID of the skill type found in Database => Types.
- Replace 'name' with the name of the skill type found in Database => Types.

---

<Global Warmup Plus: +x>
<Global Warmup Plus: -x>

- Used for: Actor, Class, Item, Weapon, Armor, Enemy, State Notetags
- Affects specific warmup changes towards all skills.
- Replace 'x' with the numeric value to change duration by.

---

<Global Warmup Rate: x%>
<Global Warmup Rate: x.x>

- Used for: Actor, Class, Item, Weapon, Armor, Enemy, State Notetags
- Affects specific warmup changes towards all skills.
- Replace 'x' with the percentile value to change duration by.
- Replace 'x.x' with the float value to change duration by.

---

<Global Warmup Flat: +x>
<Global Warmup Flat: -x>

- Used for: Actor, Class, Item, Weapon, Armor, Enemy, State Notetags
- Affects specific warmup changes towards all skills.
- Replace 'x' with the numeric value to change duration by.

---

Cooldown/Warmup Notetag Actions

The following notetags are actively altering effects that target cooldowns and/or warmups. Cooldown effects may be applied at any moment through these while warmup effects will only affect skills on warmup currently.

---

SkillCooldownsCD.png

<Clear User Cooldowns>
<Clear Target Cooldowns>

- Used for: Skill, Item Notetags
- Clears all cooldowns for the user/target.

---

SkillCooldownsWU.png

<Clear User Warmups>
<Clear Target Warmups>

- Used for: Skill, Item Notetags
- Clears all warmups for the user/target.

---

SkillCooldownsCD.png

<User Skill id Cooldown: +x>
<User Skill id Cooldown: -x>

<User Skill name Cooldown: +x>
<User Skill name Cooldown: -x>

<Target Skill id Cooldown: +x>
<Target Skill id Cooldown: -x>

<Target Skill name Cooldown: +x>
<Target Skill name Cooldown: -x>

- Used for: Skill, Item Notetags
- Alters the user/target's cooldown duration for this specific skill.
- Replace 'x' with the amount to change the duration by.
- Replace 'id' with the ID of the skill found in Database => Skills.
- Replace 'name' with the name of the skill found in Database => Skills.

---

<User Stype id Cooldown: +x>
<User Stype id Cooldown: -x>

<User Stype name Cooldown: +x>
<User Stype name Cooldown: -x>

<Target Stype id Cooldown: +x>
<Target Stype id Cooldown: -x>

<Target Stype name Cooldown: +x>
<Target Stype name Cooldown: -x>

- Used for: Skill, Item Notetags
- Alters the user/target's cooldown duration for all skills with this type.
- Replace 'x' with the amount to change the duration by.
- Replace 'id' with the ID of the skill type found in Database => Types.
- Replace 'name' with the name of the skill type found in Database => Types.

---

<User Global Cooldown: +x>
<User Global Cooldown: -x>

<Target Global Cooldown: +x>
<Target Global Cooldown: -x>

- Used for: Skill, Item Notetags
- Alters the user/target's cooldown duration for all skills.
- Replace 'x' with the amount to change the duration by.

---

SkillCooldownsWU.png

<User Skill id Warmup: +x>
<User Skill id Warmup: -x>

<User Skill name Warmup: +x>
<User Skill name Warmup: -x>

<Target Skill id Warmup: +x>
<Target Skill id Warmup: -x>

<Target Skill name Warmup: +x>
<Target Skill name Warmup: -x>

- Used for: Skill, Item Notetags
- Alters the user/target's warmup duration for this specific skill.
- Replace 'x' with the amount to change the duration by.
- Replace 'id' with the ID of the skill found in Database => Skills.
- Replace 'name' with the name of the skill found in Database => Skills.
- NOTE: Warmup changes only apply to skills that are still in warmup.

---

<User Stype id Warmup: +x>
<User Stype id Warmup: -x>

<User Stype name Warmup: +x>
<User Stype name Warmup: -x>

<Target Stype id Warmup: +x>
<Target Stype id Warmup: -x>

<Target Stype name Warmup: +x>
<Target Stype name Warmup: -x>

- Used for: Skill, Item Notetags
- Alters the user/target's warmup duration for all skills with this type.
- Replace 'x' with the amount to change the duration by.
- Replace 'id' with the ID of the skill type found in Database => Types.
- Replace 'name' with the name of the skill type found in Database => Types.
- NOTE: Warmup changes only apply to skills that are still in warmup.

---

<User Global Warmup: +x>
<User Global Warmup: -x>

<Target Global Warmup: +x>
<Target Global Warmup: -x>

- Used for: Skill, Item Notetags
- Alters the user/target's warmup duration for all skills.
- Replace 'x' with the amount to change the duration by.
- NOTE: Warmup changes only apply to skills that are still in warmup.

---