Class: PFM::PokemonBattler

Overview

Class defining a Pokemon during a battle, it aim to copy its properties but also to have the methods related to the battle.

Defined Under Namespace

Classes: DamageHistory, MoveHistory, StatHistory, SuccessfulMoveHistory

Constant Summary collapse

COPIED_PROPERTIES =

List of properties to copy

%i[@id @form @given_name @code @ability @nature @iv_hp @iv_atk @iv_dfe @iv_spd @iv_ats @iv_dfs @ev_hp @ev_atk @ev_dfe @ev_spd @ev_ats @ev_dfs @trainer_id @trainer_name @step_remaining @loyalty @exp @hp @status @status_count @item_holding @captured_with @captured_in @captured_at @captured_level @gender @skill_learnt @ribbons @title_ribbon @character @exp_rate @hp_rate @egg_at @egg_in @evolve_var @pokerus]
TRANSFORM_COPIED_PROPERTIES =

List of properties to copy with transform

%i[@id @form @nature @ev_hp @ev_atk @ev_dfe @ev_spd @ev_ats @ev_dfs]
TRANSFORM_BP_METHODS =

List of @battle_properties to copy with transform

%i[ability weight height type1 type2 gender shiny atk_basis dfe_basis ats_basis dfs_basis spd_basis atk_stage dfe_stage ats_stage dfs_stage spd_stage]
TRANSFORM_SETTER_CACHE =

Setter cache for the Transform properties to write

TRANSFORM_BP_METHODS.to_h { |key| [key, :"#{key}="] }
ILLUSION_COPIED_PROPERTIES =

List of properties to copy with Illusion

%i[@id @form @gender @given_name @code @captured_with]
BACK_PROPERTIES =

List of properties to copy back to original

%i[@id @form @trainer_id @trainer_name @step_remaining @loyalty @hp @status @status_count @item_holding @captured_with @captured_in @captured_at @captured_level @gender @character @hp_rate @evolve_var @pokerus]
ABILITIES_IGNORING_ABILITIES =

List of abilities that ignore abilities

%i[mold_breaker teravolt turboblaze]
MOVES_IGNORING_ABILITIES =

List of moves that ignore abilities

%i[sunsteel_strike moongeist_beam photon_geyser]
ILLUSION_PROOF_SCENES =

List of the UIs able to omit the Illusion form of the Pokemon

Returns:

  • (Array<Class>)
[GamePlay::Party_Menu, GamePlay::Summary]
MIN_STAGE =

Minimal value of the stat modifier level (stage)

-6
# Maximal value of the stat modifier level (stage)
MAX_STAGE =

Maximal value of the stat modifier level (stage)

6

Constants inherited from Pokemon

PFM::Pokemon::ABILITY_CHANCES, PFM::Pokemon::ArceusItem, PFM::Pokemon::BATTLER_SIZE, PFM::Pokemon::EGG_FILENAMES, PFM::Pokemon::FLAG_CAUGHT_BY_PLAYER, PFM::Pokemon::FLAG_FROM_THIS_GAME, PFM::Pokemon::FLAG_PRESENT_TIME, PFM::Pokemon::FLAG_UNKOWN_USE, PFM::Pokemon::FOOT_SIZE, PFM::Pokemon::FORM_CALIBRATE, PFM::Pokemon::FORM_GENERATION, PFM::Pokemon::G_FORM, PFM::Pokemon::G_GR, PFM::Pokemon::G_ID, PFM::Pokemon::G_MOVE, PFM::Pokemon::G_NV, PFM::Pokemon::G_OBJ, PFM::Pokemon::G_SHINY, PFM::Pokemon::G_STAT, PFM::Pokemon::GenesectModules, PFM::Pokemon::ICON_SIZE, PFM::Pokemon::OGERPONMASK, PFM::Pokemon::SPECIAL_EVOLUTION_ID, PFM::Pokemon::Shiny_IV, PFM::Pokemon::SilvallyROM

Instance Attribute Summary collapse

Attributes inherited from Pokemon

#ability_index, #ability_used, #attack_order, #battle_stage, #beauty, #captured_at, #captured_in, #captured_level, #character, #cleverness, #confuse, #coolness, #critical_modifier, #cuteness, #egg_at, #egg_how_obtained, #egg_in, #ev_atk, #ev_ats, #ev_dfe, #ev_dfs, #ev_hp, #ev_spd, #evolve_var, #exp, #exp_rate, #game_code, #hp, #hp_rate, #item_holding, #iv_atk, #iv_ats, #iv_dfe, #iv_dfs, #iv_hp, #iv_spd, #level, #loyalty, #memo_text, #nature, #pokerus, #prepared_skill, #ribbons, #sheen, #skill_learnt, #skills_set, #status, #status_count, #step_remaining, #sub_code, #sub_form, #sub_id, #title_ribbon, #toughness, #trainer_id, #trainer_name, #unbound

Instance Method Summary collapse

Methods inherited from Pokemon

