Template:VisuMZ Chain Battles Plugin Commands

From Yanfly.moe Wiki
Revision as of 13:57, 12 July 2023 by Irina (talk | contribs) (Next Victory Plugin Commands)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

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

---

Chain Battle Plugin Commands

ChainBattles Preview1.png

---

ChainBattles Command1.png

Chain Battle: Queue Troop ID(s)
- Setup the next Troop ID as a part of a chain battle.
- If there are multiple, one will be randomly picked.

  Troop ID(s):
  - Select which Troop ID(s) to register as the next potential battle.

  Change Battleback?:
  - Change the battlebacks for this queued battle?

    Battleback 1:
    Battleback 2:
    - Filename used for the battleback image.
    - Leave empty if you don't wish to use one.

---

ChainBattles Command2.png

Chain Battle: Queue Encounter Pool
- Setup the next battle from the random encounter pool.
- If there are multiple, one will be randomly picked.

  Change Battleback?:
  - Change the battlebacks for this queued battle?

    Battleback 1:
    Battleback 2:
    - Filename used for the battleback image.
    - Leave empty if you don't wish to use one.

---

ChainBattles Command3.png

Chain Battle: Queue JavaScript ID
- Use JavaScript to determine which Troop ID to queue up for a chain battle.

  JS: Troop ID:
  - Use JavaScript code to determine what Troop ID to queue up for a
    chain battle.

  Change Battleback?:
  - Change the battlebacks for this queued battle?

    Battleback 1:
    Battleback 2:
    - Filename used for the battleback image.
    - Leave empty if you don't wish to use one.

---

ChainBattles Command4.png

Chain Battle: Clear Chains
- Clears any stored Chain Battles, allowing the battle to end after
the current one.

---

Next Victory Plugin Commands

---

ChainBattles Update02 Command1.png

Next Victory: Queue Common Event
- Queue a Common Event(s) to run next victory.
- If multiple, Common Events run in queued order.
- The Common Events will run before the next queued chain battle.

  Common Event ID(s):
  - Select which Common Event(s) to run upon the next victory.
  - If multiple, Common Events run in queued order.

  - The "Next Victory: Queue Common Event" Plugin Command will always refer
    to the immediate next victory sequence.
    - Even if you put it after a "Chain Battle: Queue Troop ID(s)", it does
      not mean it will occur for that next queued troop's victory.
    - Instead, the common event will run for the immediate next victory
      sequence regardless.
    - If you would like for the queued troop ID's to have a "Next Victory"
      effect, run this Plugin Command AFTER the queued troop ID has been
      initiated in battle first.

  - If enemies revive in the middle of the Common Event queue, the queue is
    paused and resumed after the enemies are defeated once again.
    - For example:
    - Common Events A, B, C, D, E are queued.
    - Enemies are set to revive on Common Event B.
    - When the player achieves battle victory, Common Events A and B run.
    - The enemies will revive.
    - The player has to defeat the enemies again.
    - Once the enemies are defeated, Common Events C, D, and E then run.
    - Afterwards, any chain battles will occur.

---

ChainBattles Update02 Command2.png

Next Victory: Clear Common Event Queue
- Clear queued Common Event(s) for next victory.

---