Class: PFM::ItemDescriptor::Wrapper

Inherits:
Object
  • Object
show all
Defined in:
docs/3_Studio.rb

Overview

Wrapper to make the item description more usefull

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#action_to_push=(value) (writeonly)

Register the action_to_push block



1648
1649
1650
 
# File 'docs/3_Studio.rb', line 1648

def action_to_push=(value)
  @action_to_push = value
end

#chen ⇒ Boolean

Get if the item should not be used there

Returns:

  • (Boolean) 


1612
1613
1614
 
# File 'docs/3_Studio.rb', line 1612

def chen
  @chen
end

#item ⇒ Studio::Item

Get the item bound to this wrapper

Returns:



1630
1631
1632
 
# File 'docs/3_Studio.rb', line 1630

def item
  @item
end

#no_effect ⇒ Boolean

Get if the item has no effect

Returns:

  • (Boolean) 


1609
1610
1611
 
# File 'docs/3_Studio.rb', line 1609

def no_effect
  @no_effect
end

#on_creature_choice(creature, scene) ⇒ Boolean

Call the on_creature_choice block

Parameters:

Returns:

  • (Boolean) 


1660
1661
 
# File 'docs/3_Studio.rb', line 1660

def on_creature_choice(creature, scene)
end

#on_creature_use(creature, scene)

Call the on_creature_use block

Parameters:



1665
1666
 
# File 'docs/3_Studio.rb', line 1665

def on_creature_use(creature, scene)
end

#on_skill_choice(skill, scene) ⇒ Boolean

Call the on_creature_choice block

Parameters:

Returns:

  • (Boolean) 


1671
1672
 
# File 'docs/3_Studio.rb', line 1671

def on_skill_choice(skill, scene)
end

#on_skill_use(creature, skill, scene)

Call the on_skill_use block

Parameters:



1677
1678
 
# File 'docs/3_Studio.rb', line 1677

def on_skill_use(creature, skill, scene)
end

#on_use(scene)

Call the on_use block

Parameters:



1681
1682
 
# File 'docs/3_Studio.rb', line 1681

def on_use(scene)
end

#open_party ⇒ Boolean

Get if the item should open the party menu

Returns:

  • (Boolean) 


1615
1616
1617
 
# File 'docs/3_Studio.rb', line 1615

def open_party
  @open_party
end

#open_skill ⇒ Boolean

Get if the item should open the skill menu

Returns:

  • (Boolean) 


1618
1619
1620
 
# File 'docs/3_Studio.rb', line 1618

def open_skill
  @open_skill
end

#open_skill_learn ⇒ Integer?

Get the ID of the move that should be learnt if it should be learnt

Returns:

  • (Integer, nil) 


1621
1622
1623
 
# File 'docs/3_Studio.rb', line 1621

def open_skill_learn
  @open_skill_learn
end

#skill ⇒ PFM::Skill (readonly)

Get the skill bound to the wrapper

Returns:



1633
1634
1635
 
# File 'docs/3_Studio.rb', line 1633

def skill
  @skill
end

#skill_message_id ⇒ Integer?

Get the ID of the message that should be shown in the Summary UI

Returns:

  • (Integer, nil) 


1636
1637
1638
 
# File 'docs/3_Studio.rb', line 1636

def skill_message_id
  @skill_message_id
end

#stone_evolve ⇒ Boolean

Get if the item is making a Pokemon evolve

Returns:

  • (Boolean) 


1624
1625
1626
 
# File 'docs/3_Studio.rb', line 1624

def stone_evolve
  @stone_evolve
end

#use_before_telling ⇒ Boolean

Get if the item should be used before the usage message

Returns:

  • (Boolean) 


1627
1628
1629
 
# File 'docs/3_Studio.rb', line 1627

def use_before_telling
  @use_before_telling
end

Instance Method Details

#bind(scene, creature, skill = nil)

Bind the wrapper to a scene, creature & skill

Parameters:



1690
1691
 
# File 'docs/3_Studio.rb', line 1690

def bind(scene, creature, skill = nil)
end

#execute_battle_action

Call the action_to_push block



1684
1685
 
# File 'docs/3_Studio.rb', line 1684

def execute_battle_action
end

#on_creature_choice? ⇒ Boolean

Tell if the wrapper has a Pokemon choice

Returns:

  • (Boolean) 


1654
1655
 
# File 'docs/3_Studio.rb', line 1654

def on_creature_choice?
end

#void_non_battle_block

Void all regular block for battle usage



1650
1651
 
# File 'docs/3_Studio.rb', line 1650

def void_non_battle_block
end