Module: GamePlay::BagMixin

Included in:

Bag

Defined in:

docs/4_Systems_103_Bag.rb

Overview

Module defining the IO of the bag scene so user know what to expect

This mixin should also be used to check if the bag scene is right:

Examples:

Check the current scene is the bag
  GamePlay.current_scene.is_a?(GamePlay.bag_mixin)

Instance Attribute Summary

• #battle_item_wrapper ⇒ PFM::ItemDescriptor::Wrapper^?

  Wrapper of the choosen item in battle.

• #mode ⇒ Symbol readonly

  Get the mode in which the bag was started.

• #return_data ⇒ Symbol, Integer

  ID of the item selected.

Instance Method Summary

• #selected_item_db_symbol ⇒ Symbol

  Get the selected item db_symbol.

Instance Attribute Details

#battle_item_wrapper ⇒ PFM::ItemDescriptor::Wrapper^?

Wrapper of the choosen item in battle

Returns:

• (PFM::ItemDescriptor::Wrapper, nil)

# File 'docs/4_Systems_103_Bag.rb', line 507

def battle_item_wrapper
  @battle_item_wrapper
end

#mode ⇒ Symbol (readonly)

Get the mode in which the bag was started

Returns:

• (Symbol)

# File 'docs/4_Systems_103_Bag.rb', line 510

def mode
  @mode
end

#return_data ⇒ Symbol, Integer

ID of the item selected

Returns:

• (Symbol, Integer)

# File 'docs/4_Systems_103_Bag.rb', line 504

def return_data
  @return_data
end

Instance Method Details

#selected_item_db_symbol ⇒ Symbol

Get the selected item db_symbol

Returns:

• (Symbol)

# File 'docs/4_Systems_103_Bag.rb', line 513

def selected_item_db_symbol
end