Class: PFM::ItemDescriptor::Wrapper
Overview
Wrapper to make the item description more usefull
Instance Attribute Summary collapse
-
#action_to_push
writeonly
Register the action_to_push block.
-
#chen ⇒ Boolean
Get if the item should not be used there.
-
#item ⇒ Studio::Item
Get the item bound to this wrapper.
-
#no_effect ⇒ Boolean
Get if the item has no effect.
-
#on_creature_choice(creature, scene) ⇒ Boolean
Call the on_creature_choice block.
-
#on_creature_use(creature, scene)
Call the on_creature_use block.
-
#on_skill_choice(skill, scene) ⇒ Boolean
Call the on_creature_choice block.
-
#on_skill_use(creature, skill, scene)
Call the on_skill_use block.
-
#on_use(scene)
Call the on_use block.
-
#open_party ⇒ Boolean
Get if the item should open the party menu.
-
#open_skill ⇒ Boolean
Get if the item should open the skill menu.
-
#open_skill_learn ⇒ Integer?
Get the ID of the move that should be learnt if it should be learnt.
-
#skill ⇒ PFM::Skill
readonly
Get the skill bound to the wrapper.
-
#skill_message_id ⇒ Integer?
Get the ID of the message that should be shown in the Summary UI.
-
#stone_evolve ⇒ Boolean
Get if the item is making a Pokemon evolve.
-
#use_before_telling ⇒ Boolean
Get if the item should be used before the usage message.
Instance Method Summary collapse
-
#bind(scene, creature, skill = nil)
Bind the wrapper to a scene, creature & skill.
-
#execute_battle_action
Call the action_to_push block.
-
#on_creature_choice? ⇒ Boolean
Tell if the wrapper has a Pokemon choice.
-
#void_non_battle_block
Void all regular block for battle usage.
Instance Attribute Details
#action_to_push=(value) (writeonly)
Register the action_to_push block
1618 1619 1620 |
# File 'docs/00800_Studio.rb', line 1618 def action_to_push=(value) @action_to_push = value end |
#chen ⇒ Boolean
Get if the item should not be used there
1582 1583 1584 |
# File 'docs/00800_Studio.rb', line 1582 def chen @chen end |
#item ⇒ Studio::Item
Get the item bound to this wrapper
1600 1601 1602 |
# File 'docs/00800_Studio.rb', line 1600 def item @item end |
#no_effect ⇒ Boolean
Get if the item has no effect
1579 1580 1581 |
# File 'docs/00800_Studio.rb', line 1579 def no_effect @no_effect end |
#on_creature_choice(creature, scene) ⇒ Boolean
Call the on_creature_choice block
1630 1631 |
# File 'docs/00800_Studio.rb', line 1630 def on_creature_choice(creature, scene) end |
#on_creature_use(creature, scene)
Call the on_creature_use block
1635 1636 |
# File 'docs/00800_Studio.rb', line 1635 def on_creature_use(creature, scene) end |
#on_skill_choice(skill, scene) ⇒ Boolean
Call the on_creature_choice block
1641 1642 |
# File 'docs/00800_Studio.rb', line 1641 def on_skill_choice(skill, scene) end |
#on_skill_use(creature, skill, scene)
Call the on_skill_use block
1647 1648 |
# File 'docs/00800_Studio.rb', line 1647 def on_skill_use(creature, skill, scene) end |
#on_use(scene)
Call the on_use block
1651 1652 |
# File 'docs/00800_Studio.rb', line 1651 def on_use(scene) end |
#open_party ⇒ Boolean
Get if the item should open the party menu
1585 1586 1587 |
# File 'docs/00800_Studio.rb', line 1585 def open_party @open_party end |
#open_skill ⇒ Boolean
Get if the item should open the skill menu
1588 1589 1590 |
# File 'docs/00800_Studio.rb', line 1588 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
1591 1592 1593 |
# File 'docs/00800_Studio.rb', line 1591 def open_skill_learn @open_skill_learn end |
#skill ⇒ PFM::Skill (readonly)
Get the skill bound to the wrapper
1603 1604 1605 |
# File 'docs/00800_Studio.rb', line 1603 def skill @skill end |
#skill_message_id ⇒ Integer?
Get the ID of the message that should be shown in the Summary UI
1606 1607 1608 |
# File 'docs/00800_Studio.rb', line 1606 def @skill_message_id end |
#stone_evolve ⇒ Boolean
Get if the item is making a Pokemon evolve
1594 1595 1596 |
# File 'docs/00800_Studio.rb', line 1594 def stone_evolve @stone_evolve end |
#use_before_telling ⇒ Boolean
Get if the item should be used before the usage message
1597 1598 1599 |
# File 'docs/00800_Studio.rb', line 1597 def use_before_telling @use_before_telling end |
Instance Method Details
#bind(scene, creature, skill = nil)
Bind the wrapper to a scene, creature & skill
1660 1661 |
# File 'docs/00800_Studio.rb', line 1660 def bind(scene, creature, skill = nil) end |
#execute_battle_action
Call the action_to_push block
1654 1655 |
# File 'docs/00800_Studio.rb', line 1654 def execute_battle_action end |
#on_creature_choice? ⇒ Boolean
Tell if the wrapper has a Pokemon choice
1624 1625 |
# File 'docs/00800_Studio.rb', line 1624 def on_creature_choice? end |
#void_non_battle_block
Void all regular block for battle usage
1620 1621 |
# File 'docs/00800_Studio.rb', line 1620 def void_non_battle_block end |