Other environment objects¶

Effect¶

This module defines the Effect class, which represents in-game effects.

class poke_env.environment.effect.Effect¶

Bases: enum.Enum

Enumeration, represent an effect a Pokemon can be affected by.

AFTERMATH = 3¶

AFTER_YOU = 2¶

AQUA_RING = 4¶

AROMATHERAPY = 5¶

AROMA_VEIL = 6¶

ATTRACT = 7¶

AUTOTOMIZE = 8¶

BAD_DREAMS = 9¶

BANEFUL_BUNKER = 10¶

BATTLE_BOND = 11¶

BIDE = 12¶

BIND = 13¶

BURN_UP = 14¶

CELEBRATE = 15¶

CHARGE = 16¶

CLAMP = 17¶

CONFUSION = 18¶

COURT_CHANGE = 19¶

CRAFTY_SHIELD = 20¶

CURSE = 21¶

CUSTAP_BERRY = 22¶

DANCER = 23¶

DESTINY_BOND = 24¶

DISABLE = 25¶

DISGUISE = 26¶

DOOM_DESIRE = 27¶

DYNAMAX = 28¶

ELECTRIC_TERRAIN = 29¶

EMBARGO = 30¶

EMERGENCY_EXIT = 31¶

ENCORE = 32¶

ENDURE = 33¶

FAIRY_LOCK = 34¶

FEINT = 35¶

FIRE_SPIN = 36¶

FLASH_FIRE = 37¶

FLOWER_VEIL = 38¶

FOCUS_BAND = 39¶

FOCUS_ENERGY = 40¶

FORESIGHT = 41¶

FOREWARN = 42¶

FUTURE_SIGHT = 43¶

GRAVITY = 47¶

GRUDGE = 48¶

GUARD_SPLIT = 49¶

GULP_MISSILE = 50¶

G_MAX_CHI_STRIKE = 44¶

G_MAX_ONE_BLOW = 45¶

G_MAX_RAPID_FLOW = 46¶

HEALER = 53¶

HEAL_BELL = 51¶

HEAL_BLOCK = 52¶

HYDRATION = 54¶

HYPERSPACE_FURY = 55¶

HYPERSPACE_HOLE = 56¶

ICE_FACE = 57¶

ILLUSION = 58¶

IMMUNITY = 59¶

IMPRISON = 60¶

INFESTATION = 61¶

INGRAIN = 62¶

INNARDS_OUT = <class 'enum.auto'>¶

INSOMNIA = 63¶

IRON_BARBS = 64¶

LASER_FOCUS = 65¶

LEECH_SEED = 66¶

LIGHTNING_ROD = 67¶

LIMBER = 68¶

LOCK_ON = 69¶

MAGMA_STORM = 70¶

MAGNET_RISE = 71¶

MAGNITUDE = 72¶

MAT_BLOCK = 73¶

MAX_GUARD = 74¶

MIMIC = 75¶

MIMICRY = 76¶

MIND_READER = 77¶

MIRACLE_EYE = 78¶

MIST = 79¶

MISTY_TERRAIN = 80¶

MUMMY = 81¶

NEUTRALIZING_GAS = 82¶

NIGHTMARE = 83¶

NO_RETREAT = 84¶

OBLIVIOUS = 85¶

OCTOLOCK = 86¶

OWN_TEMPO = 87¶

PASTEL_VEIL = 88¶

PERISH0 = 89¶

PERISH1 = 90¶

PERISH2 = 91¶

PERISH3 = 92¶

PHANTOM_FORCE = 93¶

POLTERGEIST = 94¶

POWDER = 95¶

POWER_CONSTRUCT = 96¶

POWER_SPLIT = 97¶

POWER_TRICK = 98¶

PROTECT = 99¶

PROTECTIVE_PADS = 100¶

PSYCHIC_TERRAIN = 101¶

PURSUIT = 102¶

QUASH = 103¶

QUICK_CLAW = 104¶

QUICK_GUARD = 105¶

REFLECT = 106¶

ROUGH_SKIN = 107¶

SAFEGUARD = 108¶

SAFETY_GOGGLES = 109¶

SAND_TOMB = 110¶

SCREEN_CLEANER = 111¶

SHADOW_FORCE = 112¶

SHED_SKIN = 113¶

SKETCH = 114¶

SKILL_SWAP = 115¶

SKY_DROP = 116¶

SLOW_START = 117¶

SMACK_DOWN = 118¶

SNAP_TRAP = 119¶

SNATCH = 120¶

SPEED_SWAP = 121¶

SPITE = 122¶

STICKY_HOLD = 123¶

STICKY_WEB = 124¶

STOCKPILE = 125¶

STOCKPILE1 = 126¶

STOCKPILE2 = 127¶

STOCKPILE3 = 128¶

STORM_DRAIN = 129¶

STRUGGLE = 130¶

SUBSTITUTE = 131¶

SUCTION_CUPS = 132¶

SWEET_VEIL = 133¶

SYMBIOSIS = 134¶

SYNCHRONIZE = 135¶

TAR_SHOT = 136¶

TAUNT = 137¶

TELEKINESIS = 138¶

TELEPATHY = 139¶

THROAT_CHOP = 140¶

THUNDER_CAGE = 141¶

TORMENT = 142¶

TRAPPED = 143¶

TRICK = 144¶

TYPEADD = 145¶

TYPECHANGE = 146¶

TYPE_CHANGE = 147¶

