Class: Battle::Effects::EffectBase

Inherits:
Object
  • Object
show all
Defined in:
docs/5_Battle_06_Effects.rb

Overview

Class describing all the effect ("abstract") and helping the handler to manage effect

Instance Method Summary collapse

Constructor Details

#initialize(logic) ⇒ EffectBase

Create a new effect

Parameters:

  • logic (Battle::Logic) —

    logic used to get all the handler in order to allow the effect to work



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

def initialize(logic)
end

Instance Method Details

#apply_common_effects_with_fling(scene, target, launcher, skill)

Apply the common effects of the item with Fling move effect

Parameters:



143
144
# File 'docs/5_Battle_06_Effects.rb', line 143

def apply_common_effects_with_fling(scene, target, launcher, skill)
end

#atk_modifier ⇒ Float, Integer

Give the atk modifier over given to the Pokemon with this effect

Returns:

  • (Float, Integer) —

    multiplier



483
484
# File 'docs/5_Battle_06_Effects.rb', line 483

def atk_modifier
end

#ats_modifier ⇒ Float, Integer

Give the ats modifier over given to the Pokemon with this effect

Returns:

  • (Float, Integer) —

    multiplier



495
496
# File 'docs/5_Battle_06_Effects.rb', line 495

def ats_modifier
end

#base_power_multiplier(user, target, move) ⇒ Float, Integer

Give the move base power mutiplier

Parameters:

Returns:

  • (Float, Integer) —

    multiplier



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

def base_power_multiplier(user, target, move)
end

#can_attack_hit_out_of_reach?(name) ⇒ Boolean

Check if the attack can hit the pokemon. Should be called after testing out_of_reach?

Parameters:

  • name (Symbol)

Returns:

  • (Boolean)


116
117
# File 'docs/5_Battle_06_Effects.rb', line 116

def can_attack_hit_out_of_reach?(name)
end

#chance_of_hit_multiplier(user, target, move) ⇒ Float

Return the chance of hit multiplier

Parameters:

Returns:

  • (Float)


511
512
# File 'docs/5_Battle_06_Effects.rb', line 511

def chance_of_hit_multiplier(user, target, move)
end

#counter=(counter)

Function that sets the counter

Parameters:

  • counter (Integer) —

    new counter value



70
71
# File 'docs/5_Battle_06_Effects.rb', line 70

def counter=(counter)
end

#critical_count_modifier(user, target) ⇒ Integer

Return the critical count modifier (added to the critical count)

Parameters:

Returns:

  • (Integer)


517
518
# File 'docs/5_Battle_06_Effects.rb', line 517

def critical_count_modifier(user, target)
end

#dead? ⇒ Boolean

Function telling if the effect should be removed from effects handler

Returns:

  • (Boolean)


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

def dead?
end

#dfe_modifier ⇒ Float, Integer

Give the dfe modifier over given to the Pokemon with this effect

Returns:

  • (Float, Integer) —

    multiplier



487
488
# File 'docs/5_Battle_06_Effects.rb', line 487

def dfe_modifier
end

#dfs_modifier ⇒ Float, Integer

Give the dfs modifier over given to the Pokemon with this effect

Returns:

  • (Float, Integer) —

    multiplier



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

def dfs_modifier
end

#effect_chance_modifier(move) ⇒ Float, Integer

Give the effect chance modifier given to the Pokémon with this effect

Parameters:

Returns:

  • (Float, Integer) —

    multiplier



504
505
# File 'docs/5_Battle_06_Effects.rb', line 504

def effect_chance_modifier(move)
end

#force_critical_hit?(user, target) ⇒ Boolean

Tell if the effect forces a critical hit

Parameters:

Returns:

  • (Boolean)


523
524
# File 'docs/5_Battle_06_Effects.rb', line 523

def force_critical_hit?(user, target)
end

#force_next_move? ⇒ Boolean

Tell if the effect forces the next move

Returns:

  • (Boolean)


99
100
# File 'docs/5_Battle_06_Effects.rb', line 99

def force_next_move?
end

#force_next_turn_action? ⇒ Boolean

Tell if the effect forces the next turn action into a Attack action

Returns:

  • (Boolean)


103
104
# File 'docs/5_Battle_06_Effects.rb', line 103

def force_next_turn_action?
end

#ignore_target_redirection? ⇒ Boolean

Check if the user of this ability ignore the center of attention in the enemy bank

Returns:

  • (Boolean)


