SOS: Battle Rules

Section 7.B.3

This plugin adds additional battle rules related to the SOS mechanic.

"SOSBattle"

This rule enables all wild Pokemon in this battle to perform SOS calls, even if the species normally has a call rate of zero, or if the SOS mechanic has been disabled. This can be used to set specific encounters to use the SOS mechanic, even if that species would typically be unable to use it. This is entered as setBattleRule("SOSBattle")

"noSOSBattle"

This rule disables the SOS mechanic from being triggered in this battle by all wild Pokemon. This can be used toggle the feature off for certain encounters, even if the species would normally be able to use SOS calls. This is entered as setBattleRule("noSOSBattle")

"totemBattle"

This rule flags the wild Pokemon encountered in this battle as a Totem Pokemon, and the battle will operate under Totem Battle rules. When this rule is enabled, the "SOSBattle", "cannotRun" and "disablePokeBalls" Battle Rules are also enabled, regardless of however you may have set them. This is entered as setBattleRule("totemBattle", true), but you may further customize this if you wish by entering an array instead of true as the second argument. In this array, you can include the specific stat ID's and stages to set which specific aura boost the Totem Pokemon should receive at the start of the battle

For example, if you set [:DEFENSE, 2], then the Totem Pokemon's aura will grant it +2 Defense at the start of the battle. If you enter [:ATTACK, 1, :SPEED, 1], then the Totem Pokemon's aura will grant it +1 Attack and +1 Speed.

If no stats are set and this argument is just left as true, then the Totem Pokemon's aura will grant it a +1 omni boost to all stats by default.

"setSOSPokemon"

This rule replaces the species that the wild Pokemon would usually call via SOS. You can use this if you want to set a unique SOS call for the wild Pokemon in this battle that is a species that it normally wouldn't call. Keep in mind that this will replace any of the species that this Pokemon would naturally call, so any species that are assigned to it in its PBS data will be ignored. For Totem Battles specifically, this rule is used to set the first species the Totem Pokemon calls during battle.

This is entered as setBattleRule("setSOSPokemon", Species) where "Species" can be any species ID you want the wild Pokemon to call. If you set this to a hash instead, you can customize the called Pokemon's attributes. For example:

setBattleRule("setSOSPokemon", {
  :species => :URSARING,
  :level   => 35,
  :name    => "Big Mama",
  :gender  => 1,
  :shiny   => true
})

This would replace the wild Pokemon's normal SOS call with a level 35 Ursaring named "Big Mama" which is always female and always shiny. The specific data which may be set in this hash is identical to the data that may be set with the "editWildPokemon" rule found in the "Deluxe Battle Rules" section of this tutorial.

"addSOSPokemon"

This rule adds another species that the wild Pokemon may call via SOS. Unlike the "setSOSPokemon" rule above, this rule doesn't replace any of the normal species the wild Pokemon may call, it simply adds an additional species to their list of potential calls that may be rolled for. This additional species will be considered a "rare" spawn, so it will be included in that 15% roll that is used for all additional "rare" SOS calls. For Totem Battles specifically, this rule is used to set the second species the Totem Pokemon calls during battle.

This is entered as setBattleRule("addSOSPokemon", Species) where "Species" can be any species ID you want the wild Pokemon to call. If you set this to a hash instead, you can customize the called Pokemon's attributes. How this hash is set up is identical to how it's set up in the "setSOSPokemon" rule.