Raid: Properties

Section 7.C.1

Various new properties are added by this plugin in order to establish the basic foundation for raid battles. The two fundamental properties are Raid Types - which determine the overall characteristics of raids, and Raid Ranks - which determine the difficulty levels of individual raids, what species are eligible to encounter, and the attributes those Pokemon may have when encountered.

These two things are what form the basis of what the rest of the plugin builds upon. Below, I'll go into detail about both properties.

Raid Types

This plugin offers a variety of different types of raid battle styles to participate in. These are defined in the RaidType class within the GameData module in the plugin scripts. This is where all of the specifics of each raid type is stored, such as the specific music, battle text, and background visuals that are used for that specific type of raid.

By default, this plugin includes the following types of raids:

  • Basic Raids

  • Ultra Raids (only available when the Z-Power add-on is installed)

  • Max Raids (only available when the Dynamax add-on is installed)

  • Tera Raids (only available when the Terastallization add-on is installed)

Basic Raids are always available for anyone who installs this plugin. However, the others may require additional add-on plugins to be present in order to be used.

Below, I'll go into detail about all of the defined properties for a raid type.

General Properties

  • :id Sets the ID associated with this raid type.

  • :name This sets the name associated with this raid type. This typically isn't used for gameplay purposes, and is mostly used for debug and dev functions.

  • :available This sets whether a specific type of raid should be available to the player. This should always be set to true. For Ultra, Max, and Tera raids in particular; this may be set to false instead if the required add-on plugins for those raid types are not installed.

Battle Properties

  • :battle_bg This sets the file name of the background image that is displayed during a specific type of raid battle. These graphics are located in Graphics/Battlebacks. Note that this shouldn't contain the full name of the graphic file, it should only contain the portion of the filename that appears before the first underscore. For example, you only need to include "cave3" here, not "cave3_bg".

  • :battle_base This sets the file name of the graphics used as the battler bases during a specific type of raid battle. These graphics are located in Graphics/Battlebacks. Note that this shouldn't contain the full name of the graphic file, it should only contain the portion of the filename that appears before the first underscore. For example, you only need to include "cave3" here, not "cave3_base0".

  • :battle_environ This sets the environment used during a specific type of raid battle. This can be set to any environment ID. By default, all raid battles use the :Cave environment. However, Ultra Raids in particular use the :UltraSpace environment, instead.

  • :battle_text This sets the intro text that is displayed when encountering a wild Pokemon in a specific type of raid battle. This will replace the usual "A wild Pokemon appeared!" text. Note that despite whatever is entered here, you can still always manually override this text with the "battleIntroText" battle rule.

  • :battle_flee This sets the text that is displayed if the raid Pokemon flees from a specific type of raid battle, which may happen if you fail or refuse to capture the raid Pokemon after defeating it. This will replace the usual "Pokemon fled!" text. Note that most types of raids use identical text for this, but you may want to customize this for different types of raids.

  • :battle_bgm This sets the BGM that should play during a specific type of raid battle. Note that this is an array containing the name of at least two music files. The first file is the track that plays during most raid battles of a selected type, while the second file is the track that plays specifically during 7-star raids of a selected type. Some types of raids may have a third track entered here that plays during very specific encounters.

  • :capture_bgm This sets the BGM that should play during the capture sequence of a specific type of raid battle. This track will begin to play when the raid Pokemon has been defeated, and you are prompted to capture it.

Overworld Properties

  • :den_name This sets the display name used on Raid Den entry screens for this specific type of raid.

  • :den_sprite This sets the name of the graphic used for Raid Dens of this specific type of raid in the overworld. These graphics are located in Graphics/Characters.

  • :den_size This sets how large a Raid Den will be on the overworld map. The number set here determines the number of tiles it will take up both in length and width. For example, when set to 2, this means the event will take up 2x2 tiles worth of space.

  • :lair_bgm This sets the BGM that should play while exploring the map during a Raid Adventure.

Raid Ranks

A raid's rank is simply the number of stars that raid has, which generally indicates the overall difficulty level of the raid. A raid's rank can range between 1-7 stars, with 1 being the easiest and 7 being the hardest.

The rank of a raid also determines which species can naturally be found in that raid. Generally speaking, weak and unevolved species such as Caterpie and Magikarp will typically be found in lower ranked raids such as ranks 1-2, while stronger evolved species will be found in higher ranks such as ranks 3-5. For the purposes of this plugin, rank 6 raids are reserved specifically for Legendary and Mythical species, as well as things like Ultra Beasts and Paradox species.

Rank 7 raids are the hardest difficulty raids. Unlike the other raid ranks, no species are naturally found in these raids, because it's already assumed that any species can appear in a rank 7 raid. I'll go into more detail on this when covering raid battles and dens elsewhere in this guide.

Assigning Raid Ranks Per Species

The raid ranks a species can be naturally found in is manually assigned in the PBS data for each species and form. Each species can appear in up to a maximum of three different raid ranks. For example, here are the raid ranks this plugin assigns to the Bulbasaur line by default:

#-------------------------------
[BULBASAUR]
...
RaidRanks = 1,2,3
#-------------------------------
[IVYSAUR]
...
RaidRanks = 3,4
#-------------------------------
[VENUSAUR]
...
RaidRanks = 4,5