#ability_descr, #ability_name, #absofusion, #absofusionned?, #add_bonus, #add_ev_atk, #add_ev_ats, #add_ev_dfe, #add_ev_dfs, #add_ev_hp, #add_ev_spd, add_evolution_criteria, #add_ribbon, #adjust_hp_to_max_hp, #alive?, #asleep?, back_filename, back_gif_filename, #ball_color, #ball_image, #ball_sprite, #base_atk, #base_ats, #base_dfe, #base_dfs, #base_exp, #base_spd, #battle_list, #battler_back, #battler_face, #burn?, #calyrex_form, #can_be_asleep?, #can_be_burn?, #can_be_frozen?, #can_be_paralyzed?, #can_be_poisoned?, #can_learn?, #can_learn_skill_at_this_level?, #can_mega_evolve?, #captured_zone_name, #castform_form, #caught_by_player?, #character_name, #check_skill_and_learn, #cherrim_form, #contest_conditions, #cramorant_form, #cure, #current_deerling_form, #data, #db_symbol, #dead?, #decrease_hoopa_days, #decrease_pokerus_days, #dv_modifier, #edit_bonus, #egg?, #egg_finish, #egg_init, #egg_zone_name, #elv_1000steps, #elv_1percent, #elv_99percent, #elv_annihilape, #elv_armulys, #elv_basculin, #elv_blindalys, #elv_demanta, #elv_gimmighoul, #elv_kapoera, #elv_kicklee, #elv_kingambit, #elv_nymphali, #elv_pandarbare, #elv_sepiatroce, #elv_sirfetchd, #elv_toxtricity_amped, #elv_toxtricity_low_key, #elv_tygnon, #elv_ursaring, #encode, #ev_atk_text, #ev_ats_text, #ev_check, #ev_dfe_text, #ev_dfs_text, #ev_hp_text, #ev_modifier, #ev_spd_text, #ev_var, #evolution_condition_function?, #evolve, #evolve_check, #exp_list, #exp_lvl, #exp_remaining_text, #exp_text, #exp_type, #female?, #find_skill, #flags, #flags=, #flavor_disliked?, #flavor_liked?, #forget_skill, #form_calibrate, #form_generation, #form_name, #form_name_upper, #from_past?, #from_player?, front_filename, front_gif_filename, #front_offset_y, #frozen?, #fully_heal, #genderless?, generate_from_hash, #get_dv_value, #gif_back, #gif_face, #given_name_with_title, #handle_gimmighoul_post_evolution_event, #handle_item_removing_post_evolution_event, #handle_post_evolution_events, #hoopa_form, #hoopa_unbound?, #hp_pokemon_number, #hp_text, #icon, icon_filename, #id_text, #id_text2, #id_text3, #increase_evolve_var, #infect_with_pokerus, #item_hold, #item_name, #iv_atk_text, #iv_ats_text, #iv_dfe_text, #iv_dfs_text, #iv_hp_text, #iv_spd_text, #kami_form, #kyurem_form, #learn_skill, #level_pokemon_number, #level_text, #level_text2, #level_up, #level_up_stat_refresh, #level_up_window_call, #load_skill_from_array, #male?, #max_hp, #max_level, #max_level=, #mega_evolve, #mega_evolved?, missing_resources_error, #modifier_stage, #name_upper, #nature_db_symbol, #nature_text, #necrozma_form, #no_preferences?, #paralyzed?, #poisoned?, #pokerus_affected?, #pokerus_check?, #pokerus_cured?, #pokerus_infected?, #pokerus_remaining_days, #pokerus_strain, #primal_evolve, #primary_data, #remindable_skills, #remove_ribbon, #replace_skill_index, #reset_evolve_var, #ribbon?, #separate, #shaymin_form, #shiny=, #shiny?, #shiny_rate, #single_type?, #skill_learnt?, #sleep_check, #status?, #status_burn, #status_frozen, #status_paralyze, #status_poison, #status_sleep, #status_toxic, #swap_skills_index, #third_type?, #title?, #total_ev, #toxic?, #trainer_id_text, #type?, #type_bug?, #type_dark?, #type_dragon?, #type_electric?, #type_fairy?, #type_fighting?, #type_fire?, #type_flying?, #type_ghost?, #type_grass?, #type_ground?, #type_ice?, #type_normal?, #type_poison?, #type_psychic?, #type_rock?, #type_steel?, #type_water?, #unmega_evolve, #update_ability, #zone_id, #zygarde_form

Methods included from PFM::Pokemon::ShedinjaSpecialEvolutionCase

#evolve

Constructor Details

#initialize(original, scene, max_level = Float::INFINITY) ⇒ PokemonBattler

Create a new PokemonBattler from a Pokemon rubocop:disable Lint/MissingSuper rubocop:disable Metrics/MethodLength

Parameters:

  • original (PFM::Pokemon) —

    original Pokemon (protected during the battle)

  • scene (Battle::Scene) —

    current battle scene

  • max_level (Integer) (defaults to: Float::INFINITY) —

    new max level for Online battle



101
102
# File 'docs/5_Battle_03_PokemonBattler.rb', line 101

def initialize(original, scene, max_level = Float::INFINITY)
end

Instance Attribute Details

#bag ⇒ PFM::Bag

Get the bag of the battler

Returns:



62
63
64
# File 'docs/5_Battle_03_PokemonBattler.rb', line 62

def bag
  @bag
end

#bank ⇒ Integer

Returns Bank where the Pokemon is supposed to be.

Returns:

  • (Integer) —

    Bank where the Pokemon is supposed to be



34
35
36
# File 'docs/5_Battle_03_PokemonBattler.rb', line 34

def bank
  @bank
end

#battle_item ⇒ Integer

Get the item held during battle

Returns:

  • (Integer)


68
69
70
# File 'docs/5_Battle_03_PokemonBattler.rb', line 68

def battle_item
  @battle_item
end

#battle_item_data ⇒ Array (readonly)

Get the data associated to the item if needed

Returns:

  • (Array)


71
72
73
# File 'docs/5_Battle_03_PokemonBattler.rb', line 71

def battle_item_data
  @battle_item_data
end

#consumed_item ⇒ Symbol

Returns the symbol of the consumed item.

Returns:

  • (Symbol) —

    the symbol of the consumed item



81
82
83
# File 'docs/5_Battle_03_PokemonBattler.rb', line 81

def consumed_item
  @consumed_item
end

#damage_history ⇒ Array<DamageHistory> (readonly)

Get the damage history

Returns:



47
48
49
# File 'docs/5_Battle_03_PokemonBattler.rb', line 47

def damage_history
  @damage_history
end

#effects ⇒ Battle::Effects::EffectsHandler (readonly)

Get the effect handler



723
724
725
# File 'docs/5_Battle_03_PokemonBattler.rb', line 723

def effects
  @effects
end

#encounter_list ⇒ Array<PFM::PokemonBattler> (readonly)

Get the encounter list

Returns:



56
57
58
# File 'docs/5_Battle_03_PokemonBattler.rb', line 56

def encounter_list
  @encounter_list
end

#exp_distributed ⇒ Boolean

Tell if the Pokemon already distributed its experience during the battle

Returns:

  • (Boolean)


65
66
67
# File 'docs/5_Battle_03_PokemonBattler.rb', line 65

def exp_distributed
  @exp_distributed
end

#has_just_shifted ⇒ Boolean

If the Pokemon has shifted this turn

Returns:

  • (Boolean)


94
95
96
# File 'docs/5_Battle_03_PokemonBattler.rb', line 94

def has_just_shifted
  @has_just_shifted
end

#illusion ⇒ PFM::PokemonBattler?

Get the Illusion pokemon

Returns:



91
92
93
# File 'docs/5_Battle_03_PokemonBattler.rb', line 91

def illusion
  @illusion
end

#is_follower ⇒ Boolean

Get the information if the Pokemon is actually a follower or not (changing its go-in-out animation)

Returns:

  • (Boolean)


59
60
61
# File 'docs/5_Battle_03_PokemonBattler.rb', line 59

def is_follower
  @is_follower
end

#item_consumed ⇒ Boolean

Tell if the Pokemon has its item consumed

Returns:

  • (Boolean)


79
80
81
# File 'docs/5_Battle_03_PokemonBattler.rb', line 79

def item_consumed
  @item_consumed
end

#ko_count ⇒ Integer

Returns number of times the pokémon has been knocked out.

Returns:

  • (Integer) —

    number of times the pokémon has been knocked out



83
84
85
# File 'docs/5_Battle_03_PokemonBattler.rb', line 83

def ko_count
  @ko_count
end

#last_battle_turn ⇒ Integer

Last turn the Pokemon fought

Returns:

  • (Integer)


23
24
25
# File 'docs/5_Battle_03_PokemonBattler.rb', line 23

def last_battle_turn
  @last_battle_turn
end

#last_hit_by_move ⇒ Battle::Move

Returns last move that hit the pokemon.

Returns:



28
29
30
# File 'docs/5_Battle_03_PokemonBattler.rb', line 28

def last_hit_by_move
  @last_hit_by_move
end

#last_sent_turn ⇒ Integer

Last turn the pokemon was sent out

Returns:

  • (Integer)


26
27
28
# File 'docs/5_Battle_03_PokemonBattler.rb', line 26

def last_sent_turn
  @last_sent_turn
end

#mimic_move ⇒ Array<Battle::Move, Integer>

Mimic move that was replace by another move with its index

Returns:



76
77
78
# File 'docs/5_Battle_03_PokemonBattler.rb', line 76

def mimic_move
  @mimic_move
end

#move_history ⇒ Array<MoveHistory> (readonly)

Get the move history

Returns:



44
45
46
# File 'docs/5_Battle_03_PokemonBattler.rb', line 44

def move_history
  @move_history
end

#moveset ⇒ Array<Battle::Move> (readonly)

Returns the moveset of the Pokemon.

Returns:



17
18
19
# File 'docs/5_Battle_03_PokemonBattler.rb', line 17

def moveset
  @moveset
end

#original ⇒ PFM::Pokemon (readonly)

Get the original Pokemon

Returns:



41
42
43
# File 'docs/5_Battle_03_PokemonBattler.rb', line 41

def original
  @original
end

#party_id ⇒ Integer

Returns the ID of the party that control the Pokemon in the bank.

Returns:

  • (Integer) —

    the ID of the party that control the Pokemon in the bank



32
33
34
# File 'docs/5_Battle_03_PokemonBattler.rb', line 32

def party_id
  @party_id
end

#place_in_party ⇒ Integer

Returns Place in the team of the Pokemon.

Returns:

  • (Integer) —

    Place in the team of the Pokemon



38
39
40
# File 'docs/5_Battle_03_PokemonBattler.rb', line 38

def place_in_party
  @place_in_party
end

#position ⇒ Integer

Returns Position of the Pokemon in the bank.

Returns:

  • (Integer) —

    Position of the Pokemon in the bank



36
37
38
# File 'docs/5_Battle_03_PokemonBattler.rb', line 36

def position
  @position
end

#sleep_turns ⇒ Integer

Returns number of turns the Pokémon has been asleep.

Returns:

  • (Integer) —

    number of turns the Pokémon has been asleep



85
86
87
# File 'docs/5_Battle_03_PokemonBattler.rb', line 85

def sleep_turns
  @sleep_turns
end

#stat_history ⇒ Array<StatHistory> (readonly)

Get the stat history

Returns:



53
54
55
# File 'docs/5_Battle_03_PokemonBattler.rb', line 53

def stat_history
  @stat_history
end

#successful_move_history ⇒ Array<SuccessfulMoveHistory> (readonly)

Get the successful move history

Returns:



50
51
52
# File 'docs/5_Battle_03_PokemonBattler.rb', line 50

def successful_move_history
  @successful_move_history
end

#switching=(value) ⇒ Boolean (writeonly)

Returns set switching state.

Returns:

  • (Boolean) —

    set switching state



73
74
75
# File 'docs/5_Battle_03_PokemonBattler.rb', line 73

def switching=(value)
  @switching = value
end

#transform ⇒ PFM::PokemonBattler?

Get the transform pokemon

Returns:



88
89
90
# File 'docs/5_Battle_03_PokemonBattler.rb', line 88

def transform
  @transform
end

#turn_count ⇒ Integer Also known as: battle_turns

Returns number of turn the Pokemon is in battle.

Returns:

  • (Integer) —

    number of turn the Pokemon is in battle



19
20
21
# File 'docs/5_Battle_03_PokemonBattler.rb', line 19

def turn_count
  @turn_count
end

#type3 ⇒ Integer

Return the battler's combat property

Returns:

  • (Integer)


30
31
32
# File 'docs/5_Battle_03_PokemonBattler.rb', line 30

def type3
  @type3
end

Instance Method Details

#ability ⇒ Integer

Return the battler's combat property

Returns:

  • (Integer)


448
449
# File 'docs/5_Battle_03_PokemonBattler.rb', line 448

def ability
end

#ability=(value)

Set the battler's combat property

Parameters:

  • value (Integer)


452
453
# File 'docs/5_Battle_03_PokemonBattler.rb', line 452

def ability=(value)
end

#ability_db_symbol ⇒ Symbol

Return the db_symbol of the current ability of the Pokemon

Returns:

  • (Symbol)


122
123
# File 'docs/5_Battle_03_PokemonBattler.rb', line 122

def ability_db_symbol
end

#ability_effect ⇒ Battle::Effects::Ability

Get the ability effect



730
731
# File 'docs/5_Battle_03_PokemonBattler.rb', line 730

def ability_effect
end

#acc_stage ⇒ Integer

Return the accuracy stage

Returns:

  • (Integer)


608
609
# File 'docs/5_Battle_03_PokemonBattler.rb', line 608

def acc_stage
end

#acc_stage=(value) ⇒ Integer

Set the acc stage