UPROAR = 148¶

WANDERING_SPIRIT = 149¶

WATER_BUBBLE = 150¶

WATER_VEIL = 151¶

WHIRLPOOL = 152¶

WIDE_GUARD = 153¶

WIMP_OUT = 154¶

WRAP = 155¶

YAWN = 156¶

breaks_protect¶

Returns:	Wheter this effects breaks protect-like states.
Return type:	bool

from_showdown_message = <function Effect.from_showdown_message>¶

is_action_countable¶

Returns:	Wheter it is useful to keep track of the number of times this effect has been activated.
Return type:	bool

is_turn_countable¶

Returns:	Wheter it is useful to keep track of the number of turns this effect has been active for.
Return type:	bool

Field¶

This module defines the Field class, which represents a battle field.

class poke_env.environment.field.Field¶

Bases: enum.Enum

Enumeration, represent a non null field in a battle.

ELECTRIC_TERRAIN = 2¶

GRASSY_TERRAIN = 3¶

GRAVITY = 4¶

HEAL_BLOCK = 5¶

MAGIC_ROOM = 6¶

MISTY_TERRAIN = 7¶

MUD_SPORT = 8¶

MUD_SPOT = 9¶

PSYCHIC_TERRAIN = 10¶

TRICK_ROOM = 11¶

WATER_SPORT = 12¶

WONDER_ROOM = 13¶

from_showdown_message = <function Field.from_showdown_message>¶

Move category¶

This module defines the MoveCategory class, which represents a move category.

class poke_env.environment.move_category.MoveCategory¶

Bases: enum.Enum

Enumeration, represent a move category.

PHYSICAL = 1¶

SPECIAL = 2¶

STATUS = 3¶

Pokemon gender¶

This module defines the PokemonGender class, which represents the gender of a Pokemon.

class poke_env.environment.pokemon_gender.PokemonGender¶

Bases: enum.Enum

Enumeration, represent a pokemon’s gender.

FEMALE = 1¶

MALE = 2¶

NEUTRAL = 3¶

from_request_details = <function PokemonGender.from_request_details>¶

Pokemon Type¶

This module defines the PokemonType class, which represents a Pokemon type. PokemonTypes are mainly associated with Pokemons and moves.

class poke_env.environment.pokemon_type.PokemonType¶

Bases: enum.Enum

A Pokemon type

This enumeration represents pokemon types. Each type is an instance of this class, whose name corresponds to the upper case spelling of its english name (ie. FIRE).

BUG = 1¶

DARK = 2¶

DRAGON = 3¶

ELECTRIC = 4¶

FAIRY = 5¶

FIGHTING = 6¶

FIRE = 7¶

FLYING = 8¶

GHOST = 9¶

GRASS = 10¶

GROUND = 11¶

ICE = 12¶

NORMAL = 13¶

POISON = 14¶

PSYCHIC = 15¶

ROCK = 16¶

STEEL = 17¶

WATER = 18¶

damage_multiplier(type_1: poke_env.environment.pokemon_type.PokemonType, type_2: Optional[PokemonType] = None) → float¶

Computes the damage multiplier from this type on a pokemon with types type_1 and, optionally, type_2.

Parameters:	type_1 (PokemonType) – The first type of the target. type_2 (PokemonType, optional) – The second type of the target. Defaults to None.
Returns:	The damage multiplier from this type on a pokemon with types type_1 and, optionally, type_2.
Return type:	float

from_name = <function PokemonType.from_name>¶

Side condition¶

This module defines the SideCondition class, which represents a in-battle side condition.

class poke_env.environment.side_condition.SideCondition¶

Bases: enum.Enum

Enumeration, represent a in-battle side condition.

AURORA_VEIL = 2¶

FIRE_PLEDGE = 3¶

GRASS_PLEDGE = 9¶

G_MAX_CANNONADE = 4¶

G_MAX_STEELSURGE = 5¶

G_MAX_VINE_LASH = 6¶

G_MAX_VOLCALITH = 7¶

G_MAX_WILDFIRE = 8¶

LIGHT_SCREEN = 10¶

LUCKY_CHANT = 11¶

MIST = 12¶

REFLECT = 13¶

SAFEGUARD = 14¶

SPIKES = 15¶

STEALTH_ROCK = 16¶

STICKY_WEB = 17¶

TAILWIND = 18¶

TOXIC_SPIKES = 19¶

WATER_PLEDGE = 20¶

from_showdown_message = <function SideCondition.from_showdown_message>¶

Status¶

This module defines the Status class, which represents statuses a pokemon can be afflicted with.

class poke_env.environment.status.Status¶

Bases: enum.Enum

Enumeration, represent a status a pokemon can be afflicted with.

BRN = 1¶

FNT = 2¶

FRZ = 3¶

PAR = 4¶

PSN = 5¶

SLP = 6¶

TOX = 7¶

Weather¶

This module defines the Weather class, which represents a in-battle weather.

class poke_env.environment.weather.Weather¶

Bases: enum.Enum

Enumeration, represent a non null weather in a battle.

DELTASTREAM = 3¶

DESOLATELAND = 2¶

HAIL = 4¶

PRIMORDIALSEA = 5¶

RAINDANCE = 6¶

SANDSTORM = 7¶

SUNNYDAY = 8¶

from_showdown_message = <function Weather.from_showdown_message>¶

Z Crystal¶

This module contains objects related ot z-crystal management. It should not be used directly.