The move object

class poke_env.battle.move.DynamaxMove(parent: Move)

Bases: Move

BOOSTS_MAP = {PokemonType.BUG: {'spa': -1}, PokemonType.DARK: {'spd': -1}, PokemonType.DRAGON: {'atk': -1}, PokemonType.GHOST: {'def': -1}, PokemonType.NORMAL: {'spe': -1}}

SELF_BOOSTS_MAP = {PokemonType.FIGHTING: {'atk': 1}, PokemonType.FLYING: {'spe': 1}, PokemonType.GROUND: {'spd': 1}, PokemonType.POISON: {'spa': 1}, PokemonType.STEEL: {'def': 1}}

TERRAIN_MAP = {PokemonType.ELECTRIC: Field.ELECTRIC_TERRAIN, PokemonType.FAIRY: Field.MISTY_TERRAIN, PokemonType.GRASS: Field.GRASSY_TERRAIN, PokemonType.PSYCHIC: Field.PSYCHIC_TERRAIN}

WEATHER_MAP = {PokemonType.FIRE: Weather.SUNNYDAY, PokemonType.ICE: Weather.HAIL, PokemonType.ROCK: Weather.SANDSTORM, PokemonType.WATER: Weather.RAINDANCE}

property accuracy

Returns:: The move’s accuracy (0 to 1 scale).
Return type:: float

property base_power: int

Returns:: The move’s base power.
Return type:: int

property boosts: Dict[str, int] | None

Returns:: Boosts conferred to the target by using the move.
Return type:: Dict[str, float] | None

property breaks_protect

Returns:: Whether the move breaks proect-like defenses.
Return type:: bool

property crit_ratio

Returns:: The move’s crit ratio. If the move is guaranteed to crit, returns 6.
Return type:

property damage

Returns:: The move’s fix damages. Can be an int or ‘level’ for moves such as Seismic Toss.
Return type:: Union[int, str]

property defensive_category

Returns:: Move’s defender category.
Return type:: MoveCategory

property expected_hits

Returns:: Expected number of hits, between 1 and 5. Equal to n_hits if n_hits is constant.
Return type:: float

property force_switch

Returns:: Whether this move forces switches.
Return type:: bool

property heal

Returns:: Proportion of the user’s HP recovered.
Return type:: float

property is_protect_counter

Returns:: Wheter this move increments a mon’s protect counter.
Return type:: int

property is_protect_move

Returns:: Wheter this move is a protect-like move.
Return type:: int

property n_hit

Returns:: How many hits this move lands. Tuple of the form (min, max).
Return type:: Tuple

property priority

Returns:: Move priority.
Return type:: int

property recoil

Returns:: Proportion of the move’s damage inflicted as recoil.
Return type:: float

property self_boost: Dict[str, int] | None

Returns:: Boosts applied to the move’s user.
Return type:: Dict[str, int]

property status

Returns:: The status inflicted by the move.
Return type:: Optional[Status]

property terrain: Field | None

Returns:: Terrain started by the move.
Return type:: Optional[Field]

property weather: Weather | None

Returns:: Weather started by the move.
Return type:: Optional[Weather]

class poke_env.battle.move.Move(move_id: str, gen: int, raw_id: str | None = None, from_mimic: bool = False, from_transform: bool = False)

Bases: object

property accuracy: float

Returns:: The move’s accuracy (0 to 1 scale).
Return type:: float

property base_power: int

Returns:: The move’s base power.
Return type:: int

property boosts: Dict[str, int] | None

Returns:: Boosts conferred to the target by using the move.
Return type:: Dict[str, float] | None

property breaks_protect: bool

Returns:: Whether the move breaks proect-like defenses.
Return type:: bool

property can_z_move: bool

Returns:: Wheter there exist a z-move version of this move.
Return type:: bool

property category: MoveCategory

Returns:: The move category.
Return type:: MoveCategory

property crit_ratio: int

Returns:: The move’s crit ratio. If the move is guaranteed to crit, returns 6.
Return type:

property current_pp: int

Returns:: Remaining PP.
Return type:: int

property damage: int | str

Returns:: The move’s fix damages. Can be an int or ‘level’ for moves such as Seismic Toss.
Return type:: Union[int, str]

property deduced_target: Target | None

Returns:: Move deduced target, based on Move.target and showdown’s request messages.
Return type:: Optional[Target]

property defensive_category: MoveCategory

Returns:: Move’s defender category.
Return type:: MoveCategory

property drain: float

Returns:: Ratio of HP of inflicted damages, between 0 and 1.
Return type:: float

property dynamaxed

Returns:: The dynamaxed version of the move.
Return type:: DynamaxMove

property entry: Dict[str, Any]

Should not be used directly.

Returns:: The data entry corresponding to the move
Return type:: Dict

property expected_hits: float

Returns:: Expected number of hits, between 1 and 5. Equal to n_hits if n_hits is constant.
Return type:: float

property flags: Set[str]

This property is not well defined, and may be missing some information. If you need more information on some flag, please open an issue in the project.

Returns:: Flags associated with this move. These can come from the data or be custom.
Return type:: Set[str]