Parameters:

  • value (Integer) —

    the new value of the stat stage

Returns:

  • (Integer) —

    the new stat stage value



670
671
# File 'docs/5_Battle_03_PokemonBattler.rb', line 670

def acc_stage=(value)
end

#add_battler_to_encounter_list(battler)

Note:

The battler is not added if it is already present in the list

Add a battler to the encounter list

Parameters:



186
187
# File 'docs/5_Battle_03_PokemonBattler.rb', line 186

def add_battler_to_encounter_list(battler)
end

#add_damage_to_history(damage, launcher, move, ko)

Note:

This method should only be used for successful damages!!!

Add a damage to the damage history

Parameters:



167
168
# File 'docs/5_Battle_03_PokemonBattler.rb', line 167

def add_damage_to_history(damage, launcher, move, ko)
end

#add_move_to_history(move, targets)

Add a move to the move history

Parameters:



159
160
# File 'docs/5_Battle_03_PokemonBattler.rb', line 159

def add_move_to_history(move, targets)
end

#add_stat_to_history(stat, power, target, launcher, move)

Add a stat to the stat history

Parameters:

  • stat (Symbol) —

    :atk, :dfe, :spd, :ats, :dfs, :acc, :eva

  • power (Integer) —

    power of the stat change

  • target (PFM::PokemonBattler) —

    target of the stat change

  • launcher (PFM::PokemonBattler, nil) —

    launcher of the stat change

  • move (Battle::Move, nil) —

    move that cause the stat change



181
182
# File 'docs/5_Battle_03_PokemonBattler.rb', line 181

def add_stat_to_history(stat, power, target, launcher, move)
end

#add_successful_move_to_history(move, targets)

Note:

This method should only be used for successful moves!!!

Add a successful move to the successful move history

Parameters:



173
174
# File 'docs/5_Battle_03_PokemonBattler.rb', line 173

def add_successful_move_to_history(move, targets)
end

#affected_by_terrain? ⇒ Boolean

Is the pokemon affected by the terrain ?

Returns:

  • (Boolean)


273
274
# File 'docs/5_Battle_03_PokemonBattler.rb', line 273

def affected_by_terrain?
end

#apply_flinch

Apply the flinch effect



262
263
# File 'docs/5_Battle_03_PokemonBattler.rb', line 262

def apply_flinch(*)
end

#atk ⇒ Integer

Return the current atk

Returns:

  • (Integer)


544
545
# File 'docs/5_Battle_03_PokemonBattler.rb', line 544

def atk
end

#atk_basis ⇒ Integer

Return the battler's combat property

Returns:

  • (Integer)


382
383
# File 'docs/5_Battle_03_PokemonBattler.rb', line 382

def atk_basis
end

#atk_basis=(value)

Set the battler's combat property

Parameters:

  • value (Integer)


386
387
# File 'docs/5_Battle_03_PokemonBattler.rb', line 386

def atk_basis=(value)
end

#atk_modifier ⇒ Float

Return the atk modifier

Returns:

  • (Float) —

    the multiplier



564
565
# File 'docs/5_Battle_03_PokemonBattler.rb', line 564

def atk_modifier
end

#atk_stage ⇒ Integer

Return the atk stage

Returns:

  • (Integer)


584
585
# File 'docs/5_Battle_03_PokemonBattler.rb', line 584

def atk_stage
end

#atk_stage=(value) ⇒ Integer

Set the atk stage

Parameters:

  • value (Integer) —

    the new value of the stat stage

Returns:

  • (Integer) —

    the new stat stage value



680
681
# File 'docs/5_Battle_03_PokemonBattler.rb', line 680

def atk_stage=(value)
end

#ats ⇒ Integer

Return the current ats

Returns:

  • (Integer)


556
557
# File 'docs/5_Battle_03_PokemonBattler.rb', line 556

def ats
end

#ats_basis ⇒ Integer

Return the battler's combat property

Returns:

  • (Integer)


393
394
# File 'docs/5_Battle_03_PokemonBattler.rb', line 393

def ats_basis
end

#ats_basis=(value)

Set the battler's combat property

Parameters:

  • value (Integer)


397
398
# File 'docs/5_Battle_03_PokemonBattler.rb', line 397

def ats_basis=(value)
end

#ats_modifier ⇒ Float

Return the ats modifier

Returns:

  • (Float) —

    the multiplier



576
577
# File 'docs/5_Battle_03_PokemonBattler.rb', line 576

def ats_modifier
end

#ats_stage ⇒ Integer

Return the ats stage

Returns:

  • (Integer)


596
597
# File 'docs/5_Battle_03_PokemonBattler.rb', line 596

def ats_stage
end

#ats_stage=(value) ⇒ Integer

Set the ats stage

Parameters:

  • value (Integer) —

    the new value of the stat stage

Returns:

  • (Integer) —

    the new stat stage value



685
686
# File 'docs/5_Battle_03_PokemonBattler.rb', line 685

def ats_stage=(value)
end

#base_hp ⇒ Integer

Return the base HP

Returns:

  • (Integer)


241
242
# File 'docs/5_Battle_03_PokemonBattler.rb', line 241

def base_hp
end

#battle_ability_db_symbol ⇒ Symbol

Return the db_symbol of the current ability of the Pokemon for battle

Returns:

  • (Symbol)


126
127
# File 'docs/5_Battle_03_PokemonBattler.rb', line 126

def battle_ability_db_symbol
end

#battle_item_db_symbol ⇒ Symbol

Note:

Use this for effect activation checks. Use item_db_symbol for possession checks.

Return the db_symbol of the item if its effect is active

Returns:

  • (Symbol)


142
143
# File 'docs/5_Battle_03_PokemonBattler.rb', line 142

def battle_item_db_symbol
end

#can_be_lowered_or_canceled?(test = true) ⇒ Boolean

Test if the Pokemon can have a lowering stat or have its move canceled (return false if the Pokemon has mold breaker)

