Difference between revisions of "Template:VisuMZ Button Common Events Notetags"

From Yanfly.moe Wiki
Jump to navigation Jump to search
(Created page with "<noinclude>VisuMZ Button Common Events Notetags</noinclude> The following are notetags that have been added through this plugin. These notetags...")
 
(Assign Button-Related Notetags)
 
Line 50: Line 50:
 
   <Assign Button Slot: A, S, D, F>
 
   <Assign Button Slot: A, S, D, F>
 
   <Assign Button Slot: 1, 2, 3, 4, 5, 6, 7, 8, 9, 0>
 
   <Assign Button Slot: 1, 2, 3, 4, 5, 6, 7, 8, 9, 0>
 +
</pre>
 +
 +
---
 +
 +
<pre>
 +
<Assign Button Show Cost>
 +
 +
- Used for: Skill Notetags
 +
- If a skill can be assigned, show the cost of the skill if it has one.
 +
- Using this assigned button will not pay the cost. If you want to the pay
 +
  the cost, use the following notetag.
 +
</pre>
 +
 +
---
 +
 +
<pre>
 +
<Assign Button Pay Cost>
 +
 +
- Used for: Skill Notetags
 +
- If a skill can be assigned, show the cost of the skill if it has one and
 +
  pays the cost when pressed and activated.
 +
  - If the cost cannot be paid, due to lacking resources or other reasons,
 +
    then the button will be disabled.
 +
- The actor that will pay the cost will be the actor that the button was
 +
  assigned from in the first place.
 +
  - As such, if the actor is not in the party, this will also be disabled.
 +
</pre>
 +
 +
---
 +
 +
<pre>
 +
<Assign Button Show Quantity>
 +
 +
- Used for: Item, Weapon, Armor Notetags
 +
- If an item, weapon, or armor can be assigned, show the quantity of the
 +
  party has of that item, weapon, or armor.
 +
- Using this assigned button will not consume the item, weapon, or armor.
 +
  If you want to consume the quantity, use the following notetag.
 +
</pre>
 +
 +
---
 +
 +
<pre>
 +
<Assign Button Consume Quantity>
 +
 +
- Used for: Item, Weapon, Armor Notetags
 +
- If an item, weapon, or armor can be assigned, show the quantity of the
 +
  party has of that item, weapon, or armor. This will also consume one of
 +
  the item, weapon, or armor when pressed.
 +
  - This also applies to Key Items. If you don't want Key Items to be
 +
    consumed but have their quantity displayed, use the previous notetag.
 +
  - If the cost cannot be paid, due to lacking resources or other reasons,
 +
    then the button will be disabled.
 
</pre>
 
</pre>
  
 
---
 
---

Latest revision as of 15:35, 14 February 2024

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.

---

Assign Button-Related Notetags

ButtonCommonEvents Update19 Feature.png

---

<Assign Button Common Event: id>

- Used for: Skill, Item, Weapon, Armor Notetags
- Makes this object selectable in the Item scene or Skill scene and have it
  become assignable to a button slot.
- If the object is originally usable (ie a Healing Potion or Healing Spell),
  the button assignment process will take priority and override it.
- Replace 'id' with a number representing the ID of the Common Event you
  wish to assign to a button.
- This needs to be used together with the <Assign Button Slots: x, x, x>
  notetag in order to have any effect.

---

ButtonCommonEvents Update19 Feature.png

<Assign Button Slot: x>
<Assign Button Slot: x, x, x>

- Used for: Skill, Item, Weapon, Armor Notetags
- Lists the keyboard keys that can be assigned a Common Event when pressed.
- If the object is originally usable (ie a Healing Potion or Healing Spell),
  the button assignment process will take priority and override it.
- Replace 'x' with a number or letter representing the button you wish to
  assign a Common Event to.
- This needs to be used together with the <Assign Button Common Event: id>
  notetag in order to have any effect.
- The choices that become available will be listed in the order found in
  this notetag.
- Forbidden, non-existent, and non-valid keys will be filtered out of this
  list and cannot be assigned a Common Event.

  Example:

  <Assign Button Slot: A, S, D, F>
  <Assign Button Slot: 1, 2, 3, 4, 5, 6, 7, 8, 9, 0>

---

<Assign Button Show Cost>

- Used for: Skill Notetags
- If a skill can be assigned, show the cost of the skill if it has one.
- Using this assigned button will not pay the cost. If you want to the pay
  the cost, use the following notetag.

---

<Assign Button Pay Cost>

- Used for: Skill Notetags
- If a skill can be assigned, show the cost of the skill if it has one and
  pays the cost when pressed and activated.
  - If the cost cannot be paid, due to lacking resources or other reasons,
    then the button will be disabled.
- The actor that will pay the cost will be the actor that the button was
  assigned from in the first place.
  - As such, if the actor is not in the party, this will also be disabled.

---

<Assign Button Show Quantity>

- Used for: Item, Weapon, Armor Notetags
- If an item, weapon, or armor can be assigned, show the quantity of the
  party has of that item, weapon, or armor.
- Using this assigned button will not consume the item, weapon, or armor.
  If you want to consume the quantity, use the following notetag.

---

<Assign Button Consume Quantity>

- Used for: Item, Weapon, Armor Notetags
- If an item, weapon, or armor can be assigned, show the quantity of the
  party has of that item, weapon, or armor. This will also consume one of
  the item, weapon, or armor when pressed.
  - This also applies to Key Items. If you don't want Key Items to be
    consumed but have their quantity displayed, use the previous notetag.
  - If the cost cannot be paid, due to lacking resources or other reasons,
    then the button will be disabled.

---