Module: Hooks

Included in:

Battle::AI::Base, Battle::Logic::AbilityChangeHandler, Battle::Logic::BattleEndHandler, Battle::Logic::CatchHandler, Battle::Logic::DamageHandler, Battle::Logic::EndTurnHandler, Battle::Logic::ExpHandler, Battle::Logic::FTerrainChangeHandler, Battle::Logic::FleeHandler, Battle::Logic::ItemChangeHandler, Battle::Logic::StatChangeHandler, Battle::Logic::StatusChangeHandler, Battle::Logic::SwitchHandler, Battle::Logic::TransformHandler, Battle::Logic::WeatherChangeHandler, Battle::Move, Battle::Scene, Graphics, Graphics, PFM::Pokemon, PFM::PokemonBattler, Scene_Map, Spriteset_Map

Defined in:

docs/00000_a_root.rb

Overview

end

Defined Under Namespace

Modules: Reason Classes: ForceReturn

Class Method Summary

• .included(klass)

  Function called when Hooks is included.

• .register(klass, name, reason = nil, &block) {|hook_binding| ... }

  Function that register a hook.

• .remove(klass, name, reason = 'None')

  Function that removes a hook with a reason.

• .remove_without_name(klass, reason = 'None')

  Function that removes a hook with a reason.

Instance Method Summary

• #exec_hooks(klass, name, method_binding)

  Function that execute the hooks.

• #force_return(object)

  Function that force the return from the hook.

Class Method Details

.included(klass)

Function called when Hooks is included

Parameters:

• klass (Class) —

  klass receiving the hooks

# File 'docs/00000_a_root.rb', line 169

def included(klass)
end

.register(klass, name, reason = nil, &block) {|hook_binding| ... }

Function that register a hook

Parameters:

• klass (Class) —

  class containing the hook information

• name (Symbol) —

  name of the hook list

• reason (String) (defaults to: nil) —

  reason for the hook (so we can remove it)

• block (Proc) —

  actuall hook

Yields:

• (hook_binding) —

  hook called when requested

Yield Parameters:

• hook_binding (Binding) —

  binding from the calling method

# File 'docs/00000_a_root.rb', line 154

def register(klass, name, reason = nil, &block)
end

.remove(klass, name, reason = 'None')

Function that removes a hook with a reason

Parameters:

• klass (Class) —

  class containing the hook information

• name (Symbol) —

  name of the hook list

• reason (String) (defaults to: 'None') —

  reason for the hook

# File 'docs/00000_a_root.rb', line 160

def remove(klass, name, reason = 'None')
end

.remove_without_name(klass, reason = 'None')

Function that removes a hook with a reason

Parameters:

• klass (Class) —

  class containing the hook information

• reason (String) (defaults to: 'None') —

  reason for the hook

# File 'docs/00000_a_root.rb', line 165

def remove_without_name(klass, reason = 'None')
end

Instance Method Details

#exec_hooks(klass, name, method_binding)

Function that execute the hooks

Parameters:

• klass (Class) —

  class containing the hook information

• name (Symbol) —

  name of the hook list

• method_binding (Binding) —

  binding of the method so the hook can modify locals

Raises:

• (ForceReturn)

# File 'docs/00000_a_root.rb', line 140

def exec_hooks(klass, name, method_binding)
end

#force_return(object)

Function that force the return from the hook

Parameters:

• object (Object) —

  object to return

# File 'docs/00000_a_root.rb', line 144

def force_return(object)
end