List of ability that should be affected: :battle_armor|:clear_body|:damp|:dry_skin|:filter|:flash_fire|:flower_gift|:heatproof|:hyper_cutter|:immunity|:inner_focus|:insomnia| :keen_eye|:leaf_guard|:levitate|:lightning_rod|:limber|:magma_armor|:marvel_scale|:motor_drive|:oblivious|:own_tempo|:sand_veil|:shell_armor| :shield_dust|:simple|:snow_cloak|:solid_rock|:soundproof|:sticky_hold|:storm_drain|:sturdy|:suction_cups|:tangled_feet|:thick_fat|:unaware| :vital_spirit|:volt_absorb|:water_absorb|:water_veil|:white_smoke|:wonder_guard|:big_pecks|:contrary|:friend_guard|:heavy_metal|:light_metal| :magic_bounce|:multiscale|:sap_sipper|:telepathy|:wonder_skin|:aroma_veil|:bulletproof|:flower_veil|:fur_coat|:overcoat|:sweet_veil|:dazzling| :disguise|:fluffy|:queenly_majesty|:water_bubble|:mirror_armor|:punk_rock|:ice_scales|:ice_face|:pastel_veil||:armor_tail|:earth_eater| :good_as_gold|:purifying_salt|:well_backed_body|:wind_rider rubocop:disable Style/OptionalBooleanParameter

Parameters:

  • test (Boolean) (defaults to: true) —

    if the test should be done

Returns:

  • (Boolean) —

    potential changed result



225
226
# File 'docs/5_Battle_03_PokemonBattler.rb', line 225

def can_be_lowered_or_canceled?(test = true)
end

#can_fight? ⇒ Boolean

Is the Pokemon able to fight ?

Returns:

  • (Boolean)


105
106
# File 'docs/5_Battle_03_PokemonBattler.rb', line 105

def can_fight?
end

#can_move? ⇒ Boolean

Test if the Pokemon can use a move

Returns:

  • (Boolean)


206
207
# File 'docs/5_Battle_03_PokemonBattler.rb', line 206

def can_move?
end

#captured_with ⇒ Integer

Return the current ball ID the Pokemon was captured with If the current UI is one defined in PFM::PokemonBattler::ILLUSION_PROOF_SCENES then it'll send the ball id saved before Illusion was triggered

Returns:

  • (Integer)


373
374
# File 'docs/5_Battle_03_PokemonBattler.rb', line 373

def captured_with
end

#change_acc(amount) ⇒ Integer

Change the acc stage

Parameters:

  • amount (Integer) —

    the amount to change on the stat stage

Returns:

  • (Integer) —

    the difference between the current and the last stage value



659
660
# File 'docs/5_Battle_03_PokemonBattler.rb', line 659

def change_acc(amount)
end

#change_atk(amount) ⇒ Integer

Change the atk stage

Parameters:

  • amount (Integer) —

    the amount to change on the stat stage

Returns:

  • (Integer) —

    the difference between the current and the last stage value



629
630
# File 'docs/5_Battle_03_PokemonBattler.rb', line 629

def change_atk(amount)
end

#change_ats(amount) ⇒ Integer

Change the ats stage

Parameters:

  • amount (Integer) —

    the amount to change on the stat stage

Returns:

  • (Integer) —

    the difference between the current and the last stage value



644
645
# File 'docs/5_Battle_03_PokemonBattler.rb', line 644

def change_ats(amount)
end

#change_dfe(amount) ⇒ Integer

Change the dfe stage

Parameters:

  • amount (Integer) —

    the amount to change on the stat stage

Returns:

  • (Integer) —

    the difference between the current and the last stage value



634
635
# File 'docs/5_Battle_03_PokemonBattler.rb', line 634

def change_dfe(amount)
end

#change_dfs(amount) ⇒ Integer

Change the dfs stage

Parameters:

  • amount (Integer) —

    the amount to change on the stat stage

Returns:

  • (Integer) —

    the difference between the current and the last stage value



649
650
# File 'docs/5_Battle_03_PokemonBattler.rb', line 649

def change_dfs(amount)
end

#change_eva(amount) ⇒ Integer

Change the eva stage

Parameters:

  • amount (Integer) —

    the amount to change on the stat stage

Returns:

  • (Integer) —

    the difference between the current and the last stage value



654
655
# File 'docs/5_Battle_03_PokemonBattler.rb', line 654

def change_eva(amount)
end

#change_spd(amount) ⇒ Integer

Change the spd stage

Parameters:

  • amount (Integer) —

    the amount to change on the stat stage

Returns:

  • (Integer) —

    the difference between the current and the last stage value



639
640
# File 'docs/5_Battle_03_PokemonBattler.rb', line 639

def change_spd(amount)
end

#change_stat(stat_id, amount) ⇒ Integer

Change a stat stage

Parameters:

  • stat_id (Integer) —

    id of the stat : 0 = atk, 1 = dfe, 2 = spd, 3 = ats, 4 = dfs, 5 = eva, 6 = acc

  • amount (Integer) —

    the amount to change on the stat stage

Returns:

  • (Integer) —

    the difference between the current and the last stage value



624
625
# File 'docs/5_Battle_03_PokemonBattler.rb', line 624

def change_stat(stat_id, amount)
end

#change_types(*types)

Change the type of the pokemons

Parameters:

  • types (Array<Integer>)


282
283
# File 'docs/5_Battle_03_PokemonBattler.rb', line 282

def change_types(*types)
end

#code ⇒ Integer

Return the current code of the Pokemon If the current UI is one defined in PFM::PokemonBattler::ILLUSION_PROOF_SCENES then it'll send the code saved before Illusion was triggered

Returns:

  • (Integer)


367
368
# File 'docs/5_Battle_03_PokemonBattler.rb', line 367

def code
end

#confused? ⇒ Boolean

Is the Pokemon confused?

Returns:

  • (Boolean)


259
260
# File 'docs/5_Battle_03_PokemonBattler.rb', line 259

def confused?
end

#copy_properties_back_to_original

Copy all the properties back to the original pokemon



244
245
# File 'docs/5_Battle_03_PokemonBattler.rb', line 244

def copy_properties_back_to_original
end

#cry ⇒ String

Return the cry file name of the Pokemon If the Pokemon is under the effect of Illusion, returns the cry from the target of the ability

Returns:



378
379
# File 'docs/5_Battle_03_PokemonBattler.rb', line 378

def cry
end

#current_ability_ignoring_ability? ⇒ Boolean

Tell if the Pokémon has a ability ignoring ability

Returns:

  • (Boolean)


229
230
# File 'docs/5_Battle_03_PokemonBattler.rb', line 229

def current_ability_ignoring_ability?
end

#current_move_ignoring_ability? ⇒ Boolean

