Class: Battle::Effects::Status

Inherits:
EffectBase show all
Defined in:
docs/5_Battle_06_Effects_03_Status_Effects.rb

Direct Known Subclasses

Asleep, Burn, Frozen, Paralysis, Poison, Toxic

Defined Under Namespace

Classes: Asleep, Burn, Frozen, Paralysis, Poison, Toxic

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from EffectBase

#apply_common_effects_with_fling, #atk_modifier, #ats_modifier, #base_power_multiplier, #can_attack_hit_out_of_reach?, #chance_of_hit_multiplier, #counter=, #dead?, #dfe_modifier, #dfs_modifier, #effect_chance_modifier, #force_next_move?, #force_next_turn_action?, #ignore_target_redirection?, #kill, #mod1_multiplier, #mod2_multiplier, #mod3_multiplier, #name, #on_damage_prevention, #on_delete, #on_end_turn_event, #on_fterrain_prevention, #on_held_item_use_prevention, #on_move_ability_immunity, #on_move_disabled_check, #on_move_prevention_target, #on_move_prevention_user, #on_move_priority_change, #on_move_type_change, #on_post_accuracy_check, #on_post_action_event, #on_post_damage, #on_post_damage_death, #on_post_fterrain_change, #on_post_item_change, #on_post_status_change, #on_post_weather_change, #on_pre_accuracy_check, #on_pre_item_change, #on_single_type_multiplier_overwrite, #on_stat_change, #on_stat_change_post, #on_stat_decrease_prevention, #on_stat_increase_prevention, #on_status_prevention, #on_switch_event, #on_switch_passthrough, #on_switch_prevention, #on_transform_event, #on_two_turn_shortcut, #on_weather_prevention, #out_of_reach?, #preparing_attack?, #rapid_spin_affected?, #sp_atk_multiplier, #sp_def_multiplier, #spd_modifier, #specific_proceed_internal, #target_redirection, #targetted?, #update_counter

Constructor Details

#initialize(logic, target, status) ⇒ Status

Create a new status effect

Parameters:



12
13
 
# File 'docs/5_Battle_06_Effects_03_Status_Effects.rb', line 12

def initialize(logic, target, status)
end

Instance Attribute Details

#target ⇒ PFM::PokemonBattler (readonly)

Get the target of the effect

Returns:



6
7
8
 
# File 'docs/5_Battle_06_Effects_03_Status_Effects.rb', line 6

def target
  @target
end

Class Method Details

.new(logic, target, status) ⇒ Status

Create a new Status effect

Parameters:

Returns:



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

def new(logic, target, status)
end

.register(status, klass)

Register a new status

Parameters:

  • status (Symbol) —

    Symbol of the status

  • klass (Class<Status>) —

    class of the status effect



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

def register(status, klass)
end

Instance Method Details

#asleep? ⇒ Boolean

Tell if the status effect is asleep

Returns:

  • (Boolean) 


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

def asleep?
end

#burn? ⇒ Boolean

Tell if the status effect is burn

Returns:

  • (Boolean) 


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

def burn?
end

#frozen? ⇒ Boolean

Tell if the status effect is frozen

Returns:

  • (Boolean) 


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

def frozen?
end

#global_poisoning? ⇒ Boolean

Tell if the effect is a global poisoning effect (poison or toxic)

Returns:

  • (Boolean) 


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

def global_poisoning?
end

#paralysis? ⇒ Boolean

Tell if the status effect is paralysis

Returns:

  • (Boolean) 


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

def paralysis?
end

#poison? ⇒ Boolean

Tell if the status effect is poisoning

Returns:

  • (Boolean) 


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

def poison?
end

#status_id ⇒ Integer

Get the ID of the status

Returns:

  • (Integer) 


16
17
 
# File 'docs/5_Battle_06_Effects_03_Status_Effects.rb', line 16

def status_id
end

#toxic? ⇒ Boolean

Tell if the status effect is toxic

Returns:

  • (Boolean) 


40
41
 
# File 'docs/5_Battle_06_Effects_03_Status_Effects.rb', line 40

def toxic?
end