The pokemon object¶
-
class
poke_env.environment.pokemon.Pokemon(*, species: Optional[str] = None, request_pokemon: Optional[Dict[str, Any]] = None, details: Optional[str] = None)¶ Bases:
object-
ability¶ Returns: The pokemon’s ability. None if unknown. Return type: str, optional
-
active¶ Returns: Boolean indicating whether the pokemon is active. Return type: bool
-
available_z_moves¶ Caution: this property is not properly tested yet.
Returns: The set of moves that pokemon can use as z-moves. Return type: List[Move]
-
base_stats¶ Returns: The pokemon’s base stats. Return type: Dict[str, int]
-
boosts¶ Returns: The pokemon’s boosts. Return type: Dict[str, int]
-
current_hp¶ Returns: The pokemon’s current hp. For your pokemons, this is the actual value. For opponent’s pokemon, this value depends on showdown information: it can be on a scale from 0 to 100 or on a pixel scale. Return type: int
-
current_hp_fraction¶ Returns: The pokemon’s current remaining hp fraction. Return type: float
-
damage_multiplier(type_or_move: Union[poke_env.environment.pokemon_type.PokemonType, poke_env.environment.move.Move]) → float¶ Returns the damage multiplier associated with a given type or move on this pokemon.
This method is a shortcut for PokemonType.damage_multiplier with relevant types.
Parameters: type_or_move (PokemonType or Move) – The type or move of interest. Returns: The damage multiplier associated with given type on the pokemon. Return type: float
-
effects¶ Returns: A dict mapping the effects currently affecting the pokemon and the associated counter. Return type: Dict[Effect, int]
-
fainted¶ Returns: Wheter the pokemon has fainted. Return type: bool
-
first_turn¶ Returns: Wheter this is this pokemon’s first action since its last switch in. Return type: bool
-
gender¶ Returns: The pokemon’s gender. Return type: PokemonGender, optional
-
height¶ Returns: The pokemon’s height, in meters. Return type: float
-
is_dynamaxed¶ Returns: Whether the pokemon is currently dynamaxed Return type: bool
-
item¶ Returns: The pokemon’s item. Return type: Optional[str]
-
level¶ Returns: The pokemon’s level. Return type: int
-
max_hp¶ Returns: The pokemon’s max hp. For your pokemons, this is the actual value. For opponent’s pokemon, this value depends on showdown information: it can be on a scale from 0 to 100 or on a pixel scale. Return type: int
-
must_recharge¶ Returns: A boolean indicating whether the pokemon must recharge. Return type: bool
-
pokeball¶ Returns: The pokeball in which is the pokemon. Return type: Optional[str]
-
possible_abilities¶ Returns: The list of possible abilities for this pokemon. Return type: List[str]
-
preparing¶ Returns: Whether this pokemon is preparing a multi-turn move. Return type: bool
-
protect_counter¶ Returns: How many protect-like moves where used in a row by this pokemon. Return type: int
-
revealed¶ Returns: Whether this pokemon has appeared in the current battle. Return type: bool
-
shiny¶ Returns: Whether this pokemon is shiny. Return type: bool
-
species¶ Returns: The pokemon’s species. Return type: Optional[str]
-
stats¶ Returns: The pokemon’s stats, as a dictionary. Return type: Dict[str, Optional[int]]
-
status_counter¶ Returns: The pokemon’s status turn count. Only counts TOXIC and SLEEP statuses. Return type: int
-
type_1¶ Returns: The pokemon’s first type. Return type: PokemonType
-
type_2¶ Returns: The pokemon’s second type. Return type: Optional[PokemonType]
-
types¶ Returns: The pokemon’s types, as a tuple. Return type: Tuple[PokemonType, Optional[PokemonType]]
-
weight¶ Returns: The pokemon’s weight, in kilograms. Return type: float
-