This plugin builds upon the Deluxe Battle Kit to add raid battle functionality. Raid battles were first introduced in Pokemon Sword & Shield as Max Raid Battles which featured battle challenges vs wild Dynamax Pokemon who had expanded HP pools and other unique mechanics such as raid shields. This has since become a staple of the mainline series, though each iteration adds a new twist to the mechanic, such as Tera Raid battles in Pokemon Scarlet & Violet.
The goal of this plugin is to implement the core functionality that allows you to set up your own raid battles. While this plugin does support both Max Raid and Tera Raid variants, it isn't required that you feature the Dynamax or Terastallization mechanics in your game. This plugin is capable of setting up a generic raid battle variant that implements general raid battle mechanics, but without tying it to any specific generational battle mechanic. So you're free to use this plugin to set up raid-style boss encounters even without those specific mechanics present.
Raid Battle Types
By default, this plugin supports up to four different raid battle variants, depending on what type of mechanics are featured in your game.
Basic Raid Battles
These are generic raid battles that borrow mechanics from both Max Raid and Tera Raid battles featured in the main series, but without any specific generational battle gimmicks attached to them. In these raids, you're pitted against wild Pokemon that have expanded HP pools and a variety of special mechanics that make them more challenging than your average wild Pokemon.
While in a Basic Raid, no trainer is able to use Z-Moves, Ultra Burst, Dynamax, or Terastallization.
You can set up Basic Raid battles right out of the box, without any other supported plugins required.
Max Raid Battles
These are raid battles inspired by Max Raid battles featured in Pokemon Sword & Shield. In these raids, you're pitted against wild Dynamax or Gigantamax Pokemon that have expanded HP pools and utilize the power of Dynamax to launch powerful Max Moves or G-Max Moves against you. Pokemon encountered in Max Raids will always be in Eternamax form if they have one, such as Eternatus.
While in a Max Raid, no trainer is able to use Mega Evolution, Z-Moves, Ultra Burst, or Terastallization.
The Dynamax add-on plugin is required if you wish to set up Max Raid battles.
Tera Raid Battles
These are raid battles inspired by Tera Raid battles featured in Pokemon Scarlet & Violet. In these raids, you're pitted against wild Terastallized Pokemon that have expanded HP pools and utilize the power of Terastallization to change their typing and launch Tera-boosted moves against you. Pokemon encountered in Tera Raids will always be in Terastal form if they have one, such as Ogerpon and Terapagos.
While in a Tera Raid, no trainer is able to use Mega Evolution, Z-Moves, Ultra Burst, or Dynamax.
The Terastallization add-on plugin is required if you wish to set up Tera Raid battles.
Ultra Raid Battles
These are raid battles totally unique to this plugin that imagine what raid battles would have been in the Gen 7 games, if they were included in Pokemon Sun & Moon. In these raids, you're pitted against wild Pokemon holding Z-Crystals that have expanded HP pools and utilize Z-Power to launch powerful Z-Moves against you. Pokemon encountered in Ultra Raids will always be in Ultra Burst form if they have one, such as Necrozma.
While in an Ultra Raid, no trainer is able to use Mega Evolution, Dynamax, or Terastallization.
The Z-Power add-on plugin is required if you wish to set up Ultra Raid battles.
Raid Battle Count
Essentials internally keeps track of a variety of the player's game statistics. I've added trackers which will keep count of various statistics related to raid battles, too.
Below are all of the new statistics tracked by this plugin, and how to call them.
Raid Battle victories
This plugin keeps count of how many times the player has defeated or captured a wild raid Pokemon in any type of raid battle. This can be called with the script $stats.raid_battles_won.
Raid Dens cleared
This plugin keeps count of how many times the player has cleared a Raid Den by either capturing or defeating the wild raid Pokemon within it. This can be called with the script $stats.raid_dens_cleared.
Online Raid Dens cleared
This plugin keeps count of how many times the player has cleared a distributed online Raid Den event by either capturing or defeating the wild raid Pokemon within it. This can be called with the script $stats.online_raid_dens_cleared.