Tell if the Pokemon uses a move ignoring abilities

Returns:

  • (Boolean)


233
234
# File 'docs/5_Battle_03_PokemonBattler.rb', line 233

def current_move_ignoring_ability?
end

#delete_battler_to_encounter_list(battler)

Delete a battler to the encounter list

Parameters:



190
191
# File 'docs/5_Battle_03_PokemonBattler.rb', line 190

def delete_battler_to_encounter_list(battler)
end

#dfe ⇒ Integer

Return the current dfe

Returns:

  • (Integer)


548
549
# File 'docs/5_Battle_03_PokemonBattler.rb', line 548

def dfe
end

#dfe_basis ⇒ Integer

Return the battler's combat property

Returns:

  • (Integer)


404
405
# File 'docs/5_Battle_03_PokemonBattler.rb', line 404

def dfe_basis
end

#dfe_basis=(value)

Set the battler's combat property

Parameters:

  • value (Integer)


408
409
# File 'docs/5_Battle_03_PokemonBattler.rb', line 408

def dfe_basis=(value)
end

#dfe_modifier ⇒ Float

Return the dfe modifier

Returns:

  • (Float) —

    the multiplier



568
569
# File 'docs/5_Battle_03_PokemonBattler.rb', line 568

def dfe_modifier
end

#dfe_stage ⇒ Integer

Return the dfe stage

Returns:

  • (Integer)


588
589
# File 'docs/5_Battle_03_PokemonBattler.rb', line 588

def dfe_stage
end

#dfe_stage=(value) ⇒ Integer

Set the dfe stage

Parameters:

  • value (Integer) —

    the new value of the stat stage

Returns:

  • (Integer) —

    the new stat stage value



690
691
# File 'docs/5_Battle_03_PokemonBattler.rb', line 690

def dfe_stage=(value)
end

#dfs ⇒ Integer

Return the current dfs

Returns:

  • (Integer)


560
561
# File 'docs/5_Battle_03_PokemonBattler.rb', line 560

def dfs
end

#dfs_basis ⇒ Integer

Return the battler's combat property

Returns:

  • (Integer)


415
416
# File 'docs/5_Battle_03_PokemonBattler.rb', line 415

def dfs_basis
end

#dfs_basis=(value)

Set the battler's combat property

Parameters:

  • value (Integer)


419
420
# File 'docs/5_Battle_03_PokemonBattler.rb', line 419

def dfs_basis=(value)
end

#dfs_modifier ⇒ Float

Return the dfs modifier

Returns:

  • (Float) —

    the multiplier



580
581
# File 'docs/5_Battle_03_PokemonBattler.rb', line 580

def dfs_modifier
end

#dfs_stage ⇒ Integer

Return the dfs stage

Returns:

  • (Integer)


600
601
# File 'docs/5_Battle_03_PokemonBattler.rb', line 600

def dfs_stage
end

#dfs_stage=(value) ⇒ Integer

Set the dfs stage

Parameters:

  • value (Integer) —

    the new value of the stat stage

Returns:

  • (Integer) —

    the new stat stage value



695
696
# File 'docs/5_Battle_03_PokemonBattler.rb', line 695

def dfs_stage=(value)
end

#encountered?(battler) ⇒ Boolean

Test if the Pokemon has encountered the battler

Parameters:

Returns:

  • (Boolean)


194
195
# File 'docs/5_Battle_03_PokemonBattler.rb', line 194

def encountered?(battler)
end

#eva_stage ⇒ Integer

Return the evasion stage

Returns:

  • (Integer)


604
605
# File 'docs/5_Battle_03_PokemonBattler.rb', line 604

def eva_stage
end

#eva_stage=(value) ⇒ Integer

Set the eva stage

Parameters:

  • value (Integer) —

    the new value of the stat stage

Returns:

  • (Integer) —

    the new stat stage value



700
701
# File 'docs/5_Battle_03_PokemonBattler.rb', line 700

def eva_stage=(value)
end

#form ⇒ Integer

Return the current form of the Pokemon If the current UI is one defined in PFM::PokemonBattler::ILLUSION_PROOF_SCENES then it'll send the form saved before Illusion was triggered

Returns:

  • (Integer)


349
350
# File 'docs/5_Battle_03_PokemonBattler.rb', line 349

def form
end

#from_party? ⇒ Boolean

Return if the Pokemon is in the player's original team @ Return [Boolean]

Returns:

  • (Boolean)


114
115
# File 'docs/5_Battle_03_PokemonBattler.rb', line 114

def from_party?
end

#from_player_party? ⇒ Boolean

Return if the Pokemon is in the player's current team @ Return [Boolean]

Returns:

  • (Boolean)


118
119
# File 'docs/5_Battle_03_PokemonBattler.rb', line 118

def from_player_party?
end

#gender ⇒ Integer

Return the battler's combat property

Returns:

  • (Integer)


481
482
# File 'docs/5_Battle_03_PokemonBattler.rb', line 481

def gender
end

#gender=(value)

Set the battler's combat property

Parameters:

  • value (Integer)


485
486
# File 'docs/5_Battle_03_PokemonBattler.rb', line 485

def gender=(value)
end

#given_name ⇒ String

Return the current given name of the Pokemon If the current UI is one defined in PFM::PokemonBattler::ILLUSION_PROOF_SCENES then it'll send the given_name saved before Illusion was triggered

Returns:



355
356
# File 'docs/5_Battle_03_PokemonBattler.rb', line 355

def given_name
end

#grounded? ⇒ Boolean

Check if the pokemon is grounded

Returns:

  • (Boolean)


705
706
# File 'docs/5_Battle_03_PokemonBattler.rb', line 705

def grounded?
end

#has_ability?(db_symbol) ⇒ Boolean

Tell if the pokemon has an ability rubocop:disable Naming/PredicatePrefix

Parameters:

  • db_symbol (Symbol) —

    db_symbol of the ability

Returns:

  • (Boolean)


132
133
# File 'docs/5_Battle_03_PokemonBattler.rb', line 132

def has_ability?(db_symbol)
end

#height ⇒ Integer

Return the battler's combat property

Returns:

  • (Integer)


459
460
# File 'docs/5_Battle_03_PokemonBattler.rb', line 459

def height
end

#height=(value)

Set the battler's combat property

