Class: Battle::Effects::FieldTerrain

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

Overview

Class describing the base field terrain effect

Defined Under Namespace

Classes: Electric, Grassy, Misty, Psychic

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=, #critical_count_modifier, #dead?, #dfe_modifier, #dfs_modifier, #effect_chance_modifier, #force_critical_hit?, #force_next_move?, #force_next_turn_action?, #ignore_target_redirection?, #kill, #mod1_multiplier, #mod2_multiplier, #mod3_multiplier, #name, #on_ability_change_prevention, #on_damage_prevention, #on_delete, #on_drain_prevention, #on_end_turn_event, #on_flee_passthrough, #on_flee_prevention, #on_fterrain_prevention, #on_held_item_use_prevention, #on_move_ability_immunity, #on_move_disabled_check, #on_move_failure, #on_move_prevention_target, #on_move_prevention_user, #on_move_priority_change, #on_move_type_change, #on_post_ability_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_ability_change, #on_pre_accuracy_check, #on_pre_drain, #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_effects_disabled_change, #on_weather_prevention, #out_of_reach?, #preparing_attack?, #prevent_critical_hit?, #rapid_spin_affected?, #sp_atk_multiplier, #sp_def_multiplier, #spd_modifier, #specific_proceed_internal, #target_redirection, #targetted?, #triggered?, #update_counter

Constructor Details

#initialize(logic, db_symbol) ⇒ FieldTerrain

Create a new field terrain effect

Parameters:

  • logic (Battle::Logic)
  • db_symbol (Symbol) —

    db_symbol of the field terrain



15
16
# File 'docs/5_Battle_06_Effects_07_Field_Terrain_Effects.rb', line 15

def initialize(logic, db_symbol)
end

Instance Attribute Details

#db_symbol ⇒ Symbol (readonly)

Get the db_symbol of the field terrain

Returns:

  • (Symbol)


7
8
9
# File 'docs/5_Battle_06_Effects_07_Field_Terrain_Effects.rb', line 7

def db_symbol
  @db_symbol
end

#internal_counter ⇒ Integer

Get the counter of the field terrain

Returns:

  • (Integer)


10
11
12
# File 'docs/5_Battle_06_Effects_07_Field_Terrain_Effects.rb', line 10

def internal_counter
  @internal_counter
end

Class Method Details

.new(logic, db_symbol) ⇒ Field terrain

Create a new Field terrain effect

Parameters:

  • logic (Battle::Logic)
  • db_symbol (Symbol) —

    db_symbol of the field terrain

Returns:

  • (Field terrain)


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

def new(logic, db_symbol)
end

.register(db_symbol, klass)

Register a new field terrain

Parameters:

  • db_symbol (Symbol) —

    db_symbol of the field terrain

  • klass (Class<Field terrain>) —

    class of the field terrain effect



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

def register(db_symbol, klass)
end

Instance Method Details

#electric? ⇒ Boolean

Tell if the field terrain is electric

Returns:

  • (Boolean)


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

def electric?
end

#grassy? ⇒ Boolean

Tell if the field terrain is grassy

Returns:

  • (Boolean)


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

def grassy?
end

#misty? ⇒ Boolean

Tell if the field terrain is psychic

Returns:

  • (Boolean)


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

def misty?
end

#none? ⇒ Boolean

Tell if the field terrain is none

Returns:

  • (Boolean)


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

def none?
end

#psychic? ⇒ Boolean

Tell if the field terrain is psychic

Returns:

  • (Boolean)


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

def psychic?
end