Class: Battle::Logic::StatusChangeHandler

Inherits:

ChangeHandlerBase

• Object
• ChangeHandlerBase
• Battle::Logic::StatusChangeHandler

Includes:

Hooks

Defined in:

docs/5_Battle_04_Logic.rb

Overview

Handler responsive of answering properly status changes requests

Constant Summary

STATUS_APPLY_METHODS =

List of method to call in order to apply the status on the Pokemon

{poison: :status_poison, toxic: :status_toxic, confusion: :status_confuse, sleep: :status_sleep, freeze: :status_frozen, paralysis: :status_paralyze, burn: :status_burn, cure: :cure, flinch: :apply_flinch}

STATUS_APPLY_MESSAGE =

List of message ID when applying a status

{poison: 234, toxic: 237, confusion: 345, sleep: 306, freeze: 288, paralysis: 273, burn: 255}

STATUS_APPLY_ANIMATION =

List of animation ID when applying a status

{poison: 470, toxic: 477, confusion: 475, sleep: 473, freeze: 474, paralysis: 471, burn: 472, flinch: 476}

Instance Attribute Summary

Attributes inherited from ChangeHandlerBase

#logic, #pre_checked_effects, #scene

Class Method Summary

• .register_post_status_change_hook(reason) {|handler, status, target, launcher, skill| ... }

  Function that registers a post_status_change hook.

• .register_status_prevention_hook(reason) {|handler, status, target, launcher, skill| ... }

  Function that registers a status_prevention hook.

Instance Method Summary

• #status_appliable?(status, target, launcher = nil, skill = nil) ⇒ Boolean

  Function telling if a status can be applyied.

• #status_change(status, target, launcher = nil, skill = nil, message_overwrite: nil)

  Function that actually change the status.

• #status_change_with_process(status, target, launcher = nil, skill = nil, message_overwrite: nil)

  Function that test if the change is possible and perform the change if so.

Methods included from Hooks

#exec_hooks, #force_return, included, register, remove, remove_without_name

Methods inherited from ChangeHandlerBase

#initialize, #prevent_change, #process_prevention_reason, #reset_prevention_reason

Constructor Details

This class inherits a constructor from Battle::Logic::ChangeHandlerBase

Class Method Details

.register_post_status_change_hook(reason) {|handler, status, target, launcher, skill| ... }

Function that registers a post_status_change hook

Parameters:

• reason (String) —

  reason of the post_status_change registration

Yield Parameters:

• handler (StatusChangeHandler)
• status (Symbol) —

  :poison, :toxic, :confusion, :sleep, :freeze, :paralysis, :burn, :flinch, :cure

• target (PFM::PokemonBattler)
• launcher (PFM::PokemonBattler, nil) —

  Potential launcher of a move

• skill (Battle::Move, nil) —

  Potential move used

# File 'docs/5_Battle_04_Logic.rb', line 1015

def register_post_status_change_hook(reason)
end

.register_status_prevention_hook(reason) {|handler, status, target, launcher, skill| ... }

Function that registers a status_prevention hook

Parameters:

• reason (String) —

  reason of the status_prevention registration

Yield Parameters:

• handler (StatusChangeHandler)
• status (Symbol) —

  :poison, :toxic, :confusion, :sleep, :freeze, :paralysis, :burn, :flinch, :cure

• target (PFM::PokemonBattler)
• launcher (PFM::PokemonBattler, nil) —

  Potential launcher of a move

• skill (Battle::Move, nil) —

  Potential move used

Yield Returns:

• (:prevent, nil) —

  :prevent if the status cannot be applied

# File 'docs/5_Battle_04_Logic.rb', line 1006

def register_status_prevention_hook(reason)
end

Instance Method Details

#status_appliable?(status, target, launcher = nil, skill = nil) ⇒ Boolean

Note:

Thing that prevents the status from being applyied should be defined using :status_prevention Hook.

Function telling if a status can be applyied

Parameters:

• status (Symbol) —

  :poison, :toxic, :confusion, :sleep, :freeze, :paralysis, :burn, :flinch

• target (PFM::PokemonBattler)
• launcher (PFM::PokemonBattler, nil) (defaults to: nil) —

  Potential launcher of a move

• skill (Battle::Move, nil) (defaults to: nil) —

  Potential move used

Returns:

• (Boolean)

# File 'docs/5_Battle_04_Logic.rb', line 974

def status_appliable?(status, target, launcher = nil, skill = nil)
end

#status_change(status, target, launcher = nil, skill = nil, message_overwrite: nil)

Function that actually change the status

Parameters:

• status (Symbol) —

  :poison, :toxic, :confusion, :sleep, :freeze, :paralysis, :burn, :flinch, :cure, :confuse_cure

• target (PFM::PokemonBattler)
• launcher (PFM::PokemonBattler, nil) (defaults to: nil) —

  Potential launcher of a move

• skill (Battle::Move, nil) (defaults to: nil) —

  Potential move used

• message_overwrite (Integer) (defaults to: nil) —

  Index of the message to use of file 19 to apply the status (if there’s specific reason)

# File 'docs/5_Battle_04_Logic.rb', line 982

def status_change(status, target, launcher = nil, skill = nil, message_overwrite: nil)
end

#status_change_with_process(status, target, launcher = nil, skill = nil, message_overwrite: nil)

Function that test if the change is possible and perform the change if so

Parameters:

• status (Symbol) —

  :poison, :toxic, :confusion, :sleep, :freeze, :paralysis, :burn, :flinch, :cure

• target (PFM::PokemonBattler)
• launcher (PFM::PokemonBattler, nil) (defaults to: nil) —

  Potential launcher of a move

• skill (Battle::Move, nil) (defaults to: nil) —

  Potential move used

# File 'docs/5_Battle_04_Logic.rb', line 989

def status_change_with_process(status, target, launcher = nil, skill = nil, message_overwrite: nil)
end