Parameters:

  • value (Integer)


463
464
# File 'docs/5_Battle_03_PokemonBattler.rb', line 463

def height=(value)
end

#hold_berry?(db_symbol) ⇒ Boolean

Note:

This is an effect activation check. Do not use for physical possession checks (e.g. Incinerate).

Tell if the pokemon effectively holds a berry

Parameters:

  • db_symbol (Symbol) —

    db_symbol of the item

Returns:

  • (Boolean)


154
155
# File 'docs/5_Battle_03_PokemonBattler.rb', line 154

def hold_berry?(db_symbol)
end

#hold_item?(db_symbol) ⇒ Boolean

Note:

This is an effect activation check. Do not use for physical possession checks (e.g. can_lose_item?).

Tell if the pokemon effectively holds an item

Parameters:

  • db_symbol (Symbol) —

    db_symbol of the item

Returns:

  • (Boolean)


148
149
# File 'docs/5_Battle_03_PokemonBattler.rb', line 148

def hold_item?(db_symbol)
end

#id ⇒ Integer

Return the current ID of the Pokemon If the current UI is one defined in PFM::PokemonBattler::ILLUSION_PROOF_SCENES then it'll send the id saved before Illusion was triggered

Returns:

  • (Integer)


343
344
# File 'docs/5_Battle_03_PokemonBattler.rb', line 343

def id
end

#ignore_types(*types, default: data_type(:normal).id)

Neutralize a type on the Pokemon

Parameters:

  • types (Array<Integer>)
  • default (Integer) (defaults to: data_type(:normal).id) —

    (default: id of :normal) type applied when no other types are defined



278
279
# File 'docs/5_Battle_03_PokemonBattler.rb', line 278

def ignore_types(*types, default: data_type(:normal).id)
end

#item_db_symbol ⇒ Symbol

Note:

Use this for possession checks (protection, removal). Use battle_item_db_symbol for effect activation.

Return the db_symbol of the item the Pokemon is physically holding

Returns:

  • (Symbol)


137
138
# File 'docs/5_Battle_03_PokemonBattler.rb', line 137

def item_db_symbol
end

#item_effect ⇒ Battle::Effects::Item

Get the item effect



734
735
# File 'docs/5_Battle_03_PokemonBattler.rb', line 734

def item_effect
end

#last_move_is?(db_symbol) ⇒ Boolean

Test if the last move was of a certain symbol

Parameters:

  • db_symbol (Symbol) —

    symbol of the move

Returns:

  • (Boolean)


198
199
# File 'docs/5_Battle_03_PokemonBattler.rb', line 198

def last_move_is?(db_symbol)
end

#last_successful_move_is?(db_symbol) ⇒ Boolean

Test if the last successful move was of a certain symbol

Parameters:

  • db_symbol (Symbol) —

    symbol of the move

Returns:

  • (Boolean)


202
203
# File 'docs/5_Battle_03_PokemonBattler.rb', line 202

def last_successful_move_is?(db_symbol)
end

#level_up_copy

Copy some important data upon level up



293
294
# File 'docs/5_Battle_03_PokemonBattler.rb', line 293

def level_up_copy
end

#level_up_copy_moveset(moveset_before)

Copy the moveset upon level up

Parameters:



290
291
# File 'docs/5_Battle_03_PokemonBattler.rb', line 290

def level_up_copy_moveset(moveset_before)
end

#name ⇒ String

Return the current name of the Pokemon If the current UI is one defined in PFM::PokemonBattler::ILLUSION_PROOF_SCENES then it'll send the name of the original

Returns:



361
362
# File 'docs/5_Battle_03_PokemonBattler.rb', line 361

def name
end

#nature_id ⇒ Integer

Return the battler's combat property

Returns:

  • (Integer)


437
438
# File 'docs/5_Battle_03_PokemonBattler.rb', line 437

def nature_id
end

#nature_id=(value)

Set the battler's combat property

Parameters:

  • value (Integer)


441
442
# File 'docs/5_Battle_03_PokemonBattler.rb', line 441

def nature_id=(value)
end

#rareness ⇒ Integer

Return the battler's combat property

Returns:

  • (Integer)


237
238
# File 'docs/5_Battle_03_PokemonBattler.rb', line 237

def rareness
end

#rareness=(value)

Set the battler's combat property

Parameters:

  • value (Integer)


496
497
# File 'docs/5_Battle_03_PokemonBattler.rb', line 496

def rareness=(value)
end

#reset_states

Function that resets everything from the pokemon once it got switched out of battle



247
248
# File 'docs/5_Battle_03_PokemonBattler.rb', line 247

def reset_states
end

#restore_ability

Restore the battler's property original value



455
456
# File 'docs/5_Battle_03_PokemonBattler.rb', line 455

def restore_ability
end

#restore_atk_basis

Restore the battler's property original value



389
390
# File 'docs/5_Battle_03_PokemonBattler.rb', line 389

def restore_atk_basis
end

#restore_ats_basis

Restore the battler's property original value



400
401
# File 'docs/5_Battle_03_PokemonBattler.rb', line 400

def restore_ats_basis
end

#restore_dfe_basis

Restore the battler's property original value



411
412
# File 'docs/5_Battle_03_PokemonBattler.rb', line 411

def restore_dfe_basis
end

#restore_dfs_basis

Restore the battler's property original value



422
423
# File 'docs/5_Battle_03_PokemonBattler.rb', line 422

def restore_dfs_basis
end

#restore_gender

Restore the battler's property original value



488
489
# File 'docs/5_Battle_03_PokemonBattler.rb', line 488

def restore_gender
end

#restore_height

Restore the battler's property original value



466
467
# File 'docs/5_Battle_03_PokemonBattler.rb', line 466

def restore_height
end

#restore_nature_id

Restore the battler's property original value



444
445
# File 'docs/5_Battle_03_PokemonBattler.rb', line 444

def restore_nature_id
end

#restore_rareness

Restore the battler's property original value



499
500
# File 'docs/5_Battle_03_PokemonBattler.rb', line 499

def restore_rareness
end

#restore_spd_basis

Restore the battler's property original value



433
434
# File 'docs/5_Battle_03_PokemonBattler.rb', line 433

def restore_spd_basis
end

#restore_type1

Restore the battler's property original value



510
511
# File 'docs/5_Battle_03_PokemonBattler.rb', line 510