For each species, the RaidRanks property is set to an array of numbers. The numbers indicate which raid ranks that particular species may appear in. In Bulbasaur's case, it can appear in raids with 1-3 stars. Ivysaur can appear in raids with 3-4 stars, while Venusaur only appears in 4-5 star raids.

Each species can only appear in up to three different raid ranks, so if you add additional ranks beyond three, the rest will be ignored. No species can be set to exclusively appear in 7-star raids, so if you add rank 7 to a species' RaidRanks, it will be ignored. Typically, you can only assign a species to appear in 1-6 star raids. However, this plugin reserves 6-star raids for Legendary and Mythical species by default, so keep that in mind when assigning raid ranks.

Species Eligibility

If a species has no assigned RaidRanks data, it will be assumed that this species is banned from appearing in raid battles entirely, and thus will not appear in any raids. The same is true if you assign a species rank data as RaidRanks = 0. If you do not wish for a species or form to appear in raid battles for any reason, you can either set their RaidRanks to 0, or omit the line altogether.

By default, several species such as Shedinja and Smeargle are banned from appearing in raids due to not having any RaidRanks data set. Many species that have awkward gimmicks that aren't suitable for raid battles fall into this category.

Form Eligibility

Unlike with most other species PBS data, any forms of a species will not naturally inherit the same RaidRanks as its base form. If you want a specific form of a species to be eligible to naturally appear as raid bosses, you must give them their own RaidRanks data in the same manner as you would with the base species.

The form of a species doesn't need to have the same RaidRanks data as its base form, however. For example, base Rotom has RaidRanks = 3,4 set in its PBS data, while all of its forms have RaidRanks = 4,5 set instead. It's even possible to make it so that the base form of a species doesn't appear in raid battles at all, but one of its forms do.

If no RaidRanks data is set for a form, that form will be considered banned from appearing in raid battles in the same way as base species. By default, most forms are banned from raids by default due to being battle-only forms, or forms that are naturally decided upon when the Pokemon is first created. However, genuine variants of a species, such as regional forms, are given their own RaidRanks data by this plugin by default.

Raid Eligibility Per Raid Type

Each type of raid may have further specifications that determine which species may appear in them. If you want to flag a certain species so that it may only appear in certain types of raids, but be banned from others, you can do so by setting the RaidStyle property.

#-------------------------------
[BULBASAUR]
...
RaidRanks = 1,2,3
RaidStyle = Basic,Tera

In this example, Bulbasar is given the RaidStyle property. This is set to an array with the symbols Basic and Tera, meaning that Bulbasaur may appear in 1-3 star Basic Raids and 1-3 star Tera Raids. However, Bulbasaur will be completely banned from appearing in any Max Raids or Ultra Raids. You may use this property if you'd like to limit what sort of raids a species may appear in. If the RaidStyle property is not set, it will just always be assumed that the species is eligible for any type of raid.

Here are all of the possible raid type symbols that may be set in the RaidStyle property:

  • Basic

  • Max

  • Tera

  • Ultra

In addition to this setting, each raid type is hardcoded to ban certain species or forms. Below, I'll list all of the species that will be automatically disqualified from appearing in each type of raid.

Basic Raids The following species or forms are hardcoded to always be banned from all Basic Raids, even if they would otherwise be eligible to appear in a specific raid rank:

  • All Ultra Burst forms of a species.

  • All Gigantamax forms of a species.

  • All Eternamax forms of a species.

  • All Terastal forms of a species.

Max Raids The following species or forms are hardcoded to always be banned from all Max Raids, even if they would otherwise be eligible to appear in a specific raid rank:

  • All Mega Evolved forms of a species.

  • All Primal forms of a species.

  • All Ultra Burst forms of a species.

  • All Terastal forms of a species.

  • The base form of any species that have an Eternamax form. For example, Eternamax Eternatus can appear in Max Raids, but not base Eternatus.

  • All species with the "CannotDynamax" flag, such as Zacian and Zamazenta.

Tera Raids The following species or forms are hardcoded to always be banned from all Tera Raids, even if they would otherwise be eligible to appear in a specific raid rank:

  • All Mega Evolved forms of a species.

  • All Primal forms of a species.

  • All Ultra Burst forms of a species.

  • All Gigantamax forms of a species.

  • All Eternamax forms of a species.

  • The base form of any species that have a Terastal form. For example, Stellar Terapagos can appear in Tera Raids, but not base Terapagos.

  • All species with the "CannotTerastallize" flag.

Ultra Raids The following species or forms are hardcoded to always be banned from all Ultra Raids, even if they would otherwise be eligible to appear in a specific raid rank:

  • All Mega Evolved forms of a species.

  • All Primal forms of a species.

  • All Gigantamax forms of a species.

  • All Eternamax forms of a species.

  • All Terastal forms of a species.

  • The base forms of any species that have an Ultra Burst form. For example, Ultra Necrozma can appear in Ultra Raids, but not base Necrozma or its fused forms.

PreviousRaid BattlesNextRaid: Battle Call

Last updated

Was this helpful?