Class: Battle::Effects::Weather

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

Overview

Class describing the base weather effect

Defined Under Namespace

Classes: Fog, Hail, Hardrain, Hardsun, Rain, Sandstorm, Snow, StrongWinds, Sunny

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) ⇒ Weather

Create a new weather effect

Parameters:

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

    db_symbol of the weather



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

def initialize(logic, db_symbol)
end

Instance Attribute Details

#db_symbol ⇒ Symbol (readonly)

Get the db_symbol of the weather

Returns:

  • (Symbol)


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

def db_symbol
  @db_symbol
end

Class Method Details

.new(logic, db_symbol) ⇒ Weather

Create a new Weather effect

Parameters:

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

    db_symbol of the weather

Returns:



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

def new(logic, db_symbol)
end

.register(db_symbol, klass)

Register a new weather

Parameters:

  • db_symbol (Symbol) —

    db_symbol of the weather

  • klass (Class<Weather>) —

    class of the weather effect



75
76
# File 'docs/5_Battle_06_Effects_06_Weather_Effects.rb', line 75

def register(db_symbol, klass)
end

Instance Method Details

#current_weather_db_symbol ⇒ Symbol

Return the db_symbol of the current weather

Returns:

  • (Symbol)


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

def current_weather_db_symbol
end

#fog? ⇒ Boolean

Is it foggy ?

Returns:

  • (Boolean)


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

def fog?
end

#global_rain? ⇒ Boolean

Is it any kind of rainy weather?

Returns:

  • (Boolean)


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

def global_rain?
end

#global_snowing? ⇒ Boolean

Is it any kind of snow weather?

Returns:

  • (Boolean)


61
62
# File 'docs/5_Battle_06_Effects_06_Weather_Effects.rb', line 61

def global_snowing?
end

#global_sunny? ⇒ Boolean

Is it any kind of sunny weather?

Returns:

  • (Boolean)


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

def global_sunny?
end

#hail? ⇒ Boolean

Does it hail ?

Returns:

  • (Boolean)


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

def hail?
end

#hardrain? ⇒ Boolean

Is it heavy_raining?

Returns:

  • (Boolean)


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

def hardrain?
end

#hardsun? ⇒ Boolean

Is it hardsunny?

Returns:

  • (Boolean)


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

def hardsun?
end

#normal? ⇒ Boolean

Is there no weather?

Returns:

  • (Boolean)


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

def normal?
end

#rain? ⇒ Boolean

Is it raining?

Returns:

  • (Boolean)


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

def rain?
end

#sandstorm? ⇒ Boolean

Duuuuuuuuuuuuuuuuuuuuuuun Dun dun dun dun dun dun dun dun dun dun dun dundun dun dundundun dun dun dun dun dun dun dundun dundun

Returns:

  • (Boolean)


49
50
# File 'docs/5_Battle_06_Effects_06_Weather_Effects.rb', line 49

def sandstorm?
end

#snowing? ⇒ Boolean

Is it snowing?

Returns:

  • (Boolean)


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

def snowing?
end

#strong_winds? ⇒ Boolean

Is it Strong Winds ? (Mega Rayquaza)

Returns:

  • (Boolean)


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

def strong_winds?
end

#sunny? ⇒ Boolean

Is it sunny?

Returns:

  • (Boolean)


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

def sunny?
end