def restore_type1
end

#restore_type2

Restore the battler's property original value



521
522
# File 'docs/5_Battle_03_PokemonBattler.rb', line 521

def restore_type2
end

#restore_type3

Restore the battler's property original value



532
533
# File 'docs/5_Battle_03_PokemonBattler.rb', line 532

def restore_type3
end

#restore_types

Restore all Pokemon types



535
536
# File 'docs/5_Battle_03_PokemonBattler.rb', line 535

def restore_types
end

#restore_weight

Restore the battler's property original value



477
478
# File 'docs/5_Battle_03_PokemonBattler.rb', line 477

def restore_weight
end

#set_stat_stage(stat_id, value) ⇒ Integer

Set a stat stage

Parameters:

  • stat_id (Integer) —

    id of the stat : 0 = atk, 1 = dfe, 2 = spd, 3 = ats, 4 = dfs, 5 = eva, 6 = acc

  • value (Integer) —

    the new value of the stat stage

Returns:

  • (Integer) —

    the new stat stage value



665
666
# File 'docs/5_Battle_03_PokemonBattler.rb', line 665

def set_stat_stage(stat_id, value)
end

#spd ⇒ Integer

Return the current spd

Returns:

  • (Integer)


552
553
# File 'docs/5_Battle_03_PokemonBattler.rb', line 552

def spd
end

#spd_basis ⇒ Integer

Return the battler's combat property

Returns:

  • (Integer)


426
427
# File 'docs/5_Battle_03_PokemonBattler.rb', line 426

def spd_basis
end

#spd_basis=(value)

Set the battler's combat property

Parameters:

  • value (Integer)


430
431
# File 'docs/5_Battle_03_PokemonBattler.rb', line 430

def spd_basis=(value)
end

#spd_modifier ⇒ Float

Return the spd modifier

Returns:

  • (Float) —

    the multiplier



572
573
# File 'docs/5_Battle_03_PokemonBattler.rb', line 572

def spd_modifier
end

#spd_stage ⇒ Integer

Return the spd stage

Returns:

  • (Integer)


592
593
# File 'docs/5_Battle_03_PokemonBattler.rb', line 592

def spd_stage
end

#spd_stage=(value) ⇒ Integer

Set the spd stage

Parameters:

  • value (Integer) —

    the new value of the stat stage

Returns:

  • (Integer) —

    the new stat stage value



675
676
# File 'docs/5_Battle_03_PokemonBattler.rb', line 675

def spd_stage=(value)
end

#stat_multiplier_acceva(stage) ⇒ Float

Return the accuracy related stat multiplier

Parameters:

  • stage (Integer) —

    the value of the stage

Returns:

  • (Float) —

    the multiplier



618
619
# File 'docs/5_Battle_03_PokemonBattler.rb', line 618

def stat_multiplier_acceva(stage)
end

#stat_multiplier_regular(stage) ⇒ Float

Return the regular stat multiplier

Parameters:

  • stage (Integer) —

    the value of the stage

Returns:

  • (Float) —

    the multiplier



613
614
# File 'docs/5_Battle_03_PokemonBattler.rb', line 613

def stat_multiplier_regular(stage)
end

#status_confuse ⇒ Boolean

Confuse the Pokemon

Returns:

  • (Boolean) —

    if the pokemon has been confused



255
256
# File 'docs/5_Battle_03_PokemonBattler.rb', line 255

def status_confuse(*)
end

#status_effect ⇒ Battle::Effects::Status

Get the status effect



726
727
# File 'docs/5_Battle_03_PokemonBattler.rb', line 726

def status_effect
end

#switching? ⇒ Boolean

if the pokemon is switching during this turn

Returns:

  • (Boolean)


251
252
# File 'docs/5_Battle_03_PokemonBattler.rb', line 251

def switching?
end

#to_s ⇒ String Also known as: inspect

Format the Battler for logging purpose

Returns:



109
110
# File 'docs/5_Battle_03_PokemonBattler.rb', line 109

def to_s
end

#type1 ⇒ Integer

Return the battler's combat property

Returns:

  • (Integer)


503
504
# File 'docs/5_Battle_03_PokemonBattler.rb', line 503

def type1
end

#type1=(value)

Set the battler's combat property

Parameters:

  • value (Integer)


507
508
# File 'docs/5_Battle_03_PokemonBattler.rb', line 507

def type1=(value)
end

#type2 ⇒ Integer

Return the battler's combat property

Returns:

  • (Integer)


514
515
# File 'docs/5_Battle_03_PokemonBattler.rb', line 514

def type2
end

#type2=(value)

Set the battler's combat property

Parameters:

  • value (Integer)


518
519
# File 'docs/5_Battle_03_PokemonBattler.rb', line 518

def type2=(value)
end

#typeless? ⇒ Boolean

Is the Pokemon typeless?

Returns:

  • (Boolean)


286
287
# File 'docs/5_Battle_03_PokemonBattler.rb', line 286

def typeless?
end

#update_illusion_snapshot_for_evolution(new_id, new_form)

Update the illusion snapshot after an evolution during battle so that clearing illusion restores the evolved identity, not the pre-evolution one.

Parameters:

  • new_id (Integer)
  • new_form (Integer)


302
303
# File 'docs/5_Battle_03_PokemonBattler.rb', line 302

def update_illusion_snapshot_for_evolution(new_id, new_form)
end

#update_loyalty

Update the PFM::PokemonBattler loyalty when level up



296
297
# File 'docs/5_Battle_03_PokemonBattler.rb', line 296

def update_loyalty
end

#update_transform_snapshot_for_evolution(new_id, new_form)

Update the transform snapshot after an evolution during battle so that clearing transform restores the evolved identity, not the pre-evolution one.

Parameters:

  • new_id (Integer)
  • new_form (Integer)


308
309
# File 'docs/5_Battle_03_PokemonBattler.rb', line 308

def update_transform_snapshot_for_evolution(new_id, new_form)
end

#weight ⇒ Integer

Return the battler's combat property

Returns:

  • (Integer)


470
471
# File 'docs/5_Battle_03_PokemonBattler.rb', line 470

def weight
end

#weight=(value)

Set the battler's combat property

Parameters:

  • value (Integer)


474
475
# File 'docs/5_Battle_03_PokemonBattler.rb', line 474

def weight=(value)
end