Class: Battle::Actions::Item

Inherits:

Base

• Object
• Base
• Battle::Actions::Item

Defined in:

docs/5_Battle_05_Actions.rb

Overview

Class describing the usage of an Item

Instance Attribute Summary

• #item_wrapper ⇒ PFM::ItemDescriptor::Wrapper readonly

  Get the item wrapper executing the action.

• #user ⇒ PFM::PokemonBattler readonly

  Get the Pokemon responsive of the item usage.

Instance Method Summary

• #<=>(other) ⇒ Integer

  Compare this action with another.

• #execute

  Execute the action.

• #initialize(scene, item_wrapper, bag, user) ⇒ Item constructor

  Create a new item action.

Methods inherited from Base

#valid?

Constructor Details

#initialize(scene, item_wrapper, bag, user) ⇒ Item

Create a new item action

Parameters:

• scene (Battle::Scene)
• item_wrapper (PFM::ItemDescriptor::Wrapper)
• bag (PFM::Bag)
• user (PFM::PokemonBattler) —

  pokemon responsive of the usage of the item (to help sorting alg.)

# File 'docs/5_Battle_05_Actions.rb', line 128

def initialize(scene, item_wrapper, bag, user)
end

Instance Attribute Details

#item_wrapper ⇒ PFM::ItemDescriptor::Wrapper (readonly)

Get the item wrapper executing the action

Returns:

• (PFM::ItemDescriptor::Wrapper)

# File 'docs/5_Battle_05_Actions.rb', line 122

def item_wrapper
  @item_wrapper
end

#user ⇒ PFM::PokemonBattler (readonly)

Get the Pokemon responsive of the item usage

Returns:

• (PFM::PokemonBattler)

# File 'docs/5_Battle_05_Actions.rb', line 119

def user
  @user
end

Instance Method Details

#<=>(other) ⇒ Integer

Compare this action with another

Parameters:

• other (Base) —

  other action

Returns:

• (Integer)

# File 'docs/5_Battle_05_Actions.rb', line 133

def <=>(other)
end

#execute

Execute the action

# File 'docs/5_Battle_05_Actions.rb', line 136

def execute
end