136
137
# File 'docs/5_Battle_06_Effects.rb', line 136

def ignore_target_redirection?
end

#kill

Kill the effect (in order to remove it from the effects handler)



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

def kill
end

#mod1_multiplier(user, target, move) ⇒ Float, Integer

Give the move mod1 mutiplier (before the +2 in the formula)

Parameters:

Returns:

  • (Float, Integer) —

    multiplier



465
466
# File 'docs/5_Battle_06_Effects.rb', line 465

def mod1_multiplier(user, target, move)
end

#mod2_multiplier(user, target, move) ⇒ Float, Integer

Give the move mod1 mutiplier (after the critical)

Parameters:

Returns:

  • (Float, Integer) —

    multiplier



472
473
# File 'docs/5_Battle_06_Effects.rb', line 472

def mod2_multiplier(user, target, move)
end

#mod3_multiplier(user, target, move) ⇒ Float, Integer

Give the move mod3 mutiplier (after everything)

Parameters:

Returns:

  • (Float, Integer) —

    multiplier



479
480
# File 'docs/5_Battle_06_Effects.rb', line 479

def mod3_multiplier(user, target, move)
end

#name ⇒ Symbol

Function giving the name of the effect

Returns:

  • (Symbol)


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

def name
end

#on_ability_change_prevention(handler, target, launcher, skill) ⇒ :prevent?

Function called when a ability_change_prevention is checked

Parameters:

Returns:

  • (:prevent, nil) —

    :prevent if the ability cannot be changed



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

def on_ability_change_prevention(handler, target, launcher, skill)
end

#on_damage_prevention(handler, hp, target, launcher, skill) ⇒ :prevent, ...

Function called when a damage_prevention is checked

Parameters:

Returns:

  • (:prevent, Integer, nil) —

    :prevent if the damage cannot be applied, Integer if the hp variable should be updated



248
249
# File 'docs/5_Battle_06_Effects.rb', line 248

def on_damage_prevention(handler, hp, target, launcher, skill)
end

#on_delete

Function called when the effect has been deleted from the effects handler



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

def on_delete
end

#on_drain_prevention(handler, hp, hp_healed, target, launcher, skill) ⇒ :prevent?

Function called before drain were applied (to potentially prevent healing)

Parameters:

Returns:

  • (:prevent, nil) —

    :prevent if the drain cannot be applied



274
275
# File 'docs/5_Battle_06_Effects.rb', line 274

def on_drain_prevention(handler, hp, hp_healed, target, launcher, skill)
end

#on_end_turn_event(logic, scene, battlers)

Function called at the end of a turn

Parameters:



320
321
# File 'docs/5_Battle_06_Effects.rb', line 320

def on_end_turn_event(logic, scene, battlers)
end

#on_flee_passthrough(handler, target) ⇒ :passthrough?

Function called when testing if a battler can flee regardless of the prevention

Parameters:

Returns:

  • (:passthrough, nil) —

    if :passthrough, can_flee? will return true without checking flee_prevention



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

def on_flee_passthrough(handler, target)
end

#on_flee_prevention(handler, target) ⇒ :prevent?

