Commands: Battlefield Conditions

Section 4.B.6

These are keys which trigger something to happen to the battlefield, such as changing weather or terrain, the effects that are in play, or even changing the backdrop.

"teamEffects" => Array

Changes the effects that are applied to one side of the field. This is entered as an array that must contain at least two items; the first item in the array must be the symbol of the specific effect you'd like to alter or apply, and the second item in the array must be the value you want to set this effect to. Optionally, you may enter a string as the third item in this array, which will display a custom message when applying this effect. For example, you may enter this as [:StickyWeb, true] to silently apply the Sticky Web effect to a team's side, or you could set something like [:Tailwind, 3, "A strong wind suddenly blew behind {1}!"] to set the Tailwind effect to 3 on a team's side and announce it to the player. You may even enter multiple different effects to be applied all at once if you want, by making an array of arrays, like this: [[:StealthRock, true], [:Spikes, 3], [:ToxicSpikes, 2, "{1} fell into a thorny trap!"]]

"fieldEffects" => Array

Changes the effects that are applied to the entire battlefield. This is entered as an array that must contain at least two items; the first item in the array must be the symbol of the specific effect you'd like to alter or apply, and the second item in the array must be the value you want to set this effect to. Optionally, you may enter a string as the third item in this array, which will display a custom message when applying this effect. For example, you may enter this as [:Gravity, 5] to silently apply the Gravity effect to the battlefield for 5 turns, or you could set something like [:PayDay, 1000, "Coins scattered everywhere!"] to set the Pay Day effect on the field, allowing the player to pick up an additional $1,000 at the end of the battle. You may even enter multiple different effects to be applied all at once if you want, by making an array of arrays, like this: [[:MagicRoom, 5], [:WonderRoom, 5], [:TrickRoom, 5, "The battlefield became topsy-turvy!"]]

"changeWeather" => Symbol

Changes the current battle weather. Set to a weather ID to change the weather to that weather type. If set to :Random, a random weather will be set. If set to :None, any currently active weather will be cleared. Note that while Primal weather can be set, those weather conditions are hardcoded to immediately end if a Pokemon with the corresponding Primal weather ability isn't on the field.

"changeTerrain" => Symbol

Changes the current battle terrain. Set to a terrain ID to change the terrain to that terrain type. If set to :Random, a random terrain will be set. If set to :None, any currently active terrain will be cleared.

"changeEnvironment" => Symbol

Changes the current battle environment. Set to an environment ID to change the environment to that environment type. If set to :Random, a random environment will be set. If set to :None, the current environment will be set to neutral (usually associated with indoor buildings or urban environments).

"changeBackdrop" => String or Array

Changes the battlefield background and/or bases. Set to a string to change the background and bases used in battle to match the one you entered. You may enter this as an array containing two different strings if you want to mix and match different backgrounds and bases. The first element of the array refers to the background, and the second refers to the bases. The strings you enter for either one only need to contain the root name of the file. For example, you may use "elite1" or "grass_night". You must omit the _bg or _base parts of the file name. It's also worth noting that changing the bases in battle may also automatically change the battle environment as well, depending on the type of base you have set. This happens independently of the "changeEnvironment" key, so this may override that key if you entered this one after it.

"changeDataboxes" => Symbol or Array

Changes the active databox style. Refer to the "databoxStyle" Battle Rule if you're unfamiliar with databox styles. Set to a databox style ID to change to that databox style during battle. This plugin only has two possible databox styles to select from by default; the :Basic and :Long styles.

If there is a databox style already active and you would like to remove this style so that battler databoxes return to normal, you can simply set this to nil instead.

For wild battles only, you can also set this as an array where the first item in the array is the databox style ID, and any additional items in the array are strings that will act as display titles to appear in each wild battler's databox. This can be used to update a wild Pokemon's title midbattle to indicate different boss phases, for example.