property force_switch: bool

Returns:: Whether this move forces switches.
Return type:: bool

property gen: int

Returns:: The generation of the move.
Return type:: int

property heal: float

Returns:: Proportion of the user’s HP recovered.
Return type:: float

property id: str

Returns:: Move id.
Return type:: str

property ignore_ability: bool

Returns:: Whether the move ignore its target’s ability.
Return type:: bool

property ignore_defensive: bool

Returns:: Whether the opponent’s stat boosts are ignored.
Return type:: bool

property ignore_evasion: bool

Returns:: Wheter the opponent’s evasion is ignored.
Return type:: bool

property ignore_immunity: bool | Set[PokemonType]

Returns:: Whether the opponent’s immunity is ignored, or a list of ignored immunities.
Return type:: bool or set of Types

static is_id_z(id_: str, gen: int) → bool

property is_last_used: bool

static is_max_move(id_: str, gen: int) → bool

property is_protect_counter: bool

Returns:: Wheter this move increments a mon’s protect counter.
Return type:: int

property is_protect_move: bool

Returns:: Wheter this move is a protect-like move.
Return type:: int

property is_side_protect_move: bool

Returns:: Wheter this move is a side-protect move.
Return type:: int

property is_z: bool

Returns:: Whether the move is a z move.
Return type:: bool

property max_pp: int

Returns:: The move’s max pp.
Return type:: int

property n_hit: Tuple[int, int]

Returns:: How many hits this move lands. Tuple of the form (min, max).
Return type:: Tuple

property no_pp_boosts: bool

Returns:: Whether the move uses PPs.
Return type:: bool

property non_ghost_target: bool

Returns:: True for curse.
Return type:: bool

property priority: int

Returns:: Move priority.
Return type:: int

property pseudo_weather: str | None

Returns:: Pseudo-weather activated by this move.
Return type:: str

property recoil: float

Returns:: Proportion of the move’s damage inflicted as recoil.
Return type:: float

property request_target: Target | None

Returns:: Target information sent by showdown in a request message, if any.
Return type:: Optional[Target]

static retrieve_id(move_name: str) → str

Retrieve the id of a move based on its full name.

Parameters:: move_name (str) – The string to convert into a move id.
Returns:: The corresponding move id.
Return type:: str

property secondary: List[Dict[str, Any]]

Returns:: Secondary effects. At this point, the precise content of this property is not too clear.
Return type:: Optional[Dict]

property self_boost: Dict[str, int] | None

Returns:: Boosts applied to the move’s user.
Return type:: Dict[str, int]

property self_destruct: str | None

Returns:: Move’s self destruct consequences.
Return type:: str | None

property self_switch: str | bool

Returns:: What kind of self swtich this move implies for the user.
Return type:: str | None

static should_be_stored(move_id: str, gen: int) → bool

property side_condition: SideCondition | None

Returns:: Side condition inflicted by the move.
Return type:: SideCondition | None

property sleep_usable: bool

Returns:: Whether the move can be user by a sleeping pokemon.
Return type:: bool

property slot_condition: str | None

Returns:: Which slot condition is started by this move.
Return type:: str | None

property stalling_move: bool

Returns:: Showdown classification of the move as a stalling move.
Return type:: bool

property status: Status | None

Returns:: The status inflicted by the move.
Return type:: Optional[Status]

property steals_boosts: bool

Returns:: Whether the move steals its target’s boosts.
Return type:: bool

property target: Target | None

Returns:: Target of the move
Return type:: Optional[Target]

property terrain: Field | None

Returns:: Terrain started by the move.
Return type:: Optional[Field]

property thaws_target: bool

Returns:: Whether the move thaws its target.
Return type:: bool

property type: PokemonType

Returns:: Move type.
Return type:: PokemonType

use(pressure: bool = False, overridden: bool = False)

property use_target_offensive: bool

Returns:: Whether the move uses the target’s offensive statistics.
Return type:: bool

property volatile_status: Effect | None

Returns:: Volatile status inflicted by the move.
Return type:: Effect | None

property weather: Weather | None

Returns:: Weather started by the move.
Return type:: Optional[Weather]

property z_move_boost: Dict[str, int] | None

Returns:: Boosts associated with the z-move version of this move.
Return type:: Dict[str, int]

property z_move_effect: str | None

Returns:: Effects associated with the z-move version of this move.
Return type:: str | None

property z_move_power: int

Returns:: Base power of the z-move version of this move.
Return type:: int

class poke_env.battle.move.MoveSet(_base_moves: dict[str, Move], _mimic_move: Move | None = None, _transform_moves: MoveSet | None = None)

Bases: object

Container for a pokemon’s moves, including Mimic and Transform overrides.

property base_moves: dict[str, Move]

Returns:: The resolved base move dictionary without Mimic substitution.
Return type:: dict[str, Move]

property mimic_move: Move | None

Returns:: The move currently copied by Mimic, if any.
Return type:: Move | None

property moves: dict[str, Move]

Returns:: The resolved move dictionary with Mimic substitution applied.
Return type:: dict[str, Move]