Function called when testing if a battler can flee (when they couldn't passthrough)

Parameters:

Returns:

  • (:prevent, nil) —

    if :prevent, can_flee? will return false



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

def on_flee_prevention(handler, target)
end

#on_fterrain_prevention(handler, fterrain_type, last_fterrain) ⇒ :prevent?

Function called when a fterrain_prevention is checked

Parameters:

  • handler (Battle::Logic::FTerrainChangeHandler)
  • fterrain_type (Symbol) —

    :none, :electric_terrain, :grassy_terrain, :misty_terrain, :psychic_terrain

  • last_fterrain (Symbol) —

    :none, :electric_terrain, :grassy_terrain, :misty_terrain, :psychic_terrain

Returns:

  • (:prevent, nil) —

    :prevent if the status cannot be applied



344
345
# File 'docs/5_Battle_06_Effects.rb', line 344

def on_fterrain_prevention(handler, fterrain_type, last_fterrain)
end

#on_held_item_use_prevention ⇒ Boolean

Function called when a held item wants to perform its action

Returns:

  • (Boolean) —

    true to prevent the item from activating, false to let it proceed



125
126
# File 'docs/5_Battle_06_Effects.rb', line 125

def on_held_item_use_prevention
end

#on_move_ability_immunity(user, target, move) ⇒ Boolean

Function called when we try to check if the Pokemon is immune to a move due to its effect

Parameters:

Returns:

  • (Boolean) —

    if the target is immune to the move



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

def on_move_ability_immunity(user, target, move)
end

#on_move_disabled_check(user, move) ⇒ Proc?

Function called when we try to check if the user cannot use a move

Parameters:

Returns:

  • (Proc, nil)


401
402
# File 'docs/5_Battle_06_Effects.rb', line 401

def on_move_disabled_check(user, move)
end

#on_move_failure(user, targets, move, reason)

Function called when a move fails during its execution

Parameters:



387
388
# File 'docs/5_Battle_06_Effects.rb', line 387

def on_move_failure(user, targets, move, reason)
end

#on_move_prevention_target(user, target, move) ⇒ Boolean

Function called when we try to check if the target evades the move

Parameters:

Returns:

  • (Boolean) —

    if the target is evading the move



380
381
# File 'docs/5_Battle_06_Effects.rb', line 380

def on_move_prevention_target(user, target, move)
end

#on_move_prevention_user(user, targets, move) ⇒ :prevent?

Function called when we try to use a move as the user (returns :prevent if user fails)

Parameters:

Returns:

  • (:prevent, nil) —

    :prevent if the move cannot continue



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

def on_move_prevention_user(user, targets, move)
end

#on_move_priority_change(user, priority, move) ⇒ Proc?

Function called when we try to check if the effect changes the definitive priority of the move

Parameters:

Returns:

  • (Proc, nil)


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

def on_move_priority_change(user, priority, move)
end

#on_move_type_change(user, target, move, type) ⇒ Integer?

Function called when we try to get the definitive type of a move

Parameters:

Returns:

  • (Integer, nil) —

    new type of the move



395
396
# File 'docs/5_Battle_06_Effects.rb', line 395

def on_move_type_change(user, target, move, type)
end

#on_post_ability_change(handler, db_symbol, target, launcher, skill)

Function called when a post_ability_change is checked

Parameters:



222
223
# File 'docs/5_Battle_06_Effects.rb', line 222

def on_post_ability_change(handler, db_symbol, target, launcher, skill)
end

#on_post_accuracy_check(logic, scene, targets, launcher, skill)

Function called after the accuracy check of a move is done (and the move should land)

Parameters:



366
367
# File 'docs/5_Battle_06_Effects.rb', line 366

def on_post_accuracy_check(logic, scene, targets, launcher, skill)
end

#on_post_action_event(logic, scene, battlers)

Function called at the end of an action

Parameters:



314
315
# File 'docs/5_Battle_06_Effects.rb', line 314

def on_post_action_event(logic, scene, battlers)
end

#on_post_damage(handler, hp, target, launcher, skill)

Function called after damages were applied (post_damage, when target is still alive)

Parameters:



256
257
# File 'docs/5_Battle_06_Effects.rb', line 256

def on_post_damage(handler, hp, target, launcher, skill)
end

#on_post_damage_death(handler, hp, target, launcher, skill)

Function called after damages were applied and when target died (post_damage_death)

Parameters:



264
265
# File 'docs/5_Battle_06_Effects.rb', line 264

def on_post_damage_death(handler, hp, target, launcher, skill)
end

#on_post_fterrain_change(handler, fterrain_type, last_fterrain)

Function called after the terrain was changed

Parameters:

  • handler (Battle::Logic::FTerrainChangeHandler)
  • fterrain_type (Symbol) —

    :none, :electric_terrain, :grassy_terrain, :misty_terrain, :psychic_terrain

  • last_fterrain (Symbol) —

    :none, :electric_terrain, :grassy_terrain, :misty_terrain, :psychic_terrain



350
351
# File 'docs/5_Battle_06_Effects.rb', line 350

def on_post_fterrain_change(handler, fterrain_type, last_fterrain)
end

#on_post_item_change(handler, db_symbol, target, launcher, skill)

Function called when a post_item_change is checked

Parameters:



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

def on_post_item_change(handler, db_symbol, target, launcher, skill)
end

#on_post_status_change(handler, status, target, launcher, skill)

Function called when a post_status_change is performed

Parameters:



239
240
# File 'docs/5_Battle_06_Effects.rb', line 239

def on_post_status_change(handler, status, target, launcher, skill)
end

#on_post_weather_change(handler, weather_type, last_weather)

Function called after the weather was changed (on_post_weather_change)

Parameters:

  • handler (Battle::Logic::WeatherChangeHandler)
  • weather_type (Symbol) —

    :none, :rain, :sunny, :sandstorm, :hail, :fog

  • last_weather (Symbol) —

    :none, :rain, :sunny, :sandstorm, :hail, :fog



333
334
# File 'docs/5_Battle_06_Effects.rb', line 333

def on_post_weather_change(handler, weather_type, last_weather)
end

#on_pre_ability_change(handler, db_symbol, target, launcher, skill)

Function called when a pre_ability_change is checked

Parameters:



214
215
# File 'docs/5_Battle_06_Effects.rb', line 214

def on_pre_ability_change(handler, db_symbol, target, launcher, skill)
end

#on_pre_accuracy_check(logic, scene, targets, launcher, skill)

Function called before the accuracy check of a move is done

Parameters:



358
359
# File 'docs/5_Battle_06_Effects.rb', line 358

def on_pre_accuracy_check(logic, scene, targets, launcher, skill)
end

#on_pre_drain(handler, hp, target, launcher, skill) ⇒ Float, Integer

Function called before drain were applied (to change the number of hp healed)

Parameters:

Returns:

  • (Float, Integer) —

    multiplier



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

def on_pre_drain(handler, hp, target, launcher, skill)
end

#on_pre_item_change(handler, db_symbol, target, launcher, skill) ⇒ :prevent?

Function called when a pre_item_change is checked

Parameters:

Returns:

  • (:prevent, nil) —

    :prevent if the item change cannot be applied



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

def on_pre_item_change(handler, db_symbol, target, launcher, skill)
end

#on_single_type_multiplier_overwrite(target, target_type, type, move) ⇒ Float?

Function that computes an overwrite of the type multiplier

Parameters:

Returns:

  • (Float, nil) —

    overwriten type multiplier



428
429
# File 'docs/5_Battle_06_Effects.rb', line 428

def on_single_type_multiplier_overwrite(target, target_type, type, move)
end

#on_stat_change(handler, stat, power, target, launcher, skill) ⇒ Integer?

Function called when a stat_change is about to be applied

Parameters:

Returns:

  • (Integer, nil) —

    if integer, it will change the power



171
172
# File 'docs/5_Battle_06_Effects.rb', line 171

def on_stat_change(handler, stat, power, target, launcher, skill)
end

#on_stat_change_post(handler, stat, power, target, launcher, skill) ⇒ Integer?

Function called when a stat_change has been applied

Parameters:

Returns:

  • (Integer, nil) —

    if integer, it will change the power



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

def on_stat_change_post(handler, stat, power, target, launcher, skill)
end

#on_stat_decrease_prevention(handler, stat, target, launcher, skill) ⇒ :prevent?

Function called when a stat_decrease_prevention is checked

Parameters:

Returns:

  • (:prevent, nil) —

    :prevent if the stat decrease cannot apply



161
162
# File 'docs/5_Battle_06_Effects.rb', line 161

def on_stat_decrease_prevention(handler, stat, target, launcher, skill)
end

#on_stat_increase_prevention(handler, stat, target, launcher, skill) ⇒ :prevent?

Function called when a stat_increase_prevention is checked

Parameters:

Returns:

  • (:prevent, nil) —

    :prevent if the stat increase cannot apply



152
153
# File 'docs/5_Battle_06_Effects.rb', line 152

def on_stat_increase_prevention(handler, stat, target, launcher, skill)
end

#on_status_prevention(handler, status, target, launcher, skill) ⇒ :prevent?

Function called when a status_prevention is checked

Parameters:

Returns:

  • (:prevent, nil) —

    :prevent if the status cannot be applied



231
232
# File 'docs/5_Battle_06_Effects.rb', line 231

def on_status_prevention(handler, status, target, launcher, skill)
end

#on_switch_event(handler, who, with)

Function called when a Pokemon has actually switched with another one

Parameters:



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

def on_switch_event(handler, who, with)
end

#on_switch_passthrough(handler, pokemon, skill, reason) ⇒ :passthrough?

Function called when testing if pokemon can switch regardless of the prevension.

Parameters:

Returns:

  • (:passthrough, nil) —

    if :passthrough, can_switch? will return true without checking switch_prevention



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

def on_switch_passthrough(handler, pokemon, skill, reason)
end

#on_switch_prevention(handler, pokemon, skill, reason) ⇒ :prevent?

Function called when testing if pokemon can switch (when he couldn't passthrough)

Parameters:

Returns:

  • (:prevent, nil) —

    if :prevent, can_switch? will return false



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

def on_switch_prevention(handler, pokemon, skill, reason)
end

#on_transform_event(handler, target)

Function called when a Pokemon initialize a transformation

Parameters:



420
421
# File 'docs/5_Battle_06_Effects.rb', line 420

def on_transform_event(handler, target)
end

#on_two_turn_shortcut(user, targets, skill) ⇒ Boolean

Function called after a battler proceed its two turn move's first turn

Parameters:

Returns:

  • (Boolean) —

    weither or not the two turns move is executed in one turn



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

def on_two_turn_shortcut(user, targets, skill)
end

#on_weather_effects_disabled_change(handler)

Function called when weather effects are suppressed or restored (e.g. Air Lock / Cloud Nine enters or leaves)

Parameters:



337
338
# File 'docs/5_Battle_06_Effects.rb', line 337

def on_weather_effects_disabled_change(handler)
end

#on_weather_prevention(handler, weather_type, last_weather) ⇒ :prevent?

Function called when a weather_prevention is checked

Parameters:

  • handler (Battle::Logic::WeatherChangeHandler)
  • weather_type (Symbol) —

    :none, :rain, :sunny, :sandstorm, :hail, :fog

  • last_weather (Symbol) —

    :none, :rain, :sunny, :sandstorm, :hail, :fog

Returns:

  • (:prevent, nil) —

    :prevent if the status cannot be applied



327
328
# File 'docs/5_Battle_06_Effects.rb', line 327

def on_weather_prevention(handler, weather_type, last_weather)
end

#out_of_reach? ⇒ Boolean

Tell if the effect make the pokemon out reach

Returns:

  • (Boolean)


107
108
# File 'docs/5_Battle_06_Effects.rb', line 107

def out_of_reach?
end

#preparing_attack? ⇒ Boolean

Tell if the effect make the pokemon preparing an attack

Returns:

  • (Boolean)


111
112
# File 'docs/5_Battle_06_Effects.rb', line 111

def preparing_attack?
end

#prevent_critical_hit?(user, target) ⇒ Boolean

Tell if the effect prevents a critical hit

Parameters:

Returns:

  • (Boolean)


529
530
# File 'docs/5_Battle_06_Effects.rb', line 529

def prevent_critical_hit?(user, target)
end

#rapid_spin_affected? ⇒ Boolean

Function that tells if the move is affected by Rapid Spin

Returns:

  • (Boolean)


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

def rapid_spin_affected?
end

#sp_atk_multiplier(user, target, move) ⇒ Float, Integer

Give the move [Spe]atk mutiplier

Parameters:

Returns:

  • (Float, Integer) —

    multiplier



451
452
# File 'docs/5_Battle_06_Effects.rb', line 451

def sp_atk_multiplier(user, target, move)
end

#sp_def_multiplier(user, target, move) ⇒ Float, Integer

Give the move [Spe]def mutiplier

Parameters:

Returns:

  • (Float, Integer) —

    multiplier



458
459
# File 'docs/5_Battle_06_Effects.rb', line 458

def sp_def_multiplier(user, target, move)
end

#spd_modifier ⇒ Float, Integer

Give the speed modifier over given to the Pokemon with this effect

Returns:

  • (Float, Integer) —

    multiplier



491
492
# File 'docs/5_Battle_06_Effects.rb', line 491

def spd_modifier
end

#specific_proceed_internal(user, targets, move)

Return the specific proceed_internal if the condition is fulfilled

Parameters:



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

def specific_proceed_internal(user, targets, move)
end

#target_redirection(user, targets, move) ⇒ PFM::PokemonBattler

Return the new target if the conditions are fulfilled

Parameters:

Returns:

  • (PFM::PokemonBattler) —

    the new target if the conditions are fulfilled, the initial target otherwise



542
543
# File 'docs/5_Battle_06_Effects.rb', line 542

def target_redirection(user, targets, move)
end

#targetted?(battler) ⇒ Boolean

Tell if the given battler is targetted by the effect

Parameters:

Returns:

  • (Boolean)


121
122
# File 'docs/5_Battle_06_Effects.rb', line 121

def targetted?(battler)
end

#triggered? ⇒ Boolean

Function telling if the effect has just been triggered (counter == 1)

Returns:

  • (Boolean)


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

def triggered?
end

#update_counter

Function that updates the counter of the effect



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

